Skip to content

Quantity discount

idintegerrequired

discount ID

titlestringrequired

discount title

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

date of discount validity from

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

date of discount validity to

timeUnlimitedbooleanrequired

flag whether the discount is time unlimited

customerGroupsArray of objects or nullrequired

customer groups connected to discount

displayFlagbooleanrequired

whether the flag is displayed

flagColorstring or null(typeColor)^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$required

color of the flag

priorityinteger or nullrequired

priority of the discount

isActivebooleanrequired

flag whether the discount is active

statusstringrequired

status of the discount

Enum:"available""unavailable""expired""planned"
targetingLevelstringrequired

targeting level of the discount

Enum:"eshop""product""category""brand"
targetingobject or null(quantityDiscountTargetingResponse)required

definition of products needed to get discount

includeUnregisteredCustomersbooleanrequired

defines if discount is valid for unregistered customers, default value is false

settingsArray of objects or null(quantityDiscountSettingsResponse)required

settings of the discount

{
  "id": 1,
  "title": "18 + 4 free",
  "validFrom": "2017-04-04",
  "validTo": "2017-04-04",
  "timeUnlimited": true,
  "customerGroups": [
    { … }
  ],
  "displayFlag": true,
  "flagColor": "FF00FF",
  "priority": 1,
  "isActive": true,
  "status": "available",
  "targetingLevel": "eshop",
  "targeting": {
    "productGuids": [ … ],
    "categoryGuids": [ … ],
    "brandCodes": [ … ]
  },
  "includeUnregisteredCustomers": true,
  "settings": [
    { … }
  ]
}