Order

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
  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
  shippingPrice: TaxedMoney!
  shippingTaxRate: Float!
  shippingTaxClass: TaxClass
  shippingTaxClassName: String
  shippingTaxClassMetadata: [MetadataItem!]!
  shippingTaxClassPrivateMetadata: [MetadataItem!]!
  token: String! @deprecated
  voucher: Voucher
  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!
}

Fields

Order.id ● ID! non-null scalar

Order.privateMetadata ● [MetadataItem!]! non-null object

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

Order.privateMetafield ● String scalar

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3

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

Order.privateMetafield.key ● String! non-null scalar

Order.privateMetafields ● Metadata scalar

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

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

Order.privateMetafields.keys ● [String!] list scalar

Order.metadata ● [MetadataItem!]! non-null object

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

Order.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3

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

Order.metafield.key ● String! non-null scalar

Order.metafields ● Metadata scalar

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

Added in Saleor 3.3

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

Order.metafields.keys ● [String!] list scalar

Order.created ● DateTime! non-null scalar

Order.updatedAt ● DateTime! non-null scalar

Order.status ● OrderStatus! non-null enum

Order.user ● User object

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_USERSMANAGE_ORDERSOWNER

Order.trackingClientId ● String! non-null scalar

Order.billingAddress ● Address object

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_ORDERSOWNER

Order.shippingAddress ● Address object

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_ORDERSOWNER

Order.shippingMethodName ● String scalar

Order.collectionPointName ● String scalar

Order.channel ● Channel! non-null object

Order.fulfillments ● [Fulfillment!]! non-null object

List of shipments for the order.

Order.lines ● [OrderLine!]! non-null object

List of order lines.

Order.actions ● [OrderAction!]! non-null enum

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

Order.availableShippingMethods ● [ShippingMethod!] deprecated list object

DEPRECATED

Use shippingMethods, this field will be removed in 4.0

Shipping methods that can be used with this order.

Order.shippingMethods ● [ShippingMethod!]! non-null object

Shipping methods related to this order.

Order.availableCollectionPoints ● [Warehouse!]! non-null object

Collection points that can be used for this order.

Added in Saleor 3.1

Order.invoices ● [Invoice!]! non-null object

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_ORDERSOWNER

Order.number ● String! non-null scalar

User-friendly number of an order.

Order.original ● ID scalar

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

Order.origin ● OrderOriginEnum! non-null enum

The order origin.

Order.isPaid ● Boolean! non-null scalar

Informs if an order is fully paid.

Order.paymentStatus ● PaymentChargeStatusEnum! non-null enum

Internal payment status.

Order.paymentStatusDisplay ● String! non-null scalar

User-friendly payment status.

Order.authorizeStatus ● OrderAuthorizeStatusEnum! non-null enum

The authorize status of the order.

Added in Saleor 3.4

Order.chargeStatus ● OrderChargeStatusEnum! non-null enum

The charge status of the order.

Added in Saleor 3.4

Order.taxExemption ● Boolean! non-null scalar

Returns True if order has to be exempt from taxes.

Added in Saleor 3.8

Order.transactions ● [TransactionItem!]! non-null object

List of transactions for the order.

Requires one of the following permissions: MANAGE_ORDERSHANDLE_PAYMENTS

Added in Saleor 3.4

Order.payments ● [Payment!]! non-null object

List of payments for the order.

Order.total ● TaxedMoney! non-null object

Total amount of the order.

Order.undiscountedTotal ● TaxedMoney! non-null object

Undiscounted total amount of the order.

Order.shippingMethod ● ShippingMethod deprecated object

DEPRECATED

This field will be removed in Saleor 4.0. Use deliveryMethod instead.

Shipping method for this order.

Order.shippingPrice ● TaxedMoney! non-null object

Total price of shipping.

Order.shippingTaxRate ● Float! non-null scalar

The shipping tax rate value.

Order.shippingTaxClass ● TaxClass object

Denormalized tax class assigned to the shipping method.

Added in Saleor 3.9

Requires one of the following permissions: AUTHENTICATED_STAFF_USERAUTHENTICATED_APP

Order.shippingTaxClassName ● String scalar

Denormalized name of the tax class assigned to the shipping method.

Added in Saleor 3.9

Order.shippingTaxClassMetadata ● [MetadataItem!]! non-null object

Denormalized public metadata of the shipping method's tax class.

Added in Saleor 3.9

Order.shippingTaxClassPrivateMetadata ● [MetadataItem!]! non-null object

Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access.

Added in Saleor 3.9

Order.token ● String! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use id instead.

Order.voucher ● Voucher object

Order.giftCards ● [GiftCard!]! non-null object

List of user gift cards.

Order.customerNote ● String! non-null scalar

Order.weight ● Weight! non-null object

Order.redirectUrl ● String scalar

Order.subtotal ● TaxedMoney! non-null object

The sum of line prices not including shipping.

Order.statusDisplay ● String! non-null scalar

User-friendly order status.

