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(reason: "Use `updatedAt` instead.")
  user: User
  channel: Channel!
  billingAddress: Address
  shippingAddress: Address
  customerNote: String!
  note: String! @deprecated(reason: "Use `customerNote` instead.")
  discount: Money
  discountName: String
  translatedDiscountName: String
  voucher: Voucher
  voucherCode: String
  availableShippingMethods: [ShippingMethod!]! @deprecated(reason: "Use `shippingMethods` instead.")
  shippingMethods: [ShippingMethod!]!
  availableCollectionPoints: [Warehouse!]!
  availablePaymentGateways: [PaymentGateway!]! @deprecated(reason: "The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.")
  email: String
  giftCards: [GiftCard!]!
  isShippingRequired: Boolean!
  quantity: Int!
  stockReservationExpires: DateTime
  lines: [CheckoutLine!]!
  shippingPrice: TaxedMoney!
  delivery: Delivery
  shippingMethod: ShippingMethod @deprecated(reason: "Use `delivery` instead.")
  deliveryMethod: DeliveryMethod @deprecated(reason: "Use `delivery` instead.")
  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!]
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

The ID of the checkout.

privateMetadata

privateMetadata · [MetadataItem!]!

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

privateMetafield

privateMetafield · String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

privateMetafields · Metadata

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

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

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

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

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

keys

keys · [String!]

created

created · DateTime!

The date and time when the checkout was created.

updatedAt

updatedAt · DateTime!

Time of last modification of the given checkout.

lastChange

lastChange · DateTime!

user

user · User

The user assigned to the checkout.

Requires one of the following permissions:MANAGE_USERSHANDLE_PAYMENTSOWNER

channel

channel · Channel!

The channel for which checkout was created.

billingAddress

billingAddress · Address

The billing address of the checkout.

shippingAddress

shippingAddress · Address

The shipping address of the checkout.

customerNote

customerNote · String!

The customer note for the checkout.

note

note · String!

The note for the checkout.

discount

discount · Money

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

discountName

discountName · String

The name of voucher assigned to the checkout.

translatedDiscountName

translatedDiscountName · String

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

voucher

voucher · Voucher

The voucher assigned to the checkout.

Requires one of the following permissions:MANAGE_DISCOUNTS

voucherCode

voucherCode · String

The code of voucher assigned to the checkout.

availableShippingMethods

availableShippingMethods · [ShippingMethod!]!

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS])

shippingMethods

shippingMethods · [ShippingMethod!]!

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS])

availableCollectionPoints

availableCollectionPoints · [Warehouse!]!

Collection points that can be used for this order.

availablePaymentGateways

availablePaymentGateways · [PaymentGateway!]!

List of available payment gateways.

Triggers the following webhook events:

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

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_LIST_GATEWAYS])

email

email · String

Email of a customer.

giftCards

giftCards · [GiftCard!]!

List of gift cards associated with this checkout.

isShippingRequired

isShippingRequired · Boolean!

Returns True, if checkout requires shipping.

quantity

quantity · Int!

The number of items purchased.

stockReservationExpires

stockReservationExpires · DateTime

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

lines

lines · [CheckoutLine!]!

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

shippingPrice

shippingPrice · TaxedMoney!

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])

delivery

delivery · Delivery

The delivery method selected for this checkout.

Added in Saleor 3.23

shippingMethod

shippingMethod · ShippingMethod

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS])

deliveryMethod

deliveryMethod · DeliveryMethod

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS])

subtotalPrice

subtotalPrice · TaxedMoney!

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])

taxExemption

taxExemption · Boolean!

Returns True if checkout has to be exempt from taxes.

token

token · UUID!

The checkout’s token.

totalPrice

totalPrice · TaxedMoney!

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])

totalBalance

totalBalance · Money!

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.

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])

languageCode

languageCode · LanguageCodeEnum!

Checkout language code.

transactions

transactions · [TransactionItem!]

List of transactions for the checkout.

Requires one of the following permissions:MANAGE_CHECKOUTSHANDLE_PAYMENTS

displayGrossPrices

displayGrossPrices · Boolean!

Determines whether displayed prices should include taxes.

authorizeStatus

authorizeStatus · CheckoutAuthorizeStatusEnum!

The authorize status of the checkout.

Triggers the following webhook events:

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

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])

chargeStatus

chargeStatus · CheckoutChargeStatusEnum!

The charge status of the checkout.

Triggers the following webhook events:

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

Applied directives

@webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])