Checkout

Required access

unauthenticated_read_checkouts access scope

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

Show definition
# A container for all the information required to checkout items and pay.
type Checkout implements Node {
  # Globally unique identifier.
  id: ID!
  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

  # A list of line item objects, each one containing information about an item in the checkout.
  lineItems(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false
  ): 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!
}

Implements

Connections

lineItems   (CheckoutLineItemConnection!)

A list of line item objects, each one containing information about an item in the checkout.

Argument Type Default Description
after

String

Returns the elements that come after the specified cursor.

before

String

Returns the elements that come before the specified cursor.

first

Int

Returns up to the first n elements from the list.

last

Int

Returns up to the last n elements from the list.

reverse

Boolean

false

Reverse the order of the underlying list.

Fields

appliedGiftCards   ([AppliedGiftCard!]!)

availableShippingRates   (AvailableShippingRates)

The available shipping rates for this Checkout. Should only be used when checkout requiresShipping is true and the shipping address is valid.

completedAt   (DateTime)

The date and time when the checkout was completed.

createdAt   (DateTime!)

The date and time when the checkout was created.

currencyCode   (CurrencyCode!)

The currency code for the Checkout.

customAttributes   ([Attribute!]!)

A list of extra information that is added to the checkout.

email   (String)

The email attached to this checkout.

id   (ID!)

Globally unique identifier.

note   (String)

order   (Order)

The resulting order from a paid checkout.

orderStatusUrl   (URL)

The Order Status Page for this Checkout, null when checkout is not completed.

paymentDue   (Money!)

The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

ready   (Boolean!)

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.

requiresShipping   (Boolean!)

States whether or not the fulfillment requires shipping.

shippingAddress   (MailingAddress)

The shipping address to where the line items will be shipped.

shippingLine   (ShippingRate)

Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

subtotalPrice   (Money!)

Price of the checkout before shipping, taxes, and discounts.

taxExempt   (Boolean!)

Specifies if the Checkout is tax exempt.

taxesIncluded   (Boolean!)

Specifies if taxes are included in the line item and shipping line prices.

totalPrice   (Money!)

The sum of all the prices of all the items in the checkout, taxes and discounts included.

totalTax   (Money!)

The sum of all the taxes applied to the line items and shipping lines in the checkout.

updatedAt   (DateTime!)

The date and time when the checkout was last updated.

webUrl   (URL!)

The url pointing to the checkout accessible from the web.

Deprecated fields

Show/Hide

customer   (Customer)

deprecated

The customer associated with the checkout.

Deprecation warning

This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

Sign up for a Partner account to get started.

Sign up