Get a Cart

GET 
/v2/carts/:cartID

Use this endpoint to retrieve a specific cart. 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.

Query parameters

Name	Required	Type	Description
include	Optional	string	Comma-delimited string of entities that can be included. The information included are items,tax_items, custom_discounts, or promotions.

Request

Path Parameters

cartID stringrequired

The unique identifier for this cart that you created.

Responses

200

OK

application/json

Schema

Schema

data object

id string

The unique identifier for the cart. Use SDK or create it yourself.

type string

The type of object being returned.

name string

The name of this item.

description string

A description of the cart item.

links object

self string

A link to that specific resource.

meta object

display_price object

with_tax object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

without_tax object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

tax object

amount number

The raw total of this cart.

currency string

The currency set for this cart.

formatted string

The tax inclusive formatted total based on the currency.

timestamps object

created_at string

The date this was created.

updated_at

The date this was last updated.

relationships object

customers object

data object

type string

The type of related object.

id uuid

The ID of the customer.

items object

data object

type string

The type of related object.

id uuid

The unique identifier for the cart item

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "string",
    "name": "string",
    "description": "string",
    "links": {
      "self": "string"
    },
    "meta": {
      "display_price": {
        "with_tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "without_tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        }
      },
      "timestamps": {
        "created_at": "string"
      }
    },
    "relationships": {
      "customers": {
        "data": {
          "type": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      },
      "items": {
        "data": {
          "type": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      }
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detail string
status string
title string

Example (from schema)

[
  null
]

Example

{
  "errors": {
    "status": 401,
    "title": "Unauthorized"
  }
}

Loading...