Checkout Coupons
Add Coupon to Checkout
POST https://api.bigcommerce.com/stores/{store_hash}/v3/checkouts/{checkoutId}/couponsRequest
Adds a coupon code to a checkout.
You can use multiple coupons by using this endpoint to apply one coupon at a time on your storefront. Ensure you enable the Promotion Settings in your control panel to allow for multiple coupons per order.
Required Fields
- coupon_code
Limits
- Coupon codes have a 50-character limit.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
object | application/json
coupon_codestring
Coupon codes have a 50-character limit.
example
Response
Body
object | application/json
dataobject
example
Delete Checkout Coupon
DELETE https://api.bigcommerce.com/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
- couponCode in path - stringrequired
The actual coupon code value, not the coupon ID.
example
Response
Body
object | application/json
dataobject
example
Did you find what you were looking for?