Order
An order is a collection of items that a customer has purchased. As an order accrues transactions, it changes status until it is eventually complete. Orders rely on Suppliers to fulfill the OrderItems by creating PurchaseOrderItems (which are then fulfilled).
type Order {
billingAddress: Address!
createdAt: Date!
customerId: ID
customerNote: String
demandHqId: ID!
emailAddress: String!
item(
orderItemId: ID!
): OrderItem!
items(
after: String
before: String
first: Int
last: Int
): OrderItemConnection!
note: String
orderId: ID!
paymentId: ID
phoneNumber: String
placedAt: Date
shippingAddress: Address!
shippingCharges: [OrderShippingCharge]
status: OrderStatus!
storefrontId: ID
tags: OrderTags
transactions(
after: String
before: String
first: Int
last: Int
): OrderTransactionConnection!
updatedAt: Date!
updatedBy: ID!
}
Fields
Order.billingAddress ● Address! non-null object
Order.createdAt ● Date! non-null scalar
Order.customerId ● ID scalar
Order.customerNote ● String scalar
A note provided by the customer at time of order
Order.demandHqId ● ID! non-null scalar
Order.emailAddress ● String! non-null scalar
Order.item ● OrderItem! non-null object
Get a single OrderItem by ID.
Requires the orderitem/read permission on the associated DemandHq.
Order.item.orderItemId●ID!non-null scalar
Order.items ● OrderItemConnection! non-null object
List the items in an order.
Requires the orderitem/read permission on the associated DemandHq.
Order.items.after●StringscalarReturns the elements in the list that come after the specified cursor.
Order.items.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Order.items.first ● Int scalar
Returns the first n elements from the list.
Order.items.last ● Int scalar
Returns the last n elements from the list.
Order.note ● String scalar
Order.orderId ● ID! non-null scalar
Order.paymentId ● ID scalar
A reference to an outside payment gateway, used for tracking transactions. May be an orderID, or a paymentID.
Order.phoneNumber ● String scalar
Order.placedAt ● Date scalar
ISO Date indicated when an order should be considered complete, closed for some changes, and started to process.
Order.shippingAddress ● Address! non-null object
Order.shippingCharges ● [OrderShippingCharge] list object
Order.status ● OrderStatus! non-null enum
The status of the order currently, this field is read-only and can change many times over the course of the order
Order.storefrontId ● ID scalar
Order.tags ● OrderTags object
Get the tags for an order.
Requires the order/read scope on the associated DemandHq.
Order.transactions ● OrderTransactionConnection! non-null object
List the transactions in an order.
Requires the ordertransaction/read permission on the associated DemandHq.
Order.transactions.after●StringscalarReturns the elements in the list that come after the specified cursor.
Order.transactions.before ● String scalar
Returns the elements in the list that come before the specified cursor.
Order.transactions.first ● Int scalar
Returns the first n elements from the list.
Order.transactions.last ● Int scalar
Returns the last n elements from the list.
Order.updatedAt ● Date! non-null scalar
Order.updatedBy ● ID! non-null scalar
Returned by
createOrder mutation ● order query ● placeOrder mutation ● updateOrder mutation
Member of
DemandHq object ● OrderConnection object ● OrderEdge object ● OrderItem object