Skip to content

Discounts

Create and manage discount rules.

Fields

idstringUnique identifier of the resource.
namestring
statusenumdraft · active · scheduled · inactive
typeenumpercentage · fixedAmount · freeShipping · buyXGetY
descriptionstring
targetenumorder · item · shipping
amountnumber
allocationenumonce · each
See all 24 fields
maxQuantityinteger
applyAfterTaxesboolean
isAutomaticboolean
validFromstring
validTostring
usageLimitinteger
usageCountinteger
customerUsageLimitinteger
combineWithOtherDiscountsboolean
buyXGetYobject
rulesarray<object>
codesarray<object>
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstring
sellerIdstring

Operations

MethodEndpointOperation
POST/v1/discountsCreate discount
GET/v1/discountsList discounts
GET/v1/discounts/{discountId}Get discount
PUT/v1/discounts/{discountId}Update discount

Last updated: