Skip to content

Coupons

Create and manage coupons shoppers can redeem.

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/couponsCreate coupon
GET/v1/couponsList coupons
GET/v1/coupons/{couponId}Get coupon
PUT/v1/coupons/{couponId}Update coupon
POST/v1/coupons/{couponId}/codesCreate coupon code
POST/v1/coupons/{couponId}/codes/batchCreate coupon codes in a batch
POST/v1/coupons/{couponId}/codes/importsImport coupon codes

Last updated: