orderByToken Query
Look up an order by token.
orderByToken(token: UUID!): Order
Returns
Show return type
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(reason: "Use `shippingMethods`, this field will be removed in 4.0")
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!]!
transactionSummaries: [TransactionSummary!]!
payments: [Payment!]! @deprecated(reason: "The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.")
total: TaxedMoney!
undiscountedTotal: TaxedMoney!
shippingMethod: ShippingMethod @deprecated(reason: "Use `deliveryMethod` instead.")
undiscountedShippingPrice: Money!
shippingPrice: TaxedMoney!
shippingTaxRate: Float!
shippingTaxClass: TaxClass
shippingTaxClassName: String
shippingTaxClassMetadata: [MetadataItem!]!
shippingTaxClassPrivateMetadata: [MetadataItem!]!
token: String! @deprecated(reason: "Use `id` instead.")
voucher: Voucher
voucherCode: String
giftCards: [GiftCard!]!
customerNote: String!
weight: Weight!
redirectUrl: String
subtotal: TaxedMoney!
statusDisplay: String!
canFinalize: Boolean!
totalAuthorized: Money!
totalCaptured: Money! @deprecated(reason: "Use `totalCharged` instead.")
totalCharged: Money!
totalCanceled: Money!
events: [OrderEvent!]!
totalBalance: Money!
userEmail: String
isShippingRequired: Boolean!
deliveryMethod: DeliveryMethod
languageCode: String! @deprecated(reason: "Use the `languageCodeEnum` field to fetch the language code.")
languageCodeEnum: LanguageCodeEnum!
discount: Money @deprecated(reason: "Use the `discounts` field instead.")
discountName: String @deprecated(reason: "Use the `discounts` field instead.")
translatedDiscountName: String @deprecated(reason: "Use the `discounts` field instead.")
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
token · UUID!
The order’s token.
Schema: Saleor 3.23.43. Download SDL.