# List of X + Y discounts

Endpoint: GET /api/xy-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"

## 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

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

  - `data.discounts.usageCount` (integer,null)
    number of how many times can be discount used

  - `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