Get or Create Cart

Carts are public, shared by all, and retrievable by id. Carts contain all of the basic meta you need to build a cart + checkout, including totals with tax, shipping, and cart item line, and sub totals.

Query

cart(id: ID!, currency: CurrencyInput): Cart!

The cart query will always return the Cart object.

ID!

You must provide an id for the cart you want to fetch. If no cart exists, CartQL will create one for you with the id provided.

{
  cart(id: "ck5r8d5b500003f5o2aif0v2b") {
    id
    isEmpty
    totalItems
    items {
      id
    }
  }
}

{
  "data": {
    "cart": {
      "id": "ck5r8d5b500003f5o2aif0v2b",
      "isEmpty": true,
      "totalItems": 0,
      "items": []
    }
  }
}

CurrencyInput

When fetching a cart that does not exist, the values you provide here will set the cart currency.

query {
  cart(id: "ck5r8d5b500003f5o2aif0v2b", currency: { code: GBP }) {
    id
    currency {
      code
      symbol
    }
  }
}

{
  "data": {
    "cart": {
      "id": "ck5r8d5b500003f5o2aif0v2b",
      "currency": {
        "code": "GBP",
        "symbol": "£"
      }
    }
  }
}

Learn more about managing currencies.

The Cart object

Carts are the core concept of CartQL. Bring your own PIM, and use CartQL to manage cart metadata.

[CartItem!]!

Each CartItem is made up of the values you provide when adding to cart. These items are provided by you, and only an id, and price is required for items to be added.

There are also a handful of other fields you can define for capturing more details about your items.