DispatchShipmentInput

"""
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.
"""
input DispatchShipmentInput {
  """
  Opt-in destination and schedule check; conflicting or unknown compatibility rejects the atomic dispatch
  """
  requireCompatibility: Boolean
  """
  Physical destination snapshot without creating an owned address; if both destinations are supplied they must agree for selected compatibility
  """
  destinationSnapshot: DeliveryAddressSnapshotInput
  """
  Optional exact-version prerequisites assessed inside dispatch; omission preserves existing callers
  """
  requirementChecks: [DispatchRequirementCheckInput!]
  """
  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.
  """
  orderId: OrderID
  """
  TypeID (car_…) of the carrier handling the shipment. Optional — omit for customer collection or an own-vehicle delivery.
  """
  carrierId: CarrierID
  """TypeID (adr_…) of the destination address. Optional."""
  shippingAddressId: AddressID
  """
  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.
  """
  shipmentNumber: String
  """
  Carrier tracking number for the shipment as a whole. Optional; packages may additionally carry their own tracking numbers.
  """
  trackingNumber: String
  """
  Freight cost charged for this shipment, expressed in `currency`. Optional.
  """
  shippingCost: Float
  """
  ISO 4217 currency code that `shippingCost` is denominated in. Optional; meaningless without a shipping cost.
  """
  currency: CurrencyISO
  """
  Free-text notes about the dispatch (handling instructions, exceptions). Optional.
  """
  notes: String
  """
  Parcels to dispatch, each with its own packing list. At least one package is required; the count becomes the shipment's totalPackages.
  """
  packages: [DispatchShipmentPackageInput!]!
}