API reference
- Getting Started with Your API
- SDKs and Toolkits
- Catalog Administration Overview
- GETGet Unique Coupon Set Code
- POSTValidate Unique Coupon Set Code
- GETGet Coupon Set
- PUTUpdate Coupon Set
- DELDelete Coupon Set
- GETGet Coupon Sets
- POSTAdd Coupon Set
- GETGet Coupons
- POSTAdd Coupons
- GETGet Coupon
- DELDelete Coupon
- POSTDelete Coupons
- GETGet Assigned Discounts
- POSTAssign Discount to Coupon Set
- DELUnassign Discount from Coupon Set
- GET
A valid request URL is required to generate request examples{
"name": "<string>",
"id": 123,
"couponSetCode": "<string>",
"couponCodeType": "<string>",
"status": "<string>",
"canBeDeleted": true,
"maxRedemptionsPerUser": 123,
"maxRedemptionsPerCouponCode": 123,
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"setSize": 123,
"couponCodeCount": 123,
"redemptionCount": 123,
"assignedDiscountCount": 123
}Add Coupon Set
Adds a single CouponSet
A valid request URL is required to generate request examples{
"name": "<string>",
"id": 123,
"couponSetCode": "<string>",
"couponCodeType": "<string>",
"status": "<string>",
"canBeDeleted": true,
"maxRedemptionsPerUser": 123,
"maxRedemptionsPerCouponCode": 123,
"endDate": "2023-11-07T05:31:56Z",
"startDate": "2023-11-07T05:31:56Z",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"setSize": 123,
"couponCodeCount": 123,
"redemptionCount": 123,
"assignedDiscountCount": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
Represents a claimable item that allows a user to use one or more discounts.
CouponSet Name
200Internal unique identifier of the couponset. System-supplied and read-only.
Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null.
32Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic).
CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only.
Signifies that the coupon has not been exported and can be updated ReadOnly
Maximum number of times any single user can redeem any code. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.
Maximum number of times any code can de used. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.
Date and time that the coupon codes becomes expired
Date and time that the coupon codes becomes active
Show child attributes
Show child attributes
Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic"
Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly
ReadOnly count of all redemptions for this coupon set.
ReadOnly sum of all redemptions for this coupon. Use "counts" response group.
Response
Success
Represents a claimable item that allows a user to use one or more discounts.
CouponSet Name
200Internal unique identifier of the couponset. System-supplied and read-only.
Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null.
32Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic).
CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only.
Signifies that the coupon has not been exported and can be updated ReadOnly
Maximum number of times any single user can redeem any code. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.
Maximum number of times any code can de used. Must be null, >=1 or -1. Defaults to 1 on creation if null. -1 indicates unlimited.
Date and time that the coupon codes becomes expired
Date and time that the coupon codes becomes active
Show child attributes
Show child attributes
Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic"
Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly
ReadOnly count of all redemptions for this coupon set.
ReadOnly sum of all redemptions for this coupon. Use "counts" response group.