Sign in
CouponSets

Get Coupon

Retrieves a single coupon by its coupon code.

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

Path parameters

couponSetCodestring required
couponCodestring required

Query parameters

includeCountsboolean
responseGroupsstring
responseFieldsstring

limits which fields are returned in the response body

Response

OK

canBeDeletedboolean
couponCodestring required

The code the customer uses to claim this coupon

couponSetCodestring nullable

Link to associated coupon

couponSetIdinteger

ReadOnly system id for releated couponset.

redemptionCountinteger nullable

Total number of times this code has been redeemed. ReadOnly, calculated. Only returned with response group includeCounts

Changes

No recorded changes to this endpoint across all 1 revision of this API.