Skip to content

DispatchShipmentPackageInput ​

Type: Input

A physical parcel to dispatch, with its packing list. Packages are numbered 1..n in the order given — the server assigns packageNumber, it is not supplied here.

Fields ​

NameTypeDefaultDescription
heightFloatPackage height. Optional; unit is a tenant convention, not enforced.
items[DispatchShipmentItemInput!]!Packing list for this package. At least one item is required; an empty list fails the whole dispatch with a field error.
lengthFloatPackage length. Optional; unit is a tenant convention, not enforced.
packagingTypeStringFree-text packaging descriptor (e.g. carton, pallet, tube). Optional and not validated against a fixed list.
trackingNumberStringCarrier tracking number for this individual package, when the carrier issues one per parcel. Independent of the shipment-level tracking number.
weightFloatGross weight of the package. Optional; the unit is a tenant convention — the server neither validates nor converts it. Package weights are summed into the shipment's totalWeight (null when no package carries a weight).
widthFloatPackage width. Optional; unit is a tenant convention, not enforced.

Connect machines, automate workflows, and build custom apps for print production.