← API reference
CANONICAL TYPE REFERENCE

DispatchShipmentPayload

Result of dispatching a shipment: the shipment and everything created with it, or the validation errors that stopped it.

The created shipment, recorded as PICKED_UP with shippedAt set to the dispatch time. Null when errors is non-empty.

The created packages, numbered 1..n in the order they were supplied. Null when errors is non-empty.

Every created item, flattened across all packages; each carries the packageId it belongs to. Null when errors is non-empty.

Per-field validation errors, paths indexed into the input (e.g. "packages[0].items[1].quantity"). Empty on success; when non-empty nothing was written and the other fields are null.

View exact SDL
"""
Result of dispatching a shipment: the shipment and everything created with it, or the validation errors that stopped it.
"""
type DispatchShipmentPayload {
  """
  The created shipment, recorded as PICKED_UP with shippedAt set to the dispatch time. Null when `errors` is non-empty.
  """
  shipment: ShipmentState
  """
  The created packages, numbered 1..n in the order they were supplied. Null when `errors` is non-empty.
  """
  packages: [ShipmentPackageState!]
  """
  Every created item, flattened across all packages; each carries the packageId it belongs to. Null when `errors` is non-empty.
  """
  items: [ShipmentItemState!]
  """
  Per-field validation errors, paths indexed into the input (e.g. "packages[0].items[1].quantity"). Empty on success; when non-empty nothing was written and the other fields are null.
  """
  errors: [FieldError!]!
}

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