← API reference
CANONICAL TYPE REFERENCE

DispatchShipmentItemInput

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.

Optional explicit plan allocations and dispatch credits created atomically

TypeID (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.

TypeID (cmp_…) of the component being shipped. Optional; used when the shipped unit is finer-grained than a whole job.

TypeID (oln_…) of the order line this item fulfils. Optional; links the physical item back to what the customer ordered.

Free-text description of the item as it should read on the packing list. Optional; typically used when no job/component/order-line link exists.

Number of units of this item in the package. Must be greater than zero — otherwise the mutation returns a field error and persists nothing.

View exact SDL
"""
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.
"""
input DispatchShipmentItemInput {
  """
  Optional explicit plan allocations and dispatch credits created atomically
  """
  plannedAllocations: [DispatchPlannedAllocationInput!]
  """
  TypeID (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.
  """
  jobId: JobID
  """
  TypeID (cmp_…) of the component being shipped. Optional; used when the shipped unit is finer-grained than a whole job.
  """
  componentId: ComponentID
  """
  TypeID (oln_…) of the order line this item fulfils. Optional; links the physical item back to what the customer ordered.
  """
  orderLineId: OrderLineID
  """
  Free-text description of the item as it should read on the packing list. Optional; typically used when no job/component/order-line link exists.
  """
  description: String
  """
  Number of units of this item in the package. Must be greater than zero — otherwise the mutation returns a field error and persists nothing.
  """
  quantity: Int!
}

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