Appearance
DispatchShipmentPayload
Type: Object
Result of dispatching a shipment: the shipment and everything created with it, or the validation errors that stopped it.
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| errors | [FieldError!]! | 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. | ||
| items | [ShipmentItemState!] | Every created item, flattened across all packages; each carries the packageId it belongs to. Null when errors is non-empty. | ||
| packages | [ShipmentPackageState!] | The created packages, numbered 1..n in the order they were supplied. Null when errors is non-empty. | ||
| shipment | ShipmentState | The created shipment, recorded as PICKED_UP with shippedAt set to the dispatch time. Null when errors is non-empty. |