# List of discount coupons

List of discount coupons within the e-shop. The list is paged at 1000 coupons. 
The discount coupons can be filtered according to the date of creation, validity, 
repeatability of usage or their template.


If absolute price is used, the amount is interpreted with the default
VAT rate of the eshop (in administration:


Settings » Basic Settings » Tax Classes). It can be retrieved using
endpoint Eshop Info, array .


The same is valid for minimum price.

Endpoint: GET /api/discount-coupons
Version: 1.0.0
Security: shoptetAccessToken, shoptetPrivateApiToken

## Query parameters:

  - `template` (string)
    template GUID
    Example: "01b39ad8-8686-11e9-968c-08002774f818"

  - `creationTimeFrom` (string)
    date and time of coupon creation - lower limit
    Example: "2018-05-28T14:17:00+02:00"

  - `creationTimeTo` (string)
    date and time of coupon creation - upper limit
    Example: "2028-05-28T14:17:00+02:00"

  - `reusable` (boolean)
    is the discount coupon reusable?
    Example: true

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

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

## Header parameters:

  - `Content-Type` (string, required)

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.coupons` (array, required)

  - `data.coupons.code` (string, required)
    code of discount coupon

  - `data.coupons.creationTime` (string,null, required)
    date and time, when the discount coupon was created

  - `data.coupons.discountType` (string, required)
    type of discount. Percentual () or absolute discount ()
    Enum: "percentual", "fixed"

  - `data.coupons.amount` (string,null, required)
    amount of absolute discount (default eshop VAT rate is used)

  - `data.coupons.ratio` (any, required)
    amount of percentual discount

  - `data.coupons.minPrice` (string,null, required)
    minimum price of order (default eshop VAT rate is used)

  - `data.coupons.currency` (string,null, required)
    currency of fixed discount.

  - `data.coupons.template` (string, required)
    template used for the discount coupon creation.

  - `data.coupons.shippingPrice` (string,null, required)
    how the transport prices are calculated: according to the cart before discounts (beforeDiscount), according to the displayed value of the cart (cart), or free (free)
    Enum: "cart", "free", "beforeDiscount", null

  - `data.coupons.validFrom` (string,null, required)
    starting date of coupon validity

  - `data.coupons.validTo` (string,null, required)
    ending date of coupon validity

  - `data.coupons.reusable` (boolean, required)
    Is the discount coupon reusable?

  - `data.coupons.usedCount` (integer, required)
    number of times the discount coupon has been used

  - `data.coupons.remark` (string,null, required)
    remark for the discount coupon.

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