List customers

Get customers for given filters

Rate Limit: 300 Max attempts within 1 minute.

Parameter	Details
shopKey required	string Example: ms
countryCode required	string Example: de

Parameter	Details
with	Array of strings Example: ?with=addresses string Enum: addresses legacyCustomData
filters[id]	Array of integers integer
filters[minId]	integer
filters[maxId]	integer
filters[minCreatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[maxCreatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[minUpdatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[maxUpdatedAt]	string Example: 2021-01-23T11%3A30%3A58%2B00%3A00
filters[billingAddressCountryCode]	string Example: DEU
filters[shippingAddressCountryCode]	string Example: DEU
filters[group]	Array of strings string
filters[isActive]	boolean Example: true
filters[referenceKey]	Array of strings string
filters[lastName]	string Example: Rogers
filters[firstName]	string Example: Matteo
filters[email]	string Example: Matteo.rogers@gmx.com
filters[publicKey]	string Example: customer-1234
filters[dateOfBirth]	string Example: 2021-11-01
filters[street]	string Example: Street address
filters[zipCode]	string Example: 20459
filters[city]	string Example: Hamburg
filters[isGuest]	boolean Example: true
filters[externalUserId] nullable MinLength: 1 MaxLength: 255	string Example: 123
filters[providerCode] nullable MinLength: 1 MaxLength: 255	string Example: okta
sort	string Enum: id appId birthDate firstName lastName lastInvoiceDate lastLoginDate lockedUntilDate passwordResetRequestedAt createdAt updatedAt Default: id
sortDir	string Enum: asc desc Default: asc
limit Minimum: 1 Maximum: 1000	integer Default: 100
cursor	string

200

List of customers

application/json

Success

Array of object

object

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

404

Not Found

application/json

Error

GET/shops/{shopKey}/countries/{countryCode}/customers

200

Customer:

Content type: application/json