Skip to main content
Version: Canary 🚧

Checkout

Checkout object.

type Checkout implements Node, ObjectWithMetadata {
id: ID!
privateMetadata: [MetadataItem!]!
privateMetafield(key: String!): String
privateMetafields(keys: [String!]): Metadata
metadata: [MetadataItem!]!
metafield(key: String!): String
metafields(keys: [String!]): Metadata
created: DateTime!
updatedAt: DateTime!
lastChange: DateTime! @deprecated
channel: Channel!
billingAddress: Address
shippingAddress: Address
note: String!
discount: Money
discountName: String
translatedDiscountName: String
voucherCode: String
availableShippingMethods: [ShippingMethod!]! @deprecated
shippingMethods: [ShippingMethod!]!
availableCollectionPoints: [Warehouse!]!
availablePaymentGateways: [PaymentGateway!]!
email: String
giftCards: [GiftCard!]!
isShippingRequired: Boolean!
quantity: Int!
stockReservationExpires: DateTime
lines: [CheckoutLine!]!
shippingPrice: TaxedMoney!
shippingMethod: ShippingMethod @deprecated
deliveryMethod: DeliveryMethod
subtotalPrice: TaxedMoney!
taxExemption: Boolean!
token: UUID!
totalPrice: TaxedMoney!
totalBalance: Money!
languageCode: LanguageCodeEnum!
displayGrossPrices: Boolean!
authorizeStatus: CheckoutAuthorizeStatusEnum!
chargeStatus: CheckoutChargeStatusEnum!
storedPaymentMethods(amount: PositiveDecimal): [StoredPaymentMethod!]
problems: [CheckoutProblem!]
}
Expand ▼

Fields

Checkout.id ● ID! non-null scalar

The ID of the checkout.

Checkout.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires staff permissions to access.

Checkout.privateMetafield ● String scalar

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
Checkout.privateMetafield.key ● String! non-null scalar

Checkout.privateMetafields ● Metadata scalar

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
Checkout.privateMetafields.keys ● [String!] list scalar

Checkout.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Checkout.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
Checkout.metafield.key ● String! non-null scalar

Checkout.metafields ● Metadata scalar

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
Checkout.metafields.keys ● [String!] list scalar

Checkout.created ● DateTime! non-null scalar

The date and time when the checkout was created.

Checkout.updatedAt ● DateTime! non-null scalar

Time of last modification of the given checkout.

Added in Saleor 3.13

Checkout.lastChange ● DateTime! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use updatedAt instead.

Checkout.channel ● Channel! non-null object

The channel for which checkout was created.

Checkout.billingAddress ● Address object

The billing address of the checkout.

Checkout.shippingAddress ● Address object

The shipping address of the checkout.

Checkout.note ● String! non-null scalar

The note for the checkout.

Checkout.discount ● Money object

The total discount applied to the checkout. Note: Only discount created via voucher are included in this field.

Checkout.discountName ● String scalar

The name of voucher assigned to the checkout.

Checkout.translatedDiscountName ● String scalar

Translation of the discountName field in the language set in Checkout.languageCode field.Note: this field is set automatically when Checkout.languageCode is defined; otherwise it's null

Checkout.voucherCode ● String scalar

The code of voucher assigned to the checkout.

Checkout.availableShippingMethods ● [ShippingMethod!]! deprecated non-null object

DEPRECATED

This field will be removed in Saleor 4.0. Use shippingMethods instead.

Shipping methods that can be used with this checkout.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.

Checkout.shippingMethods ● [ShippingMethod!]! non-null object

Shipping methods that can be used with this checkout.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.

Checkout.availableCollectionPoints ● [Warehouse!]! non-null object

Collection points that can be used for this order.

Added in Saleor 3.1

Checkout.availablePaymentGateways ● [PaymentGateway!]! non-null object

List of available payment gateways.

Triggers the following webhook events:

  • PAYMENT_LIST_GATEWAYS (sync): Fetch payment gateways available for checkout.

Checkout.email ● String scalar

Email of a customer.

Checkout.giftCards ● [GiftCard!]! non-null object

List of gift cards associated with this checkout.

Checkout.isShippingRequired ● Boolean! non-null scalar

Returns True, if checkout requires shipping.

Checkout.quantity ● Int! non-null scalar

The number of items purchased.

Checkout.stockReservationExpires ● DateTime scalar

Date when oldest stock reservation for this checkout expires or null if no stock is reserved.

Added in Saleor 3.1

Checkout.lines ● [CheckoutLine!]! non-null object

A list of checkout lines, each containing information about an item in the checkout.

Checkout.shippingPrice ● TaxedMoney! non-null object

The price of the shipping, with all the taxes included. Set to 0 when no delivery method is selected.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

Checkout.shippingMethod ● ShippingMethod deprecated object

DEPRECATED

This field will be removed in Saleor 4.0. Use deliveryMethod instead.

The shipping method related with checkout.

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.

Checkout.deliveryMethod ● DeliveryMethod union

The delivery method selected for this checkout.

Added in Saleor 3.1

Triggers the following webhook events:

  • SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
  • CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.

Checkout.subtotalPrice ● TaxedMoney! non-null object

The price of the checkout before shipping, with taxes included.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

Checkout.taxExemption ● Boolean! non-null scalar

Returns True if checkout has to be exempt from taxes.

Added in Saleor 3.8

Checkout.token ● UUID! non-null scalar

The checkout's token.

Checkout.totalPrice ● TaxedMoney! non-null object

The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

Checkout.totalBalance ● Money! non-null object

The difference between the paid and the checkout total amount.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

Checkout.languageCode ● LanguageCodeEnum! non-null enum

Checkout language code.

Checkout.displayGrossPrices ● Boolean! non-null scalar

Determines whether displayed prices should include taxes.

Added in Saleor 3.9

Checkout.authorizeStatus ● CheckoutAuthorizeStatusEnum! non-null enum

The authorize status of the checkout.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

Checkout.chargeStatus ● CheckoutChargeStatusEnum! non-null enum

The charge status of the checkout.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.

Triggers the following webhook events:

  • CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.

Checkout.storedPaymentMethods ● [StoredPaymentMethod!] list object

List of user's stored payment methods that can be used in this checkout session. It uses the channel that the checkout was created in. When amount is not provided, checkout.total will be used as a default value.

Added in Saleor 3.15
This API is currently in Feature Preview and can be subject to changes at later point.
Checkout.storedPaymentMethods.amount ● PositiveDecimal scalar

Amount that will be used to fetch stored payment methods.

Checkout.problems ● [CheckoutProblem!] list union

List of problems with the checkout.

Added in Saleor 3.15
This API is currently in Feature Preview and can be subject to changes at later point.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned by

checkout query

Member of

CheckoutAddPromoCode object ● CheckoutBillingAddressUpdate object ● CheckoutCountableEdge object ● CheckoutCreate object ● CheckoutCreateFromOrder object ● CheckoutDeliveryMethodUpdate object ● CheckoutEmailUpdate object ● CheckoutLanguageCodeUpdate object ● CheckoutLineDelete object ● CheckoutLinesAdd object ● CheckoutLinesDelete object ● CheckoutLinesUpdate object ● CheckoutPaymentCreate object ● CheckoutRemovePromoCode object ● CheckoutShippingAddressUpdate object ● CheckoutShippingMethodUpdate object ● Payment object ● User object


Was this page helpful?