Coupons
A coupon is a code, consisting of letters or numbers that a shopper can apply to an order. When a coupon is applied to an order, it can trigger a promotion which in turn discounts or adds additional incentives to the order.
Coupons for an order can be managed through the coupon info resource. This is where coupons that are applied to an order are listed, as well as a form to apply new coupons. Each coupon is linked to the promotions it triggered. If no promotions were triggered then no promotion link will be present.
Coupons for a purchase are coupons that were applied to the shopper’s purchase.
Read Coupons Applied To Order
Read coupons applied to the order.
Workflow
- Start with order
GETthe link with rel: couponinfoGETthe link with rel: coupon- Render the response
Response Fields
Type: coupons.coupon
| Name | Description | Type |
|---|---|---|
code | The coupon code. | string |
Apply Coupon To Order
Apply a coupon to the order.
Workflow
- Start with order
GETthe link with rel: couponinfoGETthe link with rel: couponform- Fill out the form
POSTthe form using the link with rel: applycouponaction
Request Fields
Type: coupons.coupon
| Name | Description | Type |
|---|---|---|
code | The coupon code. | string |
Remove A Coupon From Order
Remove an applied coupon from the order.
Workflow
- Start with order-coupon
DELETEorder-coupon
Read Coupons Applied To Purchase
Read a coupon applied to the purchase.
Workflow
- Start with purchase
GETthe link with rel: couponsGETthe link with rel: element- Render the response
Response Fields
Type: coupons.coupon
| Name | Description | Type |
|---|---|---|
code | The coupon code. | string |