Skip to main content
GET
/
commerce
/
catalog
/
admin
/
couponsets
/
{couponSetCode}
Error
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

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
couponSetCode
string
required

CouponSetCode for the requested CouponSet

Query Parameters

​
includeCounts
boolean
default:false

Include the redemption counts and coupon counts

​
responseGroups
string

"counts" includes the number of redemptions, coupon codes, and assigned discounts.

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Represents a claimable item that allows a user to use one or more discounts.

​
name
string
required

CouponSet Name

Maximum string length: 200
​
id
integer<int32> | null

Internal unique identifier of the couponset. System-supplied and read-only.

​
couponSetCode
string | null

Unique tenant supplied identifier. Used as the prefix for generated sets. Required System generated if left null.

Maximum string length: 32
​
couponCodeType
string | null

Determines if the coupon is a persisted list of codes (static) or a list based on generated specification (dynamic).

​
status
string | null

CouponSet status which can be: Active, Expired, Inactive System-supplied and read-only.

​
canBeDeleted
boolean

Signifies that the coupon has not been exported and can be updated ReadOnly

​
maxRedemptionsPerUser
integer<int32> | null

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.

​
maxRedemptionsPerCouponCode
integer<int32> | null

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.

​
endDate
string<date-time> | null

Date and time that the coupon codes becomes expired

​
startDate
string<date-time> | null

Date and time that the coupon codes becomes active

​
auditInfo
object
​
setSize
integer<int32> | null

Sets the number of codes to generate for dynamic coupons Required when CouponCodeType is "Dynamic"

​
couponCodeCount
integer<int32> | null

Count of associated couponCodes. Must use "counts" response group to get this value ReadOnly

​
redemptionCount
integer<int32> | null

ReadOnly count of all redemptions for this coupon set.

​
assignedDiscountCount
integer<int32> | null

ReadOnly sum of all redemptions for this coupon. Use "counts" response group.