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.
Access Scopes
`unauthenticated_read_checkouts` access scope.
Fields
appliedGiftCards:
AppliedGiftCard! -
The gift cards used on the checkout.
availableShippingRates:
AvailableShippingRates -
The available shipping rates for this Checkout.
Should only be used when checkout `requiresShipping` is `true` and
the shipping address is valid.
buyerIdentity:
CheckoutBuyerIdentity! -
The identity of the customer associated with the checkout.
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's added to the checkout.
email:
String -
The email attached to this checkout.
lineItemsSubtotalPrice:
MoneyV2! -
The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.
note:
String -
The note associated with the checkout.
order:
Order -
The resulting order from a paid checkout.
orderStatusUrl:
URL -
The Order status page for this Checkout, null when checkout isn't completed.
paymentDue:
MoneyV2! -
The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards.
paymentDueV2:
MoneyV2! -
The amount left to be paid. This is equal to the cost of the line items, duties, 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.
shippingDiscountAllocations:
DiscountAllocation! -
The discounts that have been allocated onto the shipping line by discount applications.
shippingLine:
ShippingRate -
Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object.
subtotalPrice:
MoneyV2! -
The price at checkout before shipping and taxes.
subtotalPriceV2:
MoneyV2! -
The price at checkout before duties, shipping, and taxes.
taxExempt:
Boolean! -
Whether the checkout is tax exempt.
taxesIncluded:
Boolean! -
Whether taxes are included in the line item and shipping line prices.
totalDuties:
MoneyV2 -
The sum of all the duties applied to the line items in the checkout.
totalPrice:
MoneyV2! -
The sum of all the prices of all the items in the checkout, including taxes and duties.
totalPriceV2:
MoneyV2! -
The sum of all the prices of all the items in the checkout, including taxes and duties.
totalTax:
MoneyV2! -
The sum of all the taxes applied to the line items and shipping lines in the checkout.
totalTaxV2:
MoneyV2! -
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.
checkoutCompleteFree
Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card.
checkoutCompleteWithCreditCardV2
Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing).