Sign in

v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CouponSets

Get Coupon Set

Returns a single CouponSet

get/commerce/catalog/admin/couponsets/{couponSetCode}

Path parameters

couponSetCodestring required

CouponSetCode for the requested CouponSet

Query parameters

includeCountsboolean

Include the redemption counts and coupon counts

responseGroupsstring

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

responseFieldsstring

limits which fields are returned in the response body

Response

OK

assignedDiscountCountinteger nullable

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

canBeDeletedboolean

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

couponCodeCountinteger nullable

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

couponCodeTypestring nullable

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

couponSetCodestring nullable

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

endDatestring date-time nullable

Date and time that the coupon codes becomes expired

idinteger nullable

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

maxRedemptionsPerCouponCodeinteger nullable

Maximum number of times any code can de used. Must be null or >= 1 (0 is invalid). Defaults to 1 on creation if null.

maxRedemptionsPerUserinteger nullable

Maximum number of times any single user can redeem any code. Must be null or >= 1 (0 is invalid). Defaults to 1 on creation only when legacy tenant behavior is enabled; otherwise null is preserved.

namestring required

CouponSet Name

redemptionCountinteger nullable

ReadOnly count of all redemptions for this coupon set.

setSizeinteger nullable

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

startDatestring date-time nullable

Date and time that the coupon codes becomes active

statusstring nullable

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