# List of quantity discounts

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

Endpoint: GET /api/quantity-discounts
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `customerGroupCode` (string)
    customer group code, possible values can be get by customer group list endpoint
    Example: "retail"

  - `validFrom` (string)
    date of discount validity - lower limit
    Example: "2028-05-28"

  - `validTo` (string)
    date of discount validity - upper limit
    Example: "2028-05-28"

  - `status` (string)
    status of discount, possible values are available, unavailable, expired, planned
    Example: "available"

  - `isActive` (boolean)
    whether or not discount is active
    Example: true

  - `includeUnregisteredCustomers` (boolean)
    whether or not discount is valid for unregistered customers
    Example: true

  - `itemsPerPage` (integer)
    Returned items per page. Default and max value is 20.
    Example: 15

  - `page` (integer)
    Page number to return. Default value is 1.
    Example: 3

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.discounts` (array, required)

  - `data.discounts.id` (integer, required)
    discount ID

  - `data.discounts.title` (string, required)
    discount title

  - `data.discounts.validFrom` (string,null, required)
    date of discount validity from

  - `data.discounts.validTo` (string,null, required)
    date of discount validity to

  - `data.discounts.customerGroups` (array,null, required)
    customer groups connected to discount

  - `data.discounts.customerGroups.code` (string, required)
    customer group code

  - `data.discounts.customerGroups.name` (string, required)
    customer group name

  - `data.discounts.includeUnregisteredCustomers` (boolean, required)
    defines if discount is valid for unregistered customers, default value is false

  - `data.discounts.priority` (integer,null, required)
    priority of the discount

  - `data.discounts.targetingLevel` (string)
    targeting level of the discount
    Enum: "eshop", "product", "category", "brand"

  - `data.discounts.status` (string, required)
    status of the discount
    Enum: "available", "unavailable", "expired", "planned"

  - `data.discounts.isActive` (boolean, required)
    defines if discount is in active or inactive stage

  - `data.paginator` (object, required)

  - `data.paginator.totalCount` (integer, required)
    total number of available records

  - `data.paginator.page` (integer, required)
    current page

  - `data.paginator.pageCount` (integer, required)
    total available of pages

  - `data.paginator.itemsOnPage` (integer, required)
    number of currently returned records

  - `data.paginator.itemsPerPage` (integer, required)
    required number of records per page

  - `errors` (array,null, required)

  - `errors.errorCode` (string, required)
    Short text error identification

  - `errors.message` (string, required)
    Descriptive error message

  - `errors.instance` (string, required)
    Identification of the entity referenced

  - `metadata` (object, required)

  - `metadata.requestId` (string, required)
    Request identifier. Useful for logging/reporting purposes.