PublicOrder

A Order is a part of the Demand Domain and represents a the basic information of a order. Orders have many support entities, including variants, which represent SKUs of the order.

type PublicOrder {
  billingAddress: Address!
  customerId: ID
  customerNote: String
  demandHqId: ID!
  emailAddress: String!
  items(
  after: String
  before: String
  first: Int
  last: Int
): PublicOrderItemConnection!
  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
): PublicOrderTransactionConnection!
}

Fields

PublicOrder.billingAddress ● Address! non-null object

PublicOrder.customerId ● ID scalar

PublicOrder.customerNote ● String scalar

A note provided by the customer at time of order

PublicOrder.demandHqId ● ID! non-null scalar

PublicOrder.emailAddress ● String! non-null scalar

PublicOrder.items ● PublicOrderItemConnection! non-null object

List the items in an order.

Requires the orderitem/read permission on the associated DemandHq.

PublicOrder.items.after ● String scalar

Returns the elements in the list that come after the specified cursor.

PublicOrder.items.before ● String scalar

Returns the elements in the list that come before the specified cursor.

PublicOrder.items.first ● Int scalar

Returns the first n elements from the list.

PublicOrder.items.last ● Int scalar

Returns the last n elements from the list.

PublicOrder.note ● String scalar

PublicOrder.orderId ● ID! non-null scalar

PublicOrder.paymentId ● ID scalar

A reference to an outside payment gateway, used for tracking transactions. May be an orderID, or a paymentID.

PublicOrder.phoneNumber ● String scalar

PublicOrder.placedAt ● Date scalar

ISO Date indicated when an order should be considered complete, closed for some changes, and started to process.

PublicOrder.shippingAddress ● Address! non-null object

PublicOrder.shippingCharges ● [OrderShippingCharge] list object

PublicOrder.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

PublicOrder.storefrontId ● ID scalar

PublicOrder.tags ● OrderTags object

Get the tags of the order.

PublicOrder.transactions ● PublicOrderTransactionConnection! non-null object

List the transactions in an order.

Requires the ordertransaction/read permission on the associated DemandHq.

PublicOrder.transactions.after ● String scalar

Returns the elements in the list that come after the specified cursor.

PublicOrder.transactions.before ● String scalar

Returns the elements in the list that come before the specified cursor.

PublicOrder.transactions.first ● Int scalar

Returns the first n elements from the list.

PublicOrder.transactions.last ● Int scalar

Returns the last n elements from the list.

Returned by

order query

Member of

PublicOrderConnectionWithSearch object ● PublicOrderEdge object