orderByToken Query

DEPRECATED

No longer supported

Look up an order by token.

orderByToken(
  token: UUID!
): Order @deprecated

Details

type Order 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!
  status: OrderStatus!
  user: User
  trackingClientId: String!
  billingAddress: Address
  shippingAddress: Address
  shippingMethodName: String
  collectionPointName: String
  channel: Channel!
  fulfillments: [Fulfillment!]!
  lines: [OrderLine!]!
  actions: [OrderAction!]!
  availableShippingMethods: [ShippingMethod!] @deprecated
  shippingMethods: [ShippingMethod!]!
  availableCollectionPoints: [Warehouse!]!
  invoices: [Invoice!]!
  number: String!
  original: ID
  origin: OrderOriginEnum!
  isPaid: Boolean!
  paymentStatus: PaymentChargeStatusEnum!
  paymentStatusDisplay: String!
  authorizeStatus: OrderAuthorizeStatusEnum!
  chargeStatus: OrderChargeStatusEnum!
  taxExemption: Boolean!
  transactions: [TransactionItem!]!
  payments: [Payment!]!
  total: TaxedMoney!
  undiscountedTotal: TaxedMoney!
  shippingMethod: ShippingMethod @deprecated
  undiscountedShippingPrice: Money!
  shippingPrice: TaxedMoney!
  shippingTaxRate: Float!
  shippingTaxClass: TaxClass
  shippingTaxClassName: String
  shippingTaxClassMetadata: [MetadataItem!]!
  shippingTaxClassPrivateMetadata: [MetadataItem!]!
  token: String! @deprecated
  voucher: Voucher
  voucherCode: String
  giftCards: [GiftCard!]!
  customerNote: String!
  weight: Weight!
  redirectUrl: String
  subtotal: TaxedMoney!
  statusDisplay: String!
  canFinalize: Boolean!
  totalAuthorized: Money!
  totalCaptured: Money! @deprecated
  totalCharged: Money!
  totalCanceled: Money!
  events: [OrderEvent!]!
  totalBalance: Money!
  userEmail: String
  isShippingRequired: Boolean!
  deliveryMethod: DeliveryMethod
  languageCode: String! @deprecated
  languageCodeEnum: LanguageCodeEnum!
  discount: Money @deprecated
  discountName: String @deprecated
  translatedDiscountName: String @deprecated
  discounts: [OrderDiscount!]!
  errors: [OrderError!]!
  displayGrossPrices: Boolean!
  externalReference: String
  checkoutId: ID
  grantedRefunds: [OrderGrantedRefund!]!
  totalGrantedRefund: Money!
  totalRefunded: Money!
  totalRefundPending: Money!
  totalAuthorizePending: Money!
  totalChargePending: Money!
  totalCancelPending: Money!
  totalRemainingGrant: Money!
}

Arguments

token ● UUID!

The order's token.

Type

Order

Represents an order in the shop.