Skip to main content

Checkout Object

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
  user: User
  channel: Channel!
  billingAddress: Address
  shippingAddress: Address
  customerNote: String!
  note: String! @deprecated
  discount: Money
  discountName: String
  translatedDiscountName: String
  voucher: Voucher
  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!
  transactions: [TransactionItem!]
  displayGrossPrices: Boolean!
  authorizeStatus: CheckoutAuthorizeStatusEnum!
  chargeStatus: CheckoutChargeStatusEnum!
  storedPaymentMethods(
    amount: PositiveDecimal
  ): [StoredPaymentMethod!]
  problems: [CheckoutProblem!]
}
Expand ▼

Fields​

Checkout.id ● ID! non-null scalar miscellaneous​

The ID of the checkout.

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

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

Checkout.privateMetafield ● String scalar miscellaneous​

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

Tip: Use GraphQL aliases to fetch multiple keys.

Checkout.privateMetafield.key ● String! non-null scalar miscellaneous​

Checkout.privateMetafields ● Metadata scalar miscellaneous​

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

Checkout.privateMetafields.keys ● [String!] list scalar miscellaneous​

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

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

Checkout.metafield ● String scalar miscellaneous​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Checkout.metafield.key ● String! non-null scalar miscellaneous​

Checkout.metafields ● Metadata scalar miscellaneous​

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

Checkout.metafields.keys ● [String!] list scalar miscellaneous​

Checkout.created ● DateTime! non-null scalar miscellaneous​

The date and time when the checkout was created.

Checkout.updatedAt ● DateTime! non-null scalar miscellaneous​

Time of last modification of the given checkout.

Checkout.lastChange ● DateTime! deprecated non-null scalar miscellaneous​

DEPRECATED

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

Checkout.user ● User object users​

The user assigned to the checkout.

Requires one of the following permissions: MANAGE_USERSHANDLE_PAYMENTSOWNER

Checkout.channel ● Channel! non-null object channels​

The channel for which checkout was created.

Checkout.billingAddress ● Address object users​

The billing address of the checkout.

Checkout.shippingAddress ● Address object users​

The shipping address of the checkout.

Checkout.customerNote ● String! non-null scalar miscellaneous​

The customer note for the checkout.

Added in Saleor 3.21

Checkout.note ● String! deprecated non-null scalar miscellaneous​

DEPRECATED

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

The note for the checkout.

Checkout.discount ● Money object miscellaneous​

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

Checkout.discountName ● String scalar miscellaneous​

The name of voucher assigned to the checkout.

Checkout.translatedDiscountName ● String scalar miscellaneous​

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.voucher ● Voucher object discounts​

The voucher assigned to the checkout.

Added in Saleor 3.18
Requires MANAGE_DISCOUNTSpermission.

Checkout.voucherCode ● String scalar miscellaneous​

The code of voucher assigned to the checkout.

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

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​

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 products​

Collection points that can be used for this order.

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

List of available payment gateways.

Triggers the following webhook events:

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

Checkout.email ● String scalar miscellaneous​

Email of a customer.

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

List of gift cards associated with this checkout.

Checkout.isShippingRequired ● Boolean! non-null scalar miscellaneous​

Returns True, if checkout requires shipping.

Checkout.quantity ● Int! non-null scalar miscellaneous​

The number of items purchased.

Checkout.stockReservationExpires ● DateTime scalar miscellaneous​

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

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

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

Checkout.shippingPrice ● TaxedMoney! non-null object miscellaneous​

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 shipping​

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 miscellaneous​

The delivery method selected for 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.subtotalPrice ● TaxedMoney! non-null object miscellaneous​

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 miscellaneous​

Returns True if checkout has to be exempt from taxes.

Checkout.token ● UUID! non-null scalar miscellaneous​

The checkout's token.

Checkout.totalPrice ● TaxedMoney! non-null object miscellaneous​

The sum of 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 miscellaneous​

The difference between the paid and the checkout total amount.

Triggers the following webhook events:

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

Checkout.languageCode ● LanguageCodeEnum! non-null enum miscellaneous​

Checkout language code.

Checkout.transactions ● [TransactionItem!] list object payments​

List of transactions for the checkout.

Requires one of the following permissions: MANAGE_CHECKOUTSHANDLE_PAYMENTS

Checkout.displayGrossPrices ● Boolean! non-null scalar miscellaneous​

Determines whether displayed prices should include taxes.

Checkout.authorizeStatus ● CheckoutAuthorizeStatusEnum! non-null enum checkout​

The authorize status of the checkout.

Triggers the following webhook events:

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

Checkout.chargeStatus ● CheckoutChargeStatusEnum! non-null enum checkout​

The charge status of the checkout.

Triggers the following webhook events:

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

Checkout.storedPaymentMethods ● [StoredPaymentMethod!] list object payments​

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.

Checkout.storedPaymentMethods.amount ● PositiveDecimal scalar miscellaneous​

Amount that will be used to fetch stored payment methods.

Checkout.problems ● [CheckoutProblem!] list union miscellaneous​

List of problems with the checkout.

Interfaces​

Node interface miscellaneous​

An object with an ID

ObjectWithMetadata interface miscellaneous​

Returned By​

checkout query

Member Of​

CheckoutAddPromoCode object ● CheckoutBillingAddressUpdate object ● CheckoutCountableEdge object ● CheckoutCreate object ● CheckoutCreated object ● CheckoutCreateFromOrder object ● CheckoutCustomerAttach object ● CheckoutCustomerDetach object ● CheckoutCustomerNoteUpdate object ● CheckoutDeliveryMethodUpdate object ● CheckoutEmailUpdate object ● CheckoutFilterShippingMethods object ● CheckoutFullyPaid object ● CheckoutLanguageCodeUpdate object ● CheckoutLineDelete object ● CheckoutLinesAdd object ● CheckoutLinesDelete object ● CheckoutLinesUpdate object ● CheckoutMetadataUpdated object ● CheckoutPaymentCreate object ● CheckoutRemovePromoCode object ● CheckoutShippingAddressUpdate object ● CheckoutShippingMethodUpdate object ● CheckoutUpdated object ● Payment object ● PaymentListGateways object ● ShippingListMethodsForCheckout object ● TransactionItem object ● User object

Implemented By​

OrderOrCheckout union ● TaxSourceObject union