Skip to content

List of customers

Request

Listing of customers. Supports the Paging.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
emailstring

filtering as per customer’s e-mails. An accurate match is searched for, regardless of capitalization.

Example:email=john@example.com
phonestring
Example:phone=+420123456789
creationTimeFromstring

filtering customers created after date

Example:creationTimeFrom=2014-09-05T00:00:00+0100
creationTimeTostring

filtering customers created before date

Example:creationTimeTo=2019-09-05T00:00:00+0100
changeTimeFromstring

filtering customers changed after date

Example:changeTimeFrom=2017-01-01T00:00:00+0100
changeTimeTostring

filtering customers changed before date

Example:changeTimeTo=2018-12-31T00:00:00+0100
itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 1000.

Example:itemsPerPage=888
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/customers?email=john%40example.com&phone=%2B420123456789&creationTimeFrom=2014-09-05T00%3A00%3A00%2B0100&creationTimeTo=2019-09-05T00%3A00%3A00%2B0100&changeTimeFrom=2017-01-01T00%3A00%3A00%2B0100&changeTimeTo=2018-12-31T00%3A00%3A00%2B0100&itemsPerPage=888&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "customers": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}