Cart

Represents a cart in the store, exposing totals, items, discounts, shipping, and payment information for GraphQL APIs.

Type Definition


type Cart {
  id: String
  createdAt: String
  customer: Customer
  discounts: [CartDiscount]
  tags: [String]
  subtotalPrice: Float
  totalPrice: Float
  currency: String
  totalNetPrice: Float
  totalTax: Float
  taxLines: [CartTaxLine]
  customerNote: String
  paymentMethods: [CartPaymentMethod]
  paymentFee: Float
  shippingMethods: [CartShippingMethod]
  shippingPrice: Float
  lines: [CartLineItem]
  physicalLines: [CartLineItem]
  lineCount: Int
  shippingAddress: Address
  billingAddress: Address
  checkoutUrl: String
}

Fields

Field	Type	Description
id	String	Returns the id for this cart.
createdAt	String	Date when this order was created in RFC 2822 format.
customer	Customer	Customer linked to this order if any.
discounts	[CartDiscount]	Return the discounts applied to this cart.
tags	[String]	Returns the tags associated with this cart.
subtotalPrice	Float	Returns the subtotal in customer’s currency.
totalPrice	Float	Returns the total in customer’s currency.
currency	String	Returns the currency for this cart.
totalNetPrice	Float	Returns the net total in customer’s currency.
totalTax	Float	Returns the total tax in customer’s currency.
taxLines	[CartTaxLine]	Returns the tax lines for this cart.
customerNote	String	Returns the customer note.
paymentMethods	[CartPaymentMethod]	Returns the payment methods for this cart.
paymentFee	Float	Returns the total payment fee in customer’s currency.
shippingMethods	[CartShippingMethod]	Returns the shipping methods for this cart.
shippingPrice	Float	Returns the total shipping costs in customer’s currency.
lines	[CartLineItem]	Returns the items in this cart.
physicalLines	[CartLineItem]	Returns the physical items in this cart.
lineCount	Int	Returns the number of items in this cart.
shippingAddress	Address	Returns the shipping address for this cart.
billingAddress	Address	Returns the billing address for this cart.
checkoutUrl	String	Returns the checkout URL for this cart.

Relationships

The Cart type relates to several other types in the schema:

Customer: Optionally linked to a customer entity associated with the cart
CartDiscount: Contains zero or more discounts applied to the cart
CartTaxLine: Includes tax line items calculated for the cart
CartPaymentMethod: Lists available or selected payment methods
CartShippingMethod: Lists available shipping options
CartLineItem: Contains the actual items in the cart, with separate physical and all items collections
Address: References both shipping and billing addresses for the cart

Example


{
  cart(id: "eyJhbGciOiJIUzI1NiJ9...") {
    id
    createdAt
    totalPrice
    subtotalPrice
    totalTax
    currency
    lineCount
    customer {
      id
      email
    }
    lines {
      id
      quantity
    }
    discounts {
      code
    }
    shippingAddress {
      city
      country
    }
    checkoutUrl
  }
}

Implements

This type does not implement any interfaces.