OBJECT

Order

Represents an order in the shop.

link GraphQL Schema definition

  • type Order implements Node {
  • # The ID of the object.
  • id: ID!
  • created: DateTime!
  • status: OrderStatus!
  • user: User
  • languageCode: String!
  • trackingClientId: String!
  • billingAddress: Address
  • shippingAddress: Address
  • shippingMethod: ShippingMethod
  • shippingMethodName: String
  • # Total price of shipping.
  • shippingPrice: TaxedMoney
  • token: String!
  • voucher: Voucher
  • # List of user gift cards.
  • giftCards: [GiftCard]
  • discount: Money
  • discountName: String!
  • translatedDiscountName: String!
  • displayGrossPrices: Boolean!
  • customerNote: String!
  • weight: Weight
  • # List of privately stored metadata namespaces.
  • privateMeta: [MetaStore]!
  • # List of publicly stored metadata namespaces.
  • meta: [MetaStore]!
  • # List of shipments for the order.
  • fulfillments: [Fulfillment]!
  • # List of order lines.
  • lines: [OrderLine]!
  • # List of actions that can be performed in the current state of an
  • # order.
  • actions: [OrderAction]!
  • # Shipping methods that can be used with this order.
  • availableShippingMethods: [ShippingMethod]
  • # User-friendly number of an order.
  • number: String
  • # Informs if an order is fully paid.
  • isPaid: Boolean
  • # Internal payment status.
  • paymentStatus: PaymentChargeStatusEnum
  • # User-friendly payment status.
  • paymentStatusDisplay: String
  • # List of payments for the order.
  • payments: [Payment]
  • # Total amount of the order.
  • total: TaxedMoney
  • # The sum of line prices not including shipping.
  • subtotal: TaxedMoney
  • # User-friendly order status.
  • statusDisplay: String
  • # Informs whether a draft order can be finalized(turned into a regular
  • # order).
  • canFinalize: Boolean!
  • # Amount authorized for the order.
  • totalAuthorized: Money
  • # Amount captured by payment.
  • totalCaptured: Money
  • # List of events associated with the order.
  • events: [OrderEvent]
  • # The difference between the paid and the order total amount.
  • totalBalance: Money!
  • # Email address of the customer.
  • userEmail: String
  • # Returns True, if order requires shipping.
  • isShippingRequired: Boolean!
  • discountAmount: Money! @deprecated( reason: "DEPRECATED: Will be removed in Saleor 2.10, use discount instead." )
  • }