Order

A customer order.

type Order implements Node {
  id: ID!
  orderNumber: String
  currencyId: ID!
  orderDateTime: DateTime!
  amountTotal: Float
  amountNet: Float
  createdAt: DateTime!
  updatedAt: DateTime
  state: String!
  paymentState: String
  deliveryState: String
  currency: Currency
  salesChannel: SalesChannel
  lineItems(
    first: Int = 10
    after: String
    filter: OrderLineItemFilterInput
  ): OrderLineItemConnection
  documents(
    first: Int = 10
    after: String
    filter: DocumentFilterInput
  ): DocumentConnection
  tags(
    first: Int = 10
    after: String
    filter: TagFilterInput
  ): TagConnection
}

Fields

Order.id ● ID! non-null scalar

Global identifier for this entity.

Order.orderNumber ● String scalar

Human-readable order number assigned at checkout.

Order.currencyId ● ID! non-null scalar

ID of the currency the order is denominated in.

Order.orderDateTime ● DateTime! non-null scalar

Timestamp the order was placed.

Order.amountTotal ● Float scalar

Order grand total in the order's currency, including tax. Recomputed on every line-item change.

Order.amountNet ● Float scalar

Order net total in the order's currency, excluding tax.

Order.createdAt ● DateTime! non-null scalar

Timestamp the order row was first persisted (usually equal to orderDateTime).

Order.updatedAt ● DateTime scalar

Timestamp of the last update to the order row.

Order.state ● String! non-null scalar

Name of the order's state (e.g. open, in_progress, completed, cancelled).

Order.paymentState ● String scalar

Name of the primary transaction's payment state (e.g. open, paid, refunded).

Order.deliveryState ● String scalar

Name of the primary delivery's state (e.g. open, shipped, returned).

Order.currency ● Currency object

Order.salesChannel ● SalesChannel object

Order.lineItems ● OrderLineItemConnection object

Order.lineItems.first ● Int scalar

Order.lineItems.after ● String scalar

Order.lineItems.filter ● OrderLineItemFilterInput input

Order.documents ● DocumentConnection object

Order.documents.first ● Int scalar

Order.documents.after ● String scalar

Order.documents.filter ● DocumentFilterInput input

Order.tags ● TagConnection object

Order.tags.first ● Int scalar

Order.tags.after ● String scalar

Order.tags.filter ● TagFilterInput input

Interfaces

Node interface

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By

order query ● shipOrderCompletely mutation

Member Of

Document object ● OrderEdge object ● OrderLineItem object ● Stock object