Skip to main content

Get a Cart

GET 

/v2/carts/:cartID

Use this endpoint to retrieve a specific cart. If a cart ID does not exist, a new cart will be automatically created. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the relationships section.

You can easily get a new or existing cart by providing the unique cart reference in the request. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the relationships section.

note
  • The default cart name is Cart. However, you can update the cart name as required. Ensure that the string length of the name is greater than or equal to one. Follow the safe character guidelines for name and description naming. For more information about cart ID naming requirements, see the Safe Characters section.
  • Outside of the JS-SDK, we don’t handle creating cart references. You need to create your own.
caution

An empty cart is returned for any carts that don’t currently exist. For more information about the cart items object, see Get Cart Items.

Query parameters

NameRequiredTypeDescription
includeOptionalstringComma-delimited string of entities that can be included. The information included are items,tax_items, custom_discounts, or promotions.

Request

Responses

OK