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
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
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!
}
Fields
id ● ID!
ID of the order.
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.
key ● String!
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.
keys ● [String!]
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.
key ● String!
metafields ● Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
created ● DateTime!
Date and time when the order was created.
updatedAt ● DateTime!
Date and time when the order was created.
status ● OrderStatus!
Status of the order.
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
trackingClientId ● String!
Google Analytics tracking client ID.
billingAddress ● Address
Billing address. The full data can be access for orders created in Saleor 3.2 and later, for other orders
shippingAddress ● Address
Shipping address. The full data can be access for orders created in Saleor 3.2 and later, for other orders
shippingMethodName ● String
Method used for shipping.
collectionPointName ● String
Name of the collection point where the order should be picked up by the customer.
channel ● Channel!
Channel through which the order was placed.
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.
shippingMethods ● [ShippingMethod!]!
Shipping methods related to this order.
availableCollectionPoints ● [Warehouse!]!
Collection points that can be used for this order.
invoices ● [Invoice!]!
List of order invoices. Can be fetched for orders created in Saleor 3.2 and later, for other orders
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.
chargeStatus ● OrderChargeStatusEnum!
The charge status of the order.
taxExemption ● Boolean!
Returns True if order has to be exempt from taxes.
transactions ● [TransactionItem!]!
List of transactions for the order.
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.
total ● TaxedMoney!
Total amount of the order.
undiscountedTotal ● TaxedMoney!
Undiscounted total amount of the order.
undiscountedShippingPrice ● Money!
Undiscounted total price of shipping.
Added in Saleor 3.19shippingPrice ● TaxedMoney!
Total price of shipping.
shippingTaxRate ● Float!
The shipping tax rate value.
shippingTaxClass ● TaxClass
Denormalized tax class assigned to the shipping method.
shippingTaxClassName ● String
Denormalized name of the tax class assigned to the shipping method.
shippingTaxClassMetadata ● [MetadataItem!]!
Denormalized public metadata of the shipping method's tax class.
shippingTaxClassPrivateMetadata ● [MetadataItem!]!
Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access.
voucher ● Voucher
Voucher linked to the order.
voucherCode ● String
Voucher code that was used for Order.
Added in Saleor 3.18giftCards ● [GiftCard!]!
List of user gift cards.
customerNote ● String!
Additional information provided by the customer about the order.
weight ● Weight!
Weight of the order.
redirectUrl ● String
URL to which user should be redirected after order is placed.
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.
totalCharged ● Money!
Amount charged for the order.
totalCanceled ● Money!
Amount canceled for the order.
events ● [OrderEvent!]!
List of events associated with the order.
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
isShippingRequired ● Boolean!
Returns True, if order requires shipping.
deliveryMethod ● DeliveryMethod
The delivery method selected for this order.
languageCodeEnum ● LanguageCodeEnum!
Order language code.
discounts ● [OrderDiscount!]!
List of all discounts assigned to the order.
errors ● [OrderError!]!
List of errors that occurred during order validation.
displayGrossPrices ● Boolean!
Determines whether displayed prices should include taxes.
externalReference ● String
External ID of this order.
checkoutId ● ID
ID of the checkout that the order was created from.
grantedRefunds ● [OrderGrantedRefund!]!
List of granted refunds.
totalGrantedRefund ● Money!
Total amount of granted refund.
totalRefunded ● Money!
Total refund amount for the order.
totalRefundPending ● Money!
Total amount of ongoing refund requests for the order's transactions.
totalAuthorizePending ● Money!
Total amount of ongoing authorize requests for the order's transactions.
totalChargePending ● Money!
Total amount of ongoing charge requests for the order's transactions.
totalCancelPending ● Money!
Total amount of ongoing cancel requests for the order's transactions.
totalRemainingGrant ● Money!
The difference amount between granted refund and the amounts that are pending and refunded.
Show deprecatedHide deprecated
availableShippingMethods ● [ShippingMethod!]
Use shippingMethods, this field will be removed in 4.0
Shipping methods that can be used with this order.
payments ● [Payment!]!
The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.
List of payments for the order.
shippingMethod ● ShippingMethod
Use deliveryMethod instead.
Shipping method for this order.
token ● String!
Use id instead.
totalCaptured ● Money!
Use totalCharged instead.
Amount captured for the order.
languageCode ● String!
Use the languageCodeEnum field to fetch the language code.
discount ● Money
Use the discounts field instead.
Returns applied discount.
discountName ● String
Use the discounts field instead.
Discount name.
translatedDiscountName ● String
Use the discounts field instead.
Translated discount name.
Interfaces
Node
An object with an ID
ObjectWithMetadata
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 ● FulfillmentTrackingNumberUpdated 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 ● OrderNoteAdd object ● OrderNoteUpdate 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