Skip to main content
Version: 3.x

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!]
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
shippingPrice: TaxedMoney!
shippingTaxRate: Float!
token: String!
voucher: Voucher
giftCards: [GiftCard!]!
displayGrossPrices: Boolean!
customerNote: String!
weight: Weight!
redirectUrl: String
subtotal: TaxedMoney!
statusDisplay: String!
canFinalize: Boolean!
totalAuthorized: Money!
totalCaptured: Money!
events: [OrderEvent!]!
totalBalance: Money!
userEmail: String
isShippingRequired: Boolean!
deliveryMethod: DeliveryMethod
languageCode: String!
languageCodeEnum: LanguageCodeEnum!
discount: Money
discountName: String
translatedDiscountName: String
discounts: [OrderDiscount!]!
errors: [OrderError!]!
}

Fields

id (ID!)

privateMetadata ([MetadataItem!]!)

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

privateMetafield (String)

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

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

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.

Added in Saleor 3.3.

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

metadata ([MetadataItem!]!)

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

metafield (String)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

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

metafields (Metadata)

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

Added in Saleor 3.3.

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

created (DateTime!)

updatedAt (DateTime!)

status (OrderStatus!)

user (User)

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, OWNER.

trackingClientId (String!)

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 (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 (String)

collectionPointName (String)

channel (Channel!)

fulfillments ([Fulfillment!]!)

List of shipments for the order.

lines ([OrderLine!]!)

List of order lines.

actions ([OrderAction!]!)

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

availableShippingMethods ([ShippingMethod!])

Shipping methods that can be used with this order.

shippingMethods ([ShippingMethod!]!)

Shipping methods related to this order.

availableCollectionPoints ([Warehouse!]!)

Collection points that can be used for this order.

Added in Saleor 3.1.

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

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 (String!)

User-friendly number of an order.

original (ID)

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

origin (OrderOriginEnum!)

The order origin.

isPaid (Boolean!)

Informs if an order is fully paid.

paymentStatus (PaymentChargeStatusEnum!)

Internal payment status.

paymentStatusDisplay (String!)

User-friendly payment status.

authorizeStatus (OrderAuthorizeStatusEnum!)

The authorize status of the order.

Added in Saleor 3.4.

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

chargeStatus (OrderChargeStatusEnum!)

The charge status of the order.

Added in Saleor 3.4.

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

taxExemption (Boolean!)

Returns True if order has to be exempt from taxes.

Added in Saleor 3.8.

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

transactions ([TransactionItem!]!)

List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS.

Added in Saleor 3.4.

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

payments ([Payment!]!)

List of payments for the order.

total (TaxedMoney!)

Total amount of the order.

undiscountedTotal (TaxedMoney!)

Undiscounted total amount of the order.

shippingMethod (ShippingMethod)

Shipping method for this order.

shippingPrice (TaxedMoney!)

Total price of shipping.

shippingTaxRate (Float!)

token (String!)

voucher (Voucher)

giftCards ([GiftCard!]!)

List of user gift cards.

displayGrossPrices (Boolean!)

customerNote (String!)

weight (Weight!)

redirectUrl (String)

subtotal (TaxedMoney!)

The sum of line prices not including shipping.

statusDisplay (String!)

User-friendly order status.

canFinalize (Boolean!)

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

totalAuthorized (Money!)

Amount authorized for the order.

totalCaptured (Money!)

Amount captured by payment.

events ([OrderEvent!]!)

List of events associated with the order.

Requires one of the following permissions: MANAGE_ORDERS.

totalBalance (Money!)

The difference between the paid and the order total amount.

userEmail (String)

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_ORDERS, OWNER.

isShippingRequired (Boolean!)

Returns True, if order requires shipping.

deliveryMethod (DeliveryMethod)

The delivery method selected for this order.

Added in Saleor 3.1.

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

languageCode (String!)

languageCodeEnum (LanguageCodeEnum!)

Order language code.

discount (Money)

Returns applied discount.

discountName (String)

Discount name.

translatedDiscountName (String)

Translated discount name.

discounts ([OrderDiscount!]!)

List of all discounts assigned to the order.

errors ([OrderError!]!)

List of errors that occurred during order validation.

Interfaces

Node

An object with an ID

ObjectWithMetadata