Checkout
object

Choose a version:

Requires unauthenticated_read_checkouts access scope.

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

The Storefront GraphQL Checkout API is deprecated and will be removed in a future version. Please see https://shopify.dev/changelog/deprecation-of-checkout-apis for more information.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to Checkout.appliedGiftCards appliedGiftCards [AppliedGiftCard!]! non-null: The gift cards used on the checkout.
Anchor to Checkout.availableShippingRates availableShippingRates AvailableShippingRates: The available shipping rates for this Checkout. Should only be used when checkout requiresShipping is true and the shipping address is valid.
Anchor to Checkout.buyerIdentity buyerIdentity CheckoutBuyerIdentity! non-null: The identity of the customer associated with the checkout.
Anchor to Checkout.completedAt completedAt DateTime: The date and time when the checkout was completed.
Anchor to Checkout.createdAt createdAt DateTime! non-null: The date and time when the checkout was created.
Anchor to Checkout.currencyCode currencyCode CurrencyCode! non-null: The currency code for the checkout.
Anchor to Checkout.customAttributes customAttributes [Attribute!]! non-null: A list of extra information that's added to the checkout.
Anchor to Checkout.discountApplications discountApplications DiscountApplicationConnection! non-null: Discounts that have been applied on the checkout.
Anchor to Checkout.email email String: The email attached to this checkout.
Anchor to Checkout.id id ID! non-null: A globally-unique ID.
Anchor to Checkout.lineItems lineItems CheckoutLineItemConnection! non-null: A list of line item objects, each one containing information about an item in the checkout.
Anchor to Checkout.lineItemsSubtotalPrice lineItemsSubtotalPrice MoneyV2! non-null: The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.
Anchor to Checkout.note note String: The note associated with the checkout.
Anchor to Checkout.order order Order: The resulting order from a paid checkout.
Anchor to Checkout.orderStatusUrl orderStatusUrl URL: The Order status page for this Checkout, null when checkout isn't completed.
Anchor to Checkout.paymentDue paymentDue MoneyV2! non-null: The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards.
Anchor to Checkout.ready ready Boolean! non-null: 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.
Anchor to Checkout.requiresShipping requiresShipping Boolean! non-null: States whether or not the fulfillment requires shipping.
Anchor to Checkout.shippingAddress shippingAddress MailingAddress: The shipping address to where the line items will be shipped.
Anchor to Checkout.shippingDiscountAllocations shippingDiscountAllocations [DiscountAllocation!]! non-null: The discounts that have been allocated onto the shipping line by discount applications.
Anchor to Checkout.shippingLine shippingLine ShippingRate: Once a shipping rate is selected by the customer it's transitioned to a shipping_line object.
Anchor to Checkout.subtotalPrice subtotalPrice MoneyV2! non-null: The price at checkout before shipping and taxes.
Anchor to Checkout.taxesIncluded taxesIncluded Boolean! non-null: Whether taxes are included in the line item and shipping line prices.
Anchor to Checkout.taxExempt taxExempt Boolean! non-null: Whether the checkout is tax exempt.
Anchor to Checkout.totalDuties totalDuties MoneyV2: The sum of all the duties applied to the line items in the checkout.
Anchor to Checkout.totalPrice totalPrice MoneyV2! non-null: The sum of all the prices of all the items in the checkout, including taxes and duties.
Anchor to Checkout.totalTax totalTax MoneyV2! non-null: The sum of all the taxes applied to the line items and shipping lines in the checkout.
Anchor to Checkout.updatedAt updatedAt DateTime! non-null: The date and time when the checkout was last updated.
Anchor to Checkout.webUrl webUrl URL! non-null: The url pointing to the checkout accessible from the web.