get

/carts

Returns a Cart.

By default, the cart response will return abbreviated details for cart line items. To get full details of selected product options, use the following query parameters:

  • Physical products only: ?include=lineItems.physicalItems.options
  • Digital products only: ?include=lineItems.digitalItems.options
  • Both physical and digital items: ?include=lineItems.digitalItems.options,lineItems.physicalItems.options

Request Parameters

1 Query Parameter

Responses

Schema
object

A cart contains a collection of items, prices, discounts, etc. It does not contain customer-related data. Custom Items is a read only field. A custom item can only be added to a cart using the Server to Server Cart API.

id
string

Cart ID, provided after creating a cart with a POST.

1 validation
customer_id
integer

ID of the customer to which the cart belongs.

email
string

The cart’s email. This is the same email that is used in the billing address

currency
object

This will always be the same between cart and checkout.

isTaxIncluded
boolean

Whether this item is taxable.

baseAmount
number

Cost of cart’s contents, before applying discounts.

discountAmount
number

Discounted amount.

1 validation
cartAmount
number

Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).

coupons
array[object]

Array of AppliedCoupon objects applied to this cart.

discounts
array[object]

Array of AppliedDiscount objects applied to this cart.

lineItems
array[object]

Array of LineItem objects.

createdTime
string

Time when the cart was created.

1 validation
updatedTime
string

Time when the cart was last updated.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
store_domain