Checkout
Fields
note ● String
The note associated with the checkout.
totalPrice ● Money
The sum of all the prices of all the items in the checkout, including duties, taxes, and discounts.
More
availableShippingRates ● AvailableShippingRates
The available shipping rates for this Checkout.Should only be used when checkout requiresShipping is true and the shipping address is valid.
More
lineItems ● [CheckoutLineItem]
A list of line item objects, each one containing information about an item in the checkout.
More
totalTax ● Money
The sum of all the taxes applied to the line items and shipping lines in the checkout.
More
createdAt ● Date
The date and time when the checkout was created.
id ● String!non-null
A globally-unique identifier.
subtotalPrice ● Money
The price at checkout before duties, shipping, and taxes.
More
email ● String
The email attached to this checkout.
updatedAt ● Date
The date and time when the checkout was last updated.
taxesIncluded ● Boolean
Whether taxes are included in the line item and shipping line prices.
completedAt ● [Date]
The date and time when the checkout was completed.
shippingDiscountAllocations ● [DiscountAllocation]
The discounts that have been allocated onto the shipping line by discount applications.
More
discountApplications ● [DiscountApplication]
Discounts that have been applied on the checkout.
More
paymentDue ● Money
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.
More
appliedGiftCards ● [AppliedGiftCard]
The gift cards used on the checkout.
More
requiresShipping ● Boolean
States whether or not the fulfillment requires shipping.
webUrl ● URL!non-null
The url pointing to the checkout accessible from the web.
buyerIdentity ● CheckoutBuyerIdentity
The identity of the customer associated with the checkout.
More
lineItemsSubtotalPrice ● Money
The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.
More
shippingAddress ● ShippingAddress
The shipping address to where the line items will be shipped.
More
currencyCode ● CurrencyCode
The currency code for the checkout.
More
shippingLine ● ShippingRate
Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.
More
customAttributes ● [Attribute]
A list of extra information that is added to the checkout.
More
Status and error codes
For detailed information about common codes, see Status and error codes.
Was this article helpful to you?