Skip to content

List of all quantity discounts

Request

Using this endpoint, you can get list of all quantity discounts with detailed info of each article (like in Detail of quantity discount endpoint) asynchronously.

See how Asynchronous requests work on our developer's portal.

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

One quantity discount in response has the same format as in detail of quantity discount endpoint response. See Quantity discount snapshot schema for more details.

Result file is compressed using GZIP.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
customerGroupCodestring

customer group code, possible values can be get by customer group list endpoint

Example:customerGroupCode=retail
validFromstring

date of discount validity - lower limit

Example:validFrom=2028-05-28
validTostring

date of discount validity - upper limit

Example:validTo=2028-05-28
statusstring

status of discount, possible values are available, unavailable, expired, planned

Example:status=available
isActiveboolean

whether or not discount is active

Example:isActive=true
includeUnregisteredCustomersboolean

whether or not discount is valid for unregistered customers

Example:includeUnregisteredCustomers=true
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/quantity-discounts/snapshot?customerGroupCode=retail&validFrom=2028-05-28&validTo=2028-05-28&status=available&isActive=true&includeUnregisteredCustomers=true' \
  -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" } }