OBJECT
Checkout
A container for all the information required to checkout items and pay.
link GraphQL Schema definition
- type Checkout implements Node {
- AppliedGiftCard!]! : [
- # The available shipping rates for this Checkout.
- # Should only be used when checkout `requiresShipping` is `true` and
- # the shipping address is valid.
- AvailableShippingRates :
- # The date and time when the checkout was completed.
- DateTime :
- # The date and time when the checkout was created.
- DateTime! :
- # The currency code for the Checkout.
- CurrencyCode! :
- # A list of extra information that is added to the checkout.
- Attribute!]! : [
- # The customer associated with the checkout.
- Customer :
- # The email attached to this checkout.
- String :
- ID! :
- # A list of line item objects, each one containing information about an item in
- # the checkout.
- #
- # Arguments
- # first: [Not documented]
- # after: [Not documented]
- # reverse: [Not documented]
- Int!, : String, : Boolean): CheckoutLineItemConnection! ( :
- String :
- # The resulting order from a paid checkout.
- Order :
- # The Order Status Page for this Checkout, null when checkout is not completed.
- 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.
- 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.
- Boolean! :
- # States whether or not the fulfillment requires shipping.
- Boolean! :
- # The shipping address to where the line items will be shipped.
- MailingAddress :
- # Once a shipping rate is selected by the customer it is transitioned to a
- # `shipping_line` object.
- ShippingRate :
- # Price of the checkout before shipping, taxes, and discounts.
- Money! :
- # Specifies if the Checkout is tax exempt.
- Boolean! :
- # Specifies if taxes are included in the line item and shipping line prices.
- Boolean! :
- # The sum of all the prices of all the items in the checkout, taxes and discounts
- # included.
- Money! :
- # The sum of all the taxes applied to the line items and shipping lines in the
- # checkout.
- Money! :
- # The date and time when the checkout was last updated.
- DateTime! :
- # The url pointing to the checkout accessible from the web.
- URL! :
- }
link Require by
- CheckoutAttributesUpdatePayloadnull
- CheckoutCompleteFreePayloadnull
- CheckoutCompleteWithCreditCardPayloadnull
- CheckoutCompleteWithTokenizedPaymentPayloadnull
- CheckoutCreatePayloadnull
- CheckoutCustomerAssociatePayloadnull
- CheckoutCustomerDisassociatePayloadnull
- CheckoutEmailUpdatePayloadnull
- CheckoutGiftCardApplyPayloadnull
- CheckoutGiftCardRemovePayloadnull
- CheckoutLineItemsAddPayloadnull
- CheckoutLineItemsRemovePayloadnull
- CheckoutLineItemsUpdatePayloadnull
- CheckoutShippingAddressUpdatePayloadnull
- CheckoutShippingLineUpdatePayloadnull
- PaymentA payment applied to a checkout.