DispatchShipmentInput

Type: Input

Everything needed to dispatch a shipment in one call: the shipment header, its packages, and each package's items. All-or-nothing — validation failures persist nothing.

Fields

Name	Type	Default	Description
carrierId	CarrierID		TypeID (car_…) of the carrier handling the shipment. Optional — omit for customer collection or an own-vehicle delivery.
currency	CurrencyISO		ISO 4217 currency code that shippingCost is denominated in. Optional; meaningless without a shipping cost.
notes	String		Free-text notes about the dispatch (handling instructions, exceptions). Optional.
orderId	OrderID		TypeID (ord_…) of the order being shipped against. Optional. When given and the order is CONFIRMED or IN_PRODUCTION, dispatching advances it to PARTIALLY_SHIPPED in the same transaction; other statuses are left alone.
packages	[DispatchShipmentPackageInput!]!		Parcels to dispatch, each with its own packing list. At least one package is required; the count becomes the shipment's totalPackages.
shipmentNumber	String		Human-readable reference for the shipment (e.g. a delivery-note number). Supplied by the caller — the server does not generate one — and not enforced to be unique.
shippingAddressId	AddressID		TypeID (adr_…) of the destination address. Optional.
shippingCost	Float		Freight cost charged for this shipment, expressed in currency. Optional.
trackingNumber	String		Carrier tracking number for the shipment as a whole. Optional; packages may additionally carry their own tracking numbers.