OBJECT

Checkout

A container for all the information required to checkout items and pay.

link GraphQL Schema definition

  • type Checkout implements Node {
  • appliedGiftCards: [AppliedGiftCard!]!
  • # The available shipping rates for this Checkout.
  • # Should only be used when checkout `requiresShipping` is `true` and
  • # the shipping address is valid.
  • availableShippingRates: AvailableShippingRates
  • # The date and time when the checkout was completed.
  • completedAt: DateTime
  • # The date and time when the checkout was created.
  • createdAt: DateTime!
  • # The currency code for the Checkout.
  • currencyCode: CurrencyCode!
  • # A list of extra information that is added to the checkout.
  • customAttributes: [Attribute!]!
  • # The customer associated with the checkout.
  • customer: Customer
  • # The email attached to this checkout.
  • email: String
  • id: ID!
  • # A list of line item objects, each one containing information about an item in
  • # the checkout.
  • #
  • # Arguments
  • # first: [Not documented]
  • # after: [Not documented]
  • # reverse: [Not documented]
  • lineItems(first: Int!, after: String, reverse: Boolean): CheckoutLineItemConnection!
  • note: String
  • # The resulting order from a paid checkout.
  • order: Order
  • # The Order Status Page for this Checkout, null when checkout is not completed.
  • orderStatusUrl: URL
  • # The amount left to be paid. This is equal to the cost of the line items, taxes
  • # and shipping minus discounts and gift cards.
  • paymentDue: Money!
  • # Whether or not the Checkout is ready and can be completed. Checkouts may have
  • # asynchronous operations that can take time to finish. If you want to complete a
  • # checkout or ensure all the fields are populated and up to date, polling is
  • # required until the value is true.
  • ready: Boolean!
  • # States whether or not the fulfillment requires shipping.
  • requiresShipping: Boolean!
  • # The shipping address to where the line items will be shipped.
  • shippingAddress: MailingAddress
  • # Once a shipping rate is selected by the customer it is transitioned to a
  • # `shipping_line` object.
  • shippingLine: ShippingRate
  • # Price of the checkout before shipping, taxes, and discounts.
  • subtotalPrice: Money!
  • # Specifies if the Checkout is tax exempt.
  • taxExempt: Boolean!
  • # Specifies if taxes are included in the line item and shipping line prices.
  • taxesIncluded: Boolean!
  • # The sum of all the prices of all the items in the checkout, taxes and discounts
  • # included.
  • totalPrice: Money!
  • # The sum of all the taxes applied to the line items and shipping lines in the
  • # checkout.
  • totalTax: Money!
  • # The date and time when the checkout was last updated.
  • updatedAt: DateTime!
  • # The url pointing to the checkout accessible from the web.
  • webUrl: URL!
  • }