checkout Query

Look up a checkout by id.

Requires one of the following permissions to query a checkout, if a checkout is in inactive channel: MANAGE_CHECKOUTSIMPERSONATE_USERHANDLE_PAYMENTS

checkout(
  id: ID
  token: UUID
): Checkout

Details

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!
  delivery: Delivery
  shippingMethod: ShippingMethod @deprecated
  deliveryMethod: DeliveryMethod @deprecated
  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!]
}

Arguments

id ● ID

The checkout's ID.

Show deprecatedHide deprecated

token ● UUID

DEPRECATED

Use id instead.

The checkout's token.

Type

Checkout

Checkout object.