Checkout
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 FieldsFields
- appliedGiftCards ([AppliedGiftCard!]!)
- availableShippingRates (AvailableShippingRates)
- createdAt (DateTime!)
- currencyCode (CurrencyCode!)
- customAttributes ([Attribute!]!)
- discountApplications (DiscountApplicationConnection!)
- email (String)
- id (ID!)
- lineItems (CheckoutLineItemConnection!)
- lineItemsSubtotalPrice (MoneyV2!)
- note (String)
- paymentDue (MoneyV2!)
- ready (Boolean!)
- requiresShipping (Boolean!)
- shippingDiscountAllocations ([DiscountAllocation!]!)
- shippingLine (ShippingRate)
- subtotalPrice (MoneyV2!)
- taxesIncluded (Boolean!)
- taxExempt (Boolean!)
- totalDuties (MoneyV2)
- totalPrice (MoneyV2!)
- totalTax (MoneyV2!)
- webUrl (URL!)
- Anchor to appliedGiftCardsapplied•[Applied
Gift Cards Gift Card!]! non-null The gift cards used on the checkout.
- Anchor to availableShippingRatesavailable•Available
Shipping Rates Shipping Rates The available shipping rates for this Checkout. Should only be used when checkout
istrueand the shipping address is valid.- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the checkout was created.
- Anchor to currencyCodecurrency•Currency
Code Code! non-null The currency code for the checkout.
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null The extra information added to the checkout.
- Anchor to discountApplicationsdiscount•Discount
Applications Application Connection! non-null The discounts applied on the checkout.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to emailemail•String
The email associated with this checkout.
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•Checkout
Items Line Item Connection! non-null A list of line item objects, each containing information about an item in the checkout.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to lineItemsSubtotalPriceline•Money
Items Subtotal Price V2! 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 paymentDuepayment•Money
Due V2! 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 requiresShippingrequires•Boolean!
Shipping non-null Whether the fulfillment requires shipping.
- Anchor to shippingDiscountAllocationsshipping•[Discount
Discount Allocations Allocation!]! non-null The discounts allocated to the shipping line by discount applications.
- Anchor to shippingLineshipping•Shipping
Line Rate The selected shipping rate, transitioned to a
object.- Anchor to subtotalPricesubtotal•Money
Price V2! non-null The price at checkout before duties, shipping, and taxes.
- Anchor to taxesIncludedtaxes•Boolean!
Included non-null Whether taxes are included in the line item and shipping line prices.
- Anchor to taxExempttax•Boolean!
Exempt non-null Whether the checkout is tax exempt.
- Anchor to totalDutiestotal•Money
Duties V2 The sum of all the duties applied to the line items in the checkout.
- Anchor to totalPricetotal•Money
Price V2! non-null The sum of all the prices of all the items in the checkout, duties, taxes, and discounts included.
- Anchor to totalTaxtotal•Money
Tax V2! non-null The sum of all the taxes applied to the line items and shipping lines in the checkout.
- Anchor to webUrlweb•URL!
Url non-null The URL for the checkout, accessible from the web.