Order.canFinalize ● Boolean! non-null scalar

Informs whether a draft order can be finalized(turned into a regular order).

Order.totalAuthorized ● Money! non-null object

Amount authorized for the order.

Order.totalCaptured ● Money! deprecated non-null object

DEPRECATED

This field will be removed in Saleor 4.0. Use totalCharged instead.

Amount captured for the order.

Order.totalCharged ● Money! non-null object

Amount charged for the order.

Added in Saleor 3.13

Order.totalCanceled ● Money! non-null object

Amount canceled for the order.

Added in Saleor 3.13

Order.events ● [OrderEvent!]! non-null object

List of events associated with the order.

Requires MANAGE_ORDERSpermission.

Order.totalBalance ● Money! non-null object

The difference between the paid and the order total amount.

Order.userEmail ● String scalar

Email address of the customer. 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_ORDERSOWNER

Order.isShippingRequired ● Boolean! non-null scalar

Returns True, if order requires shipping.

Order.deliveryMethod ● DeliveryMethod union

The delivery method selected for this order.

Added in Saleor 3.1

Order.languageCode ● String! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use the languageCodeEnum field to fetch the language code.

Order.languageCodeEnum ● LanguageCodeEnum! non-null enum

Order language code.

Order.discount ● Money deprecated object

DEPRECATED

This field will be removed in Saleor 4.0. Use the discounts field instead.

Returns applied discount.

Order.discountName ● String deprecated scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use the discounts field instead.

Discount name.

Order.translatedDiscountName ● String deprecated scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use the discounts field instead.

Translated discount name.

Order.discounts ● [OrderDiscount!]! non-null object

List of all discounts assigned to the order.

Order.errors ● [OrderError!]! non-null object

List of errors that occurred during order validation.

Order.displayGrossPrices ● Boolean! non-null scalar

Determines whether checkout prices should include taxes when displayed in a storefront.

Added in Saleor 3.9

Order.externalReference ● String scalar

External ID of this order.

Added in Saleor 3.10

Order.checkoutId ● ID scalar

ID of the checkout that the order was created from.

Added in Saleor 3.11

Order.grantedRefunds ● [OrderGrantedRefund!]! non-null object

List of granted refunds.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Order.totalGrantedRefund ● Money! non-null object

Total amount of granted refund.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Order.totalRefunded ● Money! non-null object

Total refund amount for the order.

Added in Saleor 3.13

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

Order.totalRefundPending ● Money! non-null object

Total amount of ongoing refund requests for the order's transactions.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Order.totalAuthorizePending ● Money! non-null object

Total amount of ongoing authorize requests for the order's transactions.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Order.totalChargePending ● Money! non-null object

Total amount of ongoing charge requests for the order's transactions.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Order.totalCancelPending ● Money! non-null object

Total amount of ongoing cancel requests for the order's transactions.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Order.totalRemainingGrant ● Money! non-null object

The difference amount between granted refund and the amounts that are pending and refunded.

Added in Saleor 3.13

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

Requires MANAGE_ORDERSpermission.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned by

order query ● orderByToken query

Member of

CheckoutComplete object ● CustomerEvent object ● DraftOrderComplete object ● DraftOrderCreate object ● DraftOrderCreated object ● DraftOrderDelete object ● DraftOrderDeleted object ● DraftOrderUpdate object ● DraftOrderUpdated object ● FulfillmentApprove object ● FulfillmentApproved object ● FulfillmentCancel object ● FulfillmentCanceled object ● FulfillmentCreated object ● FulfillmentMetadataUpdated object ● FulfillmentRefundProducts object ● FulfillmentReturnProducts object ● FulfillmentUpdateTracking object ● Invoice object ● InvoiceDeleted object ● InvoiceRequest object ● InvoiceRequested object ● InvoiceSent object ● OrderAddNote object ● OrderBulkCreated object ● OrderBulkCreateResult object ● OrderCancel object ● OrderCancelled object ● OrderCapture object ● OrderConfirm object ● OrderConfirmed object ● OrderCountableEdge object ● OrderCreated object ● OrderCreateFromCheckout object ● OrderDiscountAdd object ● OrderDiscountDelete object ● OrderDiscountUpdate object ● OrderEvent object ● OrderExpired object ● OrderFilterShippingMethods object ● OrderFulfill object ● OrderFulfilled object ● OrderFullyPaid object ● OrderFullyRefunded object ● OrderGrantRefundCreate object ● OrderGrantRefundUpdate object ● OrderLineDelete object ● OrderLineDiscountRemove object ● OrderLineDiscountUpdate object ● OrderLinesCreate object ● OrderLineUpdate object ● OrderMarkAsPaid object ● OrderMetadataUpdated object ● OrderPaid object ● OrderRefund object ● OrderRefunded object ● OrderUpdate object ● OrderUpdated object ● OrderUpdateShipping object ● OrderVoid object ● Payment object ● TransactionItem object

Implemented by

_Entity union ● OrderOrCheckout union ● TaxSourceObject union