Commerce Webstore Checkout Coupons

Apply a coupon code to a checkout.

To use the Commerce Webstore Checkout Coupon resources, your store must have the Cart Calculate API enabled. See Enable and Disable the Cart Calculate API for a Webstore.

Resource

1/commerce/webstores/${webstoreId}/checkouts/${activeOrCheckoutId}/coupons

Available version

61.0 - 62.0

In version 63.0 and later, use Commerce Webstore Cart Coupons instead.

Important

HTTP methods

POST

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`couponCodes`	Checkout Coupon[]	A list of coupons associated with the checkout. Only a single coupon code is supported.	Required	61.0
`effectiveAccountId`	String	ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.	Optional	61.0

Request body for POST

Root XML tag

checkoutCouponInput

JSON example

1{
2    "couponCodes": ["10OFFORDER"]
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`couponCodes`	String[]	A list of coupons associated with the checkout. Only a single coupon code is supported.	Required	61.0

Response body for POST

Checkout Coupon