commerce/catalog/admin/couponsets/coupons
Use the Coupons subresource to manage coupons within manual coupon sets.
JSON Example
Coupon Properties
Property | Description |
---|---|
auditInfo |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
auditInfo |
type: string Identifier of the user that created the object. System created and read only. |
auditInfo |
type: DateTime The date and time in UTC format set when the object was created. |
auditInfo |
type: string Identifier of the user that updated the entity most recently. |
auditInfo |
type: DateTime The date and time in UTC format the object was updated most recently. |
canBeDeleted |
type: bool Specifies whether the coupon can be deleted and removed from a coupon set. |
couponCode |
type: string The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself. |
couponSetCode |
type: string The unique identifier of the coupon set that the coupon belongs to. |
couponSetId |
type: int The unique, system generated id of the coupon set that contains the coupon. This value is read only. |
redemptionCount |
type: int The total number of times the coupon has been redeemed. When you perform a GetCoupon or GetCoupons operation, set the includeCounts operation parameter to true to view this field. This field is read only. |
Operations
Operation Name | Request URI | Description |
---|---|---|
AddCoupons | POST %7bcouponSetCode%7d%2fcouponcodes |
Adds coupons to a specified manual coupon set. Use the couponSetCode parameter to specify the manual coupon set. |
DeleteCoupon | DELETE %7bcouponSetCode%7d%2fcouponcodes%2f%7bcouponCode%7d |
Deletes the specified coupon and remove it from the coupon set. Note: You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. |
DeleteCoupons | POST %7bcouponSetCode%7d%2fcouponcodes%2fremove |
Deletes the specified coupons and removes them from the coupon set. Note: You can only delete a coupon if it has not been redeemed. Use the canBeDeleted property to determine whether a coupon can be deleted. |
GetCoupon | GET %7bcouponSetCode%7d%2fcouponcodes%2f%7bcouponCode%7d%3fincludeCounts%3d%7bincludeCounts%7d%26responseFields%3d%7bresponseFields%7d |
Retrieves the details of the specified coupon. Use the couponSetCode and the couponCode parameter to specify the coupon within a coupon set. Use the includeCounts paramter to specify whether to return the redemptionCount property in the response body object. |
GetCoupons | GET %7bcouponSetCode%7d%2fcouponcodes%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26includeCounts%3d%7bincludeCounts%7d%26responseFields%3d%7bresponseFields%7d |
Retrieves a list of coupons in a specified coupon set according to any specified filter criteria and sort options. |