Apply coupon
Apply a coupon code to the corresponding cart.
The Cart ID from the Create cart endpoint is used in the path parameter.
The coupon code generated when creating a custom coupon in Copilot is used in the path parameter.
Authorizations
Include the Bearer<token> header where the <token> is the authentication token generated from the Getting Started with fabric APIs process.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID for tracking.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Path Parameters
The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.
The coupon code generated when creating a custom coupon in Copilot.
Response
The unique identifier of the cart that was passed in the parameter.
Custom attributes used to describe the cart, such as a wishlist cart.
Cart configurations determine the behavior within the cart.
Customer context object containing customer information.
The cart status indicates whether the cart is active or deleted.
ACTIVE, SOFT_DELETE The resource state is stored in an array that holds information about the current status of the cart.
The sum of the total amount of the cart.
A collection of promotions applied to the cart.
A collection of fees associated with the cart.
A collection of adjustments made to the cart.
A map of addresses added to the cart.
A collection of items in the cart.
A summary of items in the cart.
A map of fulfillments added to the cart.
An array containing all coupons added to the cart.
An array containing all coupons applied to the cart.
An array containing any coupons that were ineligible and not applied to the cart.
An object containing a collection of payments added to the cart.
Channel ID
The currency that the cart will use when an order is created.
The date and time in UTC when the cart was last updated.
The date and time when a cart was created.
Was this page helpful?