clients/clients

get

https://{domain}/api/admin/v8/clients/clients

Method that enables extracting customer account details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

clientsIds

array of integers

Customer numbers.

clientsIds

clientCodesExternal

array of strings

External system codes list

clientCodesExternal

clientTextSearch

string

Text search through customer data.

clientIsActive

string

enum

Active

Allowed:

clientHasTradeCredit

string

enum

Trade credit:

positive or negative,
only positive,
only negative,
only zero.

Allowed:

clientLastPurchaseDate

object

Date of last purchase.

clientsLastModificationDate

object

Last modification date.

returnElements

array of strings

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

clientId
clientsLastModificationDate
clientLogin
clientEmail
clientType
showClientAsPartner
blockAutomaticallyAssigningGroupDiscount
clientFirstName
clientLastName
clientBirthDate
clientFirm
clientNip
clientStreet
clientZipCode
clientCity
clientCountryId
langId
currencyId
clientRegionId
clientIsWholesaler
clientVatPreferences
clientGroupDiscountNumber
clientGroupDiscountName
clientCodeExternal
clientPhone1
clientPhone2
clientProvinceId
newsletterEmailApprovalsData
shops
clientBalances
clientTradeCredit
clientLoyaltyPoints
operator
isUnregistered
affiliateLogin
affiliateId
clientRegistrationDate
clientActiveInShops

returnElements

resultsPage

integer

Page with results number. Numeration starts from 0

resultsLimit

integer

Number of results on page. Value from 1 to 100

clientRegistrationDate

object

Client Registration Date

shopId

string

The ID of the shop, that client is assigned to.

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