clients/crm

get

https://{domain}/api/admin/v3/clients/crm

The method allows to download information about customers from the CRM module assigned to stores to which the user has rights.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

clientLogin

string

Customer's login.

clientIsWholesaler

string

enum

Determines, whether client is a wholesaler.

Allowed:

clientCountryId

string

Country ID in accordance with ISO-3166.

langId

string

Language ID

clientCustomerServiceRepresentativeLogin

string

Customer service representative.

clientDiscountGroupNumber

integer

Customer group number

clientRegistrationDate

object

Date range of customer registrations

clientLastLoginDate

object

Date of last customer login (YYYY-MM-DD)

clientType

string

enum

Customer type, possible values:

person - if client sex is not determined,
person_male - when client is a male,
person_female - when a customer is a woman,
firm - when client is company.

Allowed:

clientAffiliateProgram

array of objects

Information about the loyalty program
possible values:

yes_voucher - when customers are in a loyalty program and have only used vouchers,
yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits,
yes_clients,
yes_orders - when customers are in the loyalty program and have made at least one order,
no - when customers are in the loyalty program,
banned - when customers are blocked.

clientAffiliateProgram

newsletterEmailApproval

string

Permission to E-mail Newsletter.

newsletterSmsApproval

string

Permission to SMS Newsletter.

searchByShops

object

Shops

clientLoyaltyCard

object

Loyalty cards:

clientCodeExternal

string

External system code.

clientCodesExternal

array of strings

External system codes list.

clientCodesExternal

clientFirstName

string

Customer's first name.

clientLastName

string

Customer's last name.

clientNip

string

Customer Tax no.

clientFirm

string

Customer's company name.

clientEmail

string

E-mail address.

newsletterEmailApprovalsData

array of objects

List of shops where a customer agreed or didn't agree to receive email newsletter.

newsletterEmailApprovalsData

newsletterSmsApprovalsData

array of objects

List of shops where a customer agreed or didn't agree to receive sms newsletter.

newsletterSmsApprovalsData

clientLoyaltyCardNumber

string

Customer loyalty card number, omitted when has_loyalty_card = no.

orders

object

Orders.

returnElements

array of strings

Elements to be returned by the endpoint. By default all elements are returned

returnElements

resultsPage

integer

Page with results number. Numeration starts from 0

resultsLimit

integer

Number of results on page. Value from 1 to 100

settingsExactSearch

boolean

Determines, if data - that will be returned - will be exactly as entered values, or values should be fragment of customer data.

Responses

401

Authorization error

403

Access denied

404

Not found

422

Invalid data format

429

Too many requests

500

Internal server error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

207Multi-Status