PATCH
/
v2
/
carts
/
{cartId}
/
status
/
{cartStatus}

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

x-api-key
string

API Key for Gateway

Authorization
string
required

Authorization token for the user

Path Parameters

cartId
string
required

ID for cart whose status is to be updated

cartStatus
enum<string>
required

New cart status

Available options:
ACTIVE,
PENDING,
PENDING_APPROVAL,
APPROVED,
SUBMITTED,
DELETED,
REJECTED

Response

200 - application/json

Cart details

items
object[]
required

Items in cart

currency
string
default: USDrequired

Currency type

metadata
object
required

Metadata for this cart

allPromosApplied
object[]
required

All promotions or coupons for items in this cart

sharedUserIds
string[] | null
required
error
object
required

Errors in this cart

cartId
string | null

Cart ID

createdAt
string | null

Cart creation time

updatedAt
string | null

Last time cart was updated

totalItems
integer | null

Number of items in the cart

totalUniqueItems
integer | null

Number of unique items in the cart based on line item ID

cartState
enum<string>

Cart status

Available options:
ACTIVE,
PENDING,
PENDING_APPROVAL,
APPROVED,
SUBMITTED,
DELETED,
REJECTED
tenantId
string | null

Merchant ID

accountId
string | null

Customer account ID

userId
string | null

User ID

configuration
object

Cart configurations

customer
object

Customer context

totalAmount
number | null

Total price of cart items after discount including Shipping and Shipping Discount

subTotal
number | null

Total price of cart items including Shipping without any discount

totalDiscount
number | null

Total discount applied to cart

totalFees
number | null

Total fees applied to cart

attributes
object[] | null

Additional item options

fees
object[] | null

Fees associated with a specific cart or an individual line item of a cart

suggestedProducts
object[] | null

List of recommended products that are available for purchase along with the item added to the cart

Was this page helpful?

Delete cart itemsMerge carts