Checkouts
Add Coupon to Checkout
POST /stores/{store_hash}/v3/checkouts/{checkoutId}/coupons
Request
Adds a coupon code to a checkout.
Required Fields
- coupon_code
Limits
- Coupon codes have a 50-character limit.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- checkoutId in path - stringrequired
ID of the checkout; the same as the cart ID.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
object | application/json
coupon_codestring
Coupon codes have a 50-character limit.
example
Response
Body
object | application/json
dataobject
metaobject
Response metadata.
example
Delete Checkout Coupon
DELETE /stores/{store_hash}/v3/checkouts/{checkoutId}/coupons/{couponCode}
Request
Deletes a coupon code from a checkout.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- checkoutId in path - stringrequired
ID of the checkout; the same as the cart ID.
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- couponCode in path - stringrequired
The actual coupon code value, not the coupon ID.
example
Response
Body
object | application/json
dataobject
metaobject
Response metadata.
example
Did you find what you were looking for?