Discount coupon

codestringrequired

code of discount coupon

Example:"DC14585431"

creationTimestring or null(typeDateTimeNullable)^[0-9]{4}-[01][0-9]-[0123][0-9]T[012][0-9]:[0...required

date and time, when the discount coupon was created

Example:"2018-05-29T09:02:27+0200"

discountTypestringrequired

type of discount. Percentual (percentual) or absolute discount (fixed)

Enum:"percentual""fixed"

Example:"percentual"

amountstring or null(typePriceNullable)^(-)?[0-9]+\.[0-9]{2}$required

amount of absolute discount (default eshop VAT rate is used)

Example:"21.00"

ratiotypePriceRatio (string) or nullrequired

One of:

Coefficient applied to the price to get the remaining (discounted) price, i.e. price * ratio. From 0.0000 (100% discount, price reduced to zero) to 1.0000 (no discount).

string(typePriceRatio)

minPricestring or null(typePriceNullable)^(-)?[0-9]+\.[0-9]{2}$required

minimum price of order (default eshop VAT rate is used)

Example:"21.00"

currencystring or null(typeCurrencyCodeNullable)^[a-zA-Z]{3}$required

currency of fixed discount.

Example:"CZK"

templatestring, <= 36 characters(typeGuid)^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$required

template used for the discount coupon creation.

Example:"1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed"

shippingPricestring or nullrequired

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

Example:"cart"

validFromstring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

starting date of coupon validity

Example:"2017-04-04"

validTostring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

ending date of coupon validity

Example:"2017-04-04"

reusablebooleanrequired

Is the discount coupon reusable?

Example:true

usedCountintegerrequired

number of times the discount coupon has been used

Example:0

remarkstring or nullrequired

remark for the discount coupon.

Example:"Note: This is a test discount coupon"

{
  "code": "DC14585431",
  "creationTime": "2018-05-29T09:02:27+0200",
  "discountType": "percentual",
  "amount": "21.00",
  "ratio": "0.7800",
  "minPrice": "21.00",
  "currency": "CZK",
  "template": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
  "shippingPrice": "cart",
  "validFrom": "2017-04-04",
  "validTo": "2017-04-04",
  "reusable": true,
  "usedCount": 0,
  "remark": "Note: This is a test discount coupon"
}