API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Checkout object

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalDuties (MoneyV2)

    The sum of all the duties applied to the line items in the checkout.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalDuties (MoneyV2)

    The sum of all the duties applied to the line items in the checkout.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead

A container for all the information required to checkout items and pay.

Required access

unauthenticated_read_checkouts access scope.

Connections

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the checkout.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false
  • lineItems (CheckoutLineItemConnection!)

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.
    before ( String )

    Returns the elements that come before the specified cursor.
    first ( Int )

    Returns up to the first n elements from the list.
    last ( Int )

    Returns up to the last n elements from the list.
    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • appliedGiftCards ([AppliedGiftCard!]!)

    The gift cards used on the checkout.

  • availableShippingRates (AvailableShippingRates)

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

  • completedAt (DateTime)

    The date and time when the checkout was completed.

  • createdAt (DateTime!)

    The date and time when the checkout was created.

  • currencyCode (CurrencyCode!)

    The currency code for the Checkout.

  • customAttributes ([Attribute!]!)

    A list of extra information that is added to the checkout.

  • email (String)

    The email attached to this checkout.

  • id (ID!)

    Globally unique identifier.

  • lineItemsSubtotalPrice (MoneyV2!)

    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 (Order)

    The resulting order from a paid checkout.

  • orderStatusUrl (URL)

    The Order Status Page for this Checkout, null when checkout is not completed.

  • paymentDueV2 (MoneyV2!)

    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 (MailingAddress)

    The shipping address to where the line items will be shipped.

  • shippingDiscountAllocations ([DiscountAllocation!]!)

    The discounts that have been allocated onto the shipping line by discount applications.

  • shippingLine (ShippingRate)

    Once a shipping rate is selected by the customer it is transitioned to a shipping_line object.

  • subtotalPriceV2 (MoneyV2!)

    Price of the checkout before duties, shipping and taxes.

  • taxExempt (Boolean!)

    Specifies if the Checkout is tax exempt.

  • taxesIncluded (Boolean!)

    Specifies if taxes are included in the line item and shipping line prices.

  • totalPriceV2 (MoneyV2!)

    The sum of all the prices of all the items in the checkout, duties, taxes and discounts included.

  • totalTaxV2 (MoneyV2!)

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

  • updatedAt (DateTime!)

    The date and time when the checkout was last updated.

  • webUrl (URL!)

    The url pointing to the checkout accessible from the web.

Types that return Checkout

Mutations for Checkout

Implements

Deprecated fields

  • customer (Customer) deprecated

    The customer associated with the checkout.

    Deprecation warning

    This field will always return null. If you have an authentication token for the customer, you can use the customer field on the query root to retrieve it.

  • paymentDue (Money!) deprecated

    The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards.

    Deprecation warning

    Use paymentDueV2 instead

  • subtotalPrice (Money!) deprecated

    Price of the checkout before shipping and taxes.

    Deprecation warning

    Use subtotalPriceV2 instead

  • totalPrice (Money!) deprecated

    The sum of all the prices of all the items in the checkout, taxes and discounts included.

    Deprecation warning

    Use totalPriceV2 instead

  • totalTax (Money!) deprecated

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

    Deprecation warning

    Use totalTaxV2 instead