Order Object

Represents an order in the shop.

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!
}

Fields

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.

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.

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.

metafields

metafields · Metadata

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

created

created · DateTime!

Date and time when the order was created.

updatedAt

updatedAt · DateTime!

Date and time when the order was created.

status

status · OrderStatus!

Status of the order.

User who placed the order. This field is set only for orders placed by authenticated users. Can be fetched for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_USERS, MANAGE_ORDERS, HANDLE_PAYMENTS, OWNER.

trackingClientId

trackingClientId · String!

Google Analytics tracking client ID.

billingAddress

billingAddress · Address

Billing address. The full data can be access for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.

shippingAddress

shippingAddress · Address

Shipping address. The full data can be access for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.

shippingMethodName

shippingMethodName · String

Method used for shipping.

collectionPointName

collectionPointName · String

Name of the collection point where the order should be picked up by the customer.

channel

channel · Channel!

Channel through which the order was placed.

fulfillments

fulfillments · [Fulfillment!]!

List of shipments for the order.

lines

lines · [OrderLine!]!

List of order lines.

actions

actions · [OrderAction!]!

List of actions that can be performed in the current state of an order.

availableShippingMethods

availableShippingMethods · [ShippingMethod!]

Shipping methods that can be used with this order.

shippingMethods

shippingMethods · [ShippingMethod!]!

Shipping methods related to this order.

availableCollectionPoints

availableCollectionPoints · [Warehouse!]!

Collection points that can be used for this order.

invoices

invoices · [Invoice!]!

List of order invoices. Can be fetched for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.

number

number · String!

User-friendly number of an order.

original

original · ID

The ID of the order that was the base for this order.

origin

origin · OrderOriginEnum!

The order origin.

isPaid

isPaid · Boolean!

Informs if an order is fully paid.

paymentStatus

paymentStatus · PaymentChargeStatusEnum!

Internal payment status.

paymentStatusDisplay

paymentStatusDisplay · String!

User-friendly payment status.

authorizeStatus

authorizeStatus · OrderAuthorizeStatusEnum!

The authorize status of the order.

chargeStatus

chargeStatus · OrderChargeStatusEnum!

The charge status of the order.

taxExemption

taxExemption · Boolean!

Returns True if order has to be exempt from taxes.

transactions

transactions · [TransactionItem!]!

List of transactions for the order.

Requires one of the following permissions:MANAGE_ORDERSHANDLE_PAYMENTS

transactionSummaries

transactionSummaries · [TransactionSummary!]!

Payment history of the order, with one entry per payment transaction that moved any money. Unlike transactions, it requires no permission and exposes only the payment method and the amounts, so it can be used to display payment details to the customer without exposing internal information.

Added in Saleor 3.23