ShopifyCheckout

interface

import { ShopifyCheckout } from '@daffodil/driver/shopify'

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.

interface ShopifyCheckout {
  __typename: "Checkout"
  appliedGiftCards: ShopifyAppliedGiftCard[]
  availableShippingRates: ShopifyAvailableShippingRates
  buyerIdentity: ShopifyCheckoutBuyerIdentity
  completedAt: Maybe<Scalars['DateTime']['output']>
  createdAt: Scalars['DateTime']['output']
  currencyCode: ShopifyCurrencyCode
  customAttributes: ShopifyAttribute[]
  discountApplications: ShopifyDiscountApplicationConnection
  email: string
  id: string
  lineItems: ShopifyCheckoutLineItemConnection
  lineItemsSubtotalPrice: ShopifyMoneyV2
  note: string
  order: ShopifyOrder
  orderStatusUrl: Maybe<Scalars['URL']['output']>
  paymentDue: ShopifyMoneyV2
  paymentDueV2: ShopifyMoneyV2
  ready: boolean
  requiresShipping: boolean
  shippingAddress: ShopifyMailingAddress
  shippingDiscountAllocations: ShopifyDiscountAllocation[]
  shippingLine: ShopifyShippingRate
  subtotalPrice: ShopifyMoneyV2
  subtotalPriceV2: ShopifyMoneyV2
  taxExempt: boolean
  taxesIncluded: boolean
  totalDuties: ShopifyMoneyV2
  totalPrice: ShopifyMoneyV2
  totalPriceV2: ShopifyMoneyV2
  totalTax: ShopifyMoneyV2
  totalTaxV2: ShopifyMoneyV2
  updatedAt: Scalars['DateTime']['output']
  webUrl: Scalars['URL']['output']
}

Properties

__typename `"Checkout"`

appliedGiftCards `ShopifyAppliedGiftCard[]`
The gift cards used on the checkout.

availableShippingRates `ShopifyAvailableShippingRates`
The available shipping rates for this Checkout. Should only be used when checkout `requiresShipping` is `true` and the shipping address is valid.

buyerIdentity `ShopifyCheckoutBuyerIdentity`
The identity of the customer associated with the checkout.

completedAt `Maybe<Scalars['DateTime']['output']>`
The date and time when the checkout was completed.

createdAt `Scalars['DateTime']['output']`
The date and time when the checkout was created.

currencyCode `ShopifyCurrencyCode`
The currency code for the checkout.

customAttributes `ShopifyAttribute[]`
A list of extra information that's added to the checkout.

discountApplications `ShopifyDiscountApplicationConnection`
Discounts that have been applied on the checkout.

email `string`
The email attached to this checkout.

id `string`
A globally-unique ID.

lineItems `ShopifyCheckoutLineItemConnection`
A list of line item objects, each one containing information about an item in the checkout.

lineItemsSubtotalPrice `ShopifyMoneyV2`
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 `ShopifyOrder`
The resulting order from a paid checkout.

orderStatusUrl `Maybe<Scalars['URL']['output']>`
The Order status page for this Checkout, null when checkout isn't completed.

paymentDue `ShopifyMoneyV2`
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 `ShopifyMoneyV2`
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 `ShopifyMailingAddress`
The shipping address to where the line items will be shipped.

shippingDiscountAllocations `ShopifyDiscountAllocation[]`
The discounts that have been allocated onto the shipping line by discount applications.

shippingLine `ShopifyShippingRate`
Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object.

subtotalPrice `ShopifyMoneyV2`
The price at checkout before shipping and taxes.

subtotalPriceV2 `ShopifyMoneyV2`
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 `ShopifyMoneyV2`
The sum of all the duties applied to the line items in the checkout.

totalPrice `ShopifyMoneyV2`
The sum of all the prices of all the items in the checkout, including taxes and duties.

totalPriceV2 `ShopifyMoneyV2`
The sum of all the prices of all the items in the checkout, including taxes and duties.

totalTax `ShopifyMoneyV2`
The sum of all the taxes applied to the line items and shipping lines in the checkout.

totalTaxV2 `ShopifyMoneyV2`
The sum of all the taxes applied to the line items and shipping lines in the checkout.

updatedAt `Scalars['DateTime']['output']`
The date and time when the checkout was last updated.

webUrl `Scalars['URL']['output']`
The url pointing to the checkout accessible from the web.