Skip to main content

Order

A customer order.

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

Fields​

Order.id ● ID! non-null scalar​

Global identifier for this entity.

Order.amountNet ● Float scalar​

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

Order.amountTotal ● Float scalar​

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

Order.createdAt ● DateTime! non-null scalar​

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

Order.currencyId ● ID! non-null scalar​

ID of the currency the order is denominated in.

Order.deliveryState ● String scalar​

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

Order.orderDateTime ● DateTime! non-null scalar​

Timestamp the order was placed.

Order.orderNumber ● String scalar​

Human-readable order number assigned at checkout.

Order.paymentState ● String scalar​

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

Order.shopifyId ● String scalar​

Shopify GID of the order, e.g. gid://shopify/Order/5123. Null for an order that was not imported from Shopify.

Order.state ● String! non-null scalar​

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

Order.trackingCodes ● JSON scalar​

Tracking codes of the primary delivery, as a JSON array of strings. Every shipping label Pickware creates for the order adds its outgoing tracking codes there and cancelling the label removes them, so the list covers all shipments of the order, together with codes entered on the delivery by hand. Empty while that delivery carries none, null when the order has no delivery at all.

Order.updatedAt ● DateTime scalar​

Timestamp of the last update to the order row.

Order.currency ● Currency object​

Order.documents ● DocumentConnection object​

Order.documents.first ● Int scalar​
Order.documents.after ● String scalar​
Order.documents.filter ● DocumentFilterInput input​

Order.fulfillmentOrders ● FulfillmentOrderConnection object​

Order.fulfillmentOrders.first ● Int scalar​
Order.fulfillmentOrders.after ● String scalar​
Order.fulfillmentOrders.filter ● FulfillmentOrderFilterInput input​

Order.lineItems ● OrderLineItemConnection object​

Order.lineItems.first ● Int scalar​
Order.lineItems.after ● String scalar​
Order.lineItems.filter ● OrderLineItemFilterInput input​

Order.salesChannel ● SalesChannel object​

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 ● FulfillmentOrder object ● OrderEdge object ● OrderLineItem object ● Quote object ● Stock object ● StockMovement object

Webhook topics​

TopicRequired scopeFires when
order/completely-shippedorders:readA shipment closes the last open quantity of the order.
order/partially-shippedorders:readA shipment leaves quantities of the order open.

The webhooks guide explains how to subscribe to a topic and verify the notifications it sends.