DELETE
/
carts
/
{cartId}
/
coupons
/
{couponId}

Authorizations

Authorization
string
headerrequired

This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.

Headers

x-fabric-tenant-id
string
required

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.

x-fabric-request-id
string

Unique request ID for tracking.

x-fabric-channel-id
string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.

Path Parameters

cartId
string
required

The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.

couponId
string
required

The Coupon ID is the coupon code generated when creating a custom coupon in Copilot.

Response

200 - application/json

Cart Response

id
string

The unique identifier of the cart, which is generated when the cart is created using the Create an empty cart endpoint.

attributes
object

Custom attributes used to describe the cart, such as a wishlist cart.

configuration
object

Cart configurations determine the behavior within the cart.

customerContext
object

Customer context object containing customer information.

status
enum<string>

The cart status indicates whether the cart is active or deleted.

Available options:
ACTIVE,
SOFT_DELETE
state
object[]

The resource state is stored in an array that holds information about the current status of the cart.

price
object

The sum of the total amount of the cart.

promotions
object

A collection of promotions applied to the corresponding cart.

fees
object

A collection of fees associated with the corresponding cart.

adjustments
object

A collection of adjustments made to the corresponding cart.

addresses
object

A map of addresses added to the corresponding cart.

lineItems
object

A collection of items in the cart.

summary
object

A summary of items in the cart.

fulfillments
object

A map of fulfillments added to the corresponding cart.

coupons
object[]

An array containing all coupons added to the corresponding cart.

appliedCoupons
object[]

An array containing all coupons applied to the cart.

notAppliedCoupons
object[]

An array containing any coupons that were ineligible and not applied to the cart.

validations
object
payments
object

An object containing a collection of payments added to the corresponding cart.

channelId
string

Channel ID

currency
string

The currency that the cart will use when an order is created.

updatedAt
string

The date and time in UTC when the cart was last updated.

createdAt
string

The date and time when the cart was created.