Choose a version:

Checkout

object

A container for information required to checkout items and pay. Apps using the Customer Account API must meet the protected customer data requirements.

Anchor to Fields and connectionsFields and connections

Anchor to appliedGiftCardsappliedGiftCards •[AppliedGiftCard!]! non-null: The gift cards used on the checkout.
Anchor to availableShippingRatesavailableShippingRates •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 createdAtcreatedAt •DateTime! non-null: The date and time when the checkout was created.
Anchor to currencyCodecurrencyCode •CurrencyCode! non-null: The currency code for the checkout.
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: The extra information added to the checkout.
Anchor to discountApplicationsdiscountApplications •DiscountApplicationConnection! non-null: The discounts applied on the checkout.
Anchor to emailemail •String: The email associated with this checkout.
Anchor to idid •ID! non-nullPre-auth accessible: A globally-unique ID.
Anchor to lineItemslineItems •CheckoutLineItemConnection! non-null: A list of line item objects, each containing information about an item in the checkout.
Anchor to lineItemsSubtotalPricelineItemsSubtotalPrice •MoneyV2! non-null: The sum of all the prices of all the items in the checkout, excluding duties, taxes, shipping, and discounts.
Anchor to notenote •String: The note associated with the checkout.
Anchor to paymentDuepaymentDue •MoneyV2! non-null: 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.
Anchor to readyready •Boolean! non-null: Whether 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 requiresShippingrequiresShipping •Boolean! non-null: Whether the fulfillment requires shipping.
Anchor to shippingDiscountAllocationsshippingDiscountAllocations •[DiscountAllocation!]! non-null: The discounts allocated to the shipping line by discount applications.
Anchor to shippingLineshippingLine •ShippingRate: The selected shipping rate, transitioned to a shipping_line object.
Anchor to subtotalPricesubtotalPrice •MoneyV2! non-null: The price at checkout before duties, shipping, and taxes.
Anchor to taxesIncludedtaxesIncluded •Boolean! non-null: Whether taxes are included in the line item and shipping line prices.
Anchor to taxExempttaxExempt •Boolean! non-null: Whether the checkout is tax exempt.
Anchor to totalDutiestotalDuties •MoneyV2: The sum of all the duties applied to the line items in the checkout.
Anchor to totalPricetotalPrice •MoneyV2! non-null: The sum of all the prices of all the items in the checkout, duties, taxes, and discounts included.
Anchor to totalTaxtotalTax •MoneyV2! non-null: The sum of all the taxes applied to the line items and shipping lines in the checkout.
Anchor to webUrlwebUrl •URL! non-null: The URL for the checkout, accessible from the web.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?