List of all customers

Request

Using this endpoint, you can get list of all customers with detailed info of each customer (like in Customer Detail endpoint) asynchronously. See how Asynchronous requests work on our developer's portal.

Response will be in jsonlines format with each customer taking one line of output file.

One customer in response has the same format as customer detail response. See Customer snapshot schema for more details.

Result file is compressed using GZIP.

Security

shoptetAccessToken or shoptetPrivateApiToken

Query

creationTimeFromstring

Export customers created after date

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

creationTimeTostring

Export customers created before date

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

changeTimeFromstring

Export customers changed after date

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

changeTimeTostring

Export customers changed before date

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

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/customers/snapshot?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' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

Accepted

Bodyapplication/json

dataobject

errorsArray of objects or null(Errors)

metadataobject(Metadata)

Response

{
  "data": {
    "jobId": "ad24xod"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}