Add items to cart

Add items to cart, or create a new cart if cart does not exist

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

Body

application/json

Items (with details) to add to cart

items

object[]

required

Items to add to cart

Show child attributes

cartId

string | null

Existing cart ID, or NULL for new cart

name

string | null

Name for the cart

description

string | null

Description for the cart

networkCode

string | null

networkCode for the cart. Required when using inventoryV2 with CartV2

Response

200 - application/json

Cart details

items

object[]

required

Items in cart

Show child attributes

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

Show child attributes

sharedUserIds

string[] | null

required

error

object

required

Errors in this cart

Show child attributes

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

Show child attributes

customer

object

Customer context

Show child attributes

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

Show child attributes

fees

object[] | null

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

Show child attributes

suggestedProducts

object[] | null

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

Show child attributes