Skip to content

DispatchShipmentItemInput ​

Type: Input

One line on a package's packing list. It may reference a job, a component and/or an order line; all three links are optional, so an item can be free-text only.

Fields ​

NameTypeDefaultDescription
componentIdComponentIDTypeID (cmp_…) of the component being shipped. Optional; used when the shipped unit is finer-grained than a whole job.
descriptionStringFree-text description of the item as it should read on the packing list. Optional; typically used when no job/component/order-line link exists.
jobIdJobIDTypeID (job_…) of the job whose output is being shipped in this package. Optional — items may instead reference a component or order line, or be described in free text only.
orderLineIdOrderLineIDTypeID (oln_…) of the order line this item fulfils. Optional; links the physical item back to what the customer ordered.
quantityInt!Number of units of this item in the package. Must be greater than zero — otherwise the mutation returns a field error and persists nothing.

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