Skip to main content

Order

A customer order.

type Order implements Node {
id: ID!
amountNet: Float
amountTotal: Float
billingAdditionalAddressLine1: String
billingAdditionalAddressLine2: String
billingCity: String
billingCompany: String
billingCountryId: ID
billingDepartment: String
billingFirstName: String
billingLastName: String
billingPhoneNumber: String
billingSalutationId: ID
billingStreet: String
billingTitle: String
billingZipcode: String
createdAt: DateTime!
currencyId: ID!
customFields: JSON
customerComment: String
customerCompany: String
customerEmail: String
customerFirstName: String
customerLastName: String
customerSalutationId: ID
customerTitle: String
deliveryState: String
orderDateTime: DateTime!
orderNumber: String
paymentState: String
positionPrice: Float
shippingTotal: Float
state: String!
taxStatus: String
trackingCodes: JSON
updatedAt: DateTime
currency: Currency
customer: Customer
deliveries(
first: Int = 10
after: String
filter: OrderDeliveryFilterInput
): OrderDeliveryConnection
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
primaryOrderDelivery: OrderDelivery
primaryOrderTransaction: OrderTransaction
returnOrders(
first: Int = 10
after: String
filter: ReturnOrderFilterInput
): ReturnOrderConnection
salesChannel: SalesChannel
tags(
first: Int = 10
after: String
filter: TagFilterInput
): TagConnection
transactions(
first: Int = 10
after: String
filter: OrderTransactionFilterInput
): OrderTransactionConnection
}

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.billingAdditionalAddressLine1 ● String scalar​

First additional address line of the billing address.

Order.billingAdditionalAddressLine2 ● String scalar​

Second additional address line of the billing address.

Order.billingCity ● String scalar​

City of the billing address.

Order.billingCompany ● String scalar​

Company on the billing address.

Order.billingCountryId ● ID scalar​

ID of the country of the billing address.

Order.billingDepartment ● String scalar​

Department on the billing address.

Order.billingFirstName ● String scalar​

First name on the billing address.

Order.billingLastName ● String scalar​

Last name on the billing address.

Order.billingPhoneNumber ● String scalar​

Phone number on the billing address.

Order.billingSalutationId ● ID scalar​

ID of the salutation on the billing address.

Order.billingStreet ● String scalar​

Street and house number of the billing address.

Order.billingTitle ● String scalar​

Academic or honorific title on the billing address (e.g. Dr.).

Order.billingZipcode ● String scalar​

Postal code of the billing address.

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.customFields ● JSON scalar​

Custom fields of the order, as a JSON object keyed by custom field name.

Order.customerComment ● String scalar​

Comment the customer left when placing the order.

Order.customerCompany ● String scalar​

Company of the customer as it was when the order was placed.

Order.customerEmail ● String scalar​

Email address of the customer as it was when the order was placed.

Order.customerFirstName ● String scalar​

First name of the customer as it was when the order was placed.

Order.customerLastName ● String scalar​

Last name of the customer as it was when the order was placed.

Order.customerSalutationId ● ID scalar​

ID of the salutation of the customer as it was when the order was placed.

Order.customerTitle ● String scalar​

Academic or honorific title of the customer as it was when the order was placed.

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.positionPrice ● Float scalar​

Sum of the line item totals in the order's currency, before shipping costs.

Order.shippingTotal ● Float scalar​

Total shipping costs of the order in the order's currency.

Order.state ● String! non-null scalar​

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

Order.taxStatus ● String scalar​

Whether the order's prices are gross (tax included), net (tax added on top) or tax-free.

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.customer ● Customer object​

Order.deliveries ● OrderDeliveryConnection object​

Order.deliveries.first ● Int scalar​
Order.deliveries.after ● String scalar​
Order.deliveries.filter ● OrderDeliveryFilterInput input​

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.primaryOrderDelivery ● OrderDelivery object​

Order.primaryOrderTransaction ● OrderTransaction object​

Order.returnOrders ● ReturnOrderConnection object​

Order.returnOrders.first ● Int scalar​
Order.returnOrders.after ● String scalar​
Order.returnOrders.filter ● ReturnOrderFilterInput input​

Order.salesChannel ● SalesChannel object​

Order.tags ● TagConnection object​

Order.tags.first ● Int scalar​
Order.tags.after ● String scalar​
Order.tags.filter ● TagFilterInput input​

Order.transactions ● OrderTransactionConnection object​

Order.transactions.first ● Int scalar​
Order.transactions.after ● String scalar​
Order.transactions.filter ● OrderTransactionFilterInput input​

Interfaces​

Node interface​

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

Returned By​

addOrderLineItem mutation ● cancelOrder mutation ● cancelOrderDelivery mutation ● cancelOrderPayment mutation ● completeOrder mutation ● failOrderPayment mutation ● importOrder mutation ● markOrderAsPartiallyReturned mutation ● markOrderAsPartiallyShipped mutation ● markOrderAsReturned mutation ● markOrderAsShipped mutation ● order query ● placeOrder mutation ● recordOrderPayment mutation ● refundOrderPayment mutation ● remindOrderPayment mutation ● removeOrderLineItem mutation ● reopenOrder mutation ● reopenOrderDelivery mutation ● resetOrderPayment mutation ● setOrderCustomFields mutation ● shipOrderCompletely mutation ● startOrderProcessing mutation ● updateOrder mutation ● updateOrderLineItem mutation

Member Of​

Document object ● FulfillmentOrder object ● OrderDelivery object ● OrderEdge object ● OrderLineItem object ● OrderTransaction object ● Quote object ● ReturnOrder object ● Stock object ● StockMovement object

Webhook topics​

TopicFires when
order/completely-shipped
Required scopeorders:read
A shipment closes the last open quantity of the order. The same shipment also fires fulfillment-order/fulfilled, see Order or fulfillment order topics.
order/partially-shipped
Required scopeorders:read
A shipment leaves quantities of the order open. The same shipment also fires fulfillment-order/partially-fulfilled or fulfillment-order/fulfilled, see Order or fulfillment order topics.

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