Skip to main content

Order

No description

type Order {
  id: ID!
  platformOrderId: String!
  uid: String
  enterpriseId: String
  shopId: String
  shopName: String
  orderNumber: String
  platformId: String
  currencyCode: String
  mapped: String
  cancelled: Boolean
  shipped: Boolean
  draft: Boolean
  totalTax: Float
  totalDiscount: Float
  totalPrice: Float
  shippingCost: Float
  grandTotal: Float
  createdAt: Timestamp
  updatedAt: Timestamp
  customerEmail: String
  dueDate: Timestamp
  fulfillment: String
  shippingAddress: Address
  orderItems: [OrderItem!]
  shippingOptions: ShippingOptions
  shippingLabel: ShippingLabel
  cost: OrderCost
  payout: OrderPayout
  shipments: [Shipment!]
  status: String
  statusTags: [String]
}

Fields​

Order.id ● ID! non-null scalar​

Order.platformOrderId ● String! non-null scalar​

Order.uid ● String scalar​

Order.enterpriseId ● String scalar​

Order.shopId ● String scalar​

Order.shopName ● String scalar​

Order.orderNumber ● String scalar​

Order.platformId ● String scalar​

Order.currencyCode ● String scalar​

Order.mapped ● String scalar​

Order.cancelled ● Boolean scalar​

Order.shipped ● Boolean scalar​

Order.draft ● Boolean scalar​

Order.totalTax ● Float scalar​

Order.totalDiscount ● Float scalar​

Order.totalPrice ● Float scalar​

Order.shippingCost ● Float scalar​

Order.grandTotal ● Float scalar​

Order.createdAt ● Timestamp object​

Order.updatedAt ● Timestamp object​

Order.customerEmail ● String scalar​

Customer email. Same address as the order email.

Order.dueDate ● Timestamp object​

Production due date. The order email prints this timestamp as a calendar date.

Order.fulfillment ● String scalar​

How the finished order is handed off: "pickup" or "shipping".

Order.shippingAddress ● Address object​

Order.orderItems ● [OrderItem!] list object​

Order.shippingOptions ● ShippingOptions object​

Order.shippingLabel ● ShippingLabel object​

Prepaid label submitted at create, if any.

Order.cost ● OrderCost object​

Order.payout ● OrderPayout object​

Card fee, Riverr fee, the amount paid to this account, and the bank deposit that payment settled into. Null until the customer's payment has been split. A new order can exist before that split — read the order again if this is null. netPaid already includes this account's share of product, shipping, and tax, minus stripeFee and riverrFee.

Order.shipments ● [Shipment!] list object​

All shipments for this order (every parcel for split shipments).

Order.status ● String scalar​

Coarse, normalized lifecycle status derived server-side from the order's stored flags: one of "production" | "unsynced" | "shipped" | "cancelled". Mirrors the normalization Riverr's internal search index uses. Precedence (last match wins): cancelled > shipped > unsynced (not fully mapped) > production (default). For finer pipeline state read statusTags.

Order.statusTags ● [String] list scalar​

Fine-grained lifecycle tags stored on the order (e.g. "pre-production", "in-production", "routed", "partially-shipped", "shipped", "cancelled", "draft"). Typed as a list for forward-compatibility; internal-only tags are filtered out. Empty until the mapping/production pipeline has run.

Returned By​

createOrder mutation ● createOrderFromGtin mutation ● getOrder query ● getOrders query ● updateOrder mutation