Skip to main content
Version: 3.x

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!
lastChange: DateTime!
user: User
channel: Channel!
billingAddress: Address
shippingAddress: Address
note: String!
discount: Money
discountName: String
translatedDiscountName: String
voucherCode: String
availableShippingMethods: [ShippingMethod!]!
shippingMethods: [ShippingMethod!]!
availableCollectionPoints: [Warehouse!]!
availablePaymentGateways: [PaymentGateway!]!
email: String
giftCards: [GiftCard!]!
isShippingRequired: Boolean!
quantity: Int!
stockReservationExpires: DateTime
lines: [CheckoutLine!]!
shippingPrice: TaxedMoney!
shippingMethod: ShippingMethod
deliveryMethod: DeliveryMethod
subtotalPrice: TaxedMoney!
taxExemption: Boolean!
token: UUID!
totalPrice: TaxedMoney!
languageCode: LanguageCodeEnum!
transactions: [TransactionItem!]
}

Fields

id (ID!)

privateMetadata ([MetadataItem!]!)

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

privateMetafield (String)

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metadata ([MetadataItem!]!)

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

metafield (String)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

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

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

created (DateTime!)

lastChange (DateTime!)

user (User)

channel (Channel!)

billingAddress (Address)

shippingAddress (Address)

note (String!)

discount (Money)

discountName (String)

translatedDiscountName (String)

voucherCode (String)

availableShippingMethods ([ShippingMethod!]!)

Shipping methods that can be used with this checkout.

shippingMethods ([ShippingMethod!]!)

Shipping methods that can be used with this checkout.

availableCollectionPoints ([Warehouse!]!)

Collection points that can be used for this order.

Added in Saleor 3.1.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

availablePaymentGateways ([PaymentGateway!]!)

List of available payment gateways.

email (String)

Email of a customer.

giftCards ([GiftCard!]!)

List of gift cards associated with this checkout.

isShippingRequired (Boolean!)

Returns True, if checkout requires shipping.

quantity (Int!)

The number of items purchased.

stockReservationExpires (DateTime)

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

Added in Saleor 3.1.

lines ([CheckoutLine!]!)

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

shippingPrice (TaxedMoney!)

The price of the shipping, with all the taxes included.

shippingMethod (ShippingMethod)

The shipping method related with checkout.

deliveryMethod (DeliveryMethod)

The delivery method selected for this checkout.

Added in Saleor 3.1.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

subtotalPrice (TaxedMoney!)

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

taxExemption (Boolean!)

Returns True if checkout has to be exempt from taxes.

Added in Saleor 3.8.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

token (UUID!)

The checkout's token.

totalPrice (TaxedMoney!)

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

languageCode (LanguageCodeEnum!)

Checkout language code.

transactions ([TransactionItem!])

List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS.

Added in Saleor 3.4.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

Interfaces

Node

An object with an ID

ObjectWithMetadata