← API reference
CANONICAL TYPE REFERENCE

OrderLifecyclePayload

Everything hanging off a single order — the order itself, its lines, the estimate it came from, and the invoices, shipments and production jobs it produced — gathered in one round trip.

The requested order. Null only when no order with that id exists in the caller's tenant, in which case errors explains why.

All lines on the order, in the order's own display order (sortOrder ascending). Empty when the order was not found.

The estimate the order was converted from, if the order carries an estimateId. Null for orders raised directly, and when the order was not found.

Lines of estimate, in sortOrder ascending. Empty when the order has no linked estimate — never populated independently of estimate.

Every invoice raised against the order, including credit notes. Empty until the order is first invoiced.

Every shipment raised against the order, dispatched or not. Empty until the order is first shipped.

Production jobs reached through the order's lines (each line may carry a jobId); deduplicated. Empty when no line has been put into production.

Field-level lookup errors; empty on success. Carries orderId: order not found when no such order exists for the tenant.

View exact SDL
"""
Everything hanging off a single order — the order itself, its lines, the estimate it came from, and the invoices, shipments and production jobs it produced — gathered in one round trip.
"""
type OrderLifecyclePayload {
  """
  The requested order. Null only when no order with that id exists in the caller's tenant, in which case `errors` explains why.
  """
  order: OrderState
  """
  All lines on the order, in the order's own display order (sortOrder ascending). Empty when the order was not found.
  """
  orderLines: [OrderLineState!]!
  """
  The estimate the order was converted from, if the order carries an estimateId. Null for orders raised directly, and when the order was not found.
  """
  estimate: EstimateState
  """
  Lines of `estimate`, in sortOrder ascending. Empty when the order has no linked estimate — never populated independently of `estimate`.
  """
  estimateLines: [EstimateLineState!]!
  """
  Every invoice raised against the order, including credit notes. Empty until the order is first invoiced.
  """
  invoices: [InvoiceState!]!
  """
  Every shipment raised against the order, dispatched or not. Empty until the order is first shipped.
  """
  shipments: [ShipmentState!]!
  """
  Production jobs reached through the order's lines (each line may carry a jobId); deduplicated. Empty when no line has been put into production.
  """
  jobs: [JobState!]!
  """
  Field-level lookup errors; empty on success. Carries `orderId: order not found` when no such order exists for the tenant.
  """
  errors: [FieldError!]!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.