List of quantity discounts

Request

Returns a list of quantity discounts with basic info. Supports Paging.

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

itemsPerPageinteger

Returned items per page. Default and max value is 20.

Example:itemsPerPage=15

pageinteger

Page number to return. Default value is 1.

Example:page=3

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/quantity-discounts?customerGroupCode=retail&validFrom=2028-05-28&validTo=2028-05-28&status=available&isActive=true&includeUnregisteredCustomers=true&itemsPerPage=15&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": {
    "discounts": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}