Skip to content

Quantity discount

idintegerrequired

discount ID

Example:1
titlestringrequired

discount title

Example:"18 + 4 free"
validFromstring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date of discount validity from

Example:"2014-11-19"
validTostring or null, (date)(typeDateNullable)^[0-9]{4}-[0-9]{2}-[0-9]{2}$required

date of discount validity to

Example:"2014-12-19"
timeUnlimitedbooleanrequired

flag whether the discount is time unlimited

Example:true
customerGroupsArray of objects or nullrequired

customer groups connected to discount

displayFlagbooleanrequired

whether the flag is displayed

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

color of the flag

Example:"FF00FF"
priorityinteger or nullrequired

priority of the discount

Example:1
isActivebooleanrequired

flag whether the discount is active

Example:true
statusstringrequired

status of the discount

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

targeting level of the discount

Enum:"eshop""product""category""brand"
Example:"eshop"
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

Example:true
settingsArray of objects or null(quantityDiscountSettingsResponse)required

settings of the discount

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