← All types
Materials & logisticsIn Input object

UpdateShipmentTrackingInput

A carrier tracking update for an existing shipment: the new status plus any tracking details. Omitted optional fields are left as they are, never cleared.

Fields

TypeID (shp_…) of the shipment to update. Must belong to the caller's tenant, otherwise a "shipment not found" field error is returned.

Target shipment status. Rejected with a field error unless the shipment's current status allows the transition (e.g. PICKED_UP may only go to IN_TRANSIT; RETURNED and CANCELLED are terminal).

Possible values (9)
DRAFT

Draft shipment

READY_FOR_PICKUP

Ready for carrier pickup

PICKED_UP

Picked up by carrier

IN_TRANSIT

In transit

OUT_FOR_DELIVERY

Out for delivery

DELIVERED

Delivered

FAILED_DELIVERY

Delivery failed

RETURNED

Returned

CANCELLED

Cancelled

New carrier tracking number. Null leaves the existing value untouched — this mutation cannot clear a tracking number.

New carrier tracking URL. Null leaves the existing value untouched.

Revised delivery estimate as an ISO 8601 timestamp with fractional seconds. When supplied but unparseable, the stored estimate is cleared.

Actual delivery time as an ISO 8601 timestamp with fractional seconds. Only applied when status is DELIVERED, and defaults to now if omitted or unparseable.

notes

StringOptional

New free-text notes on the shipment. Null leaves the existing notes untouched — notes cannot be cleared here.

Referenced by (1)
Exact type SDL
"""
A carrier tracking update for an existing shipment: the new status plus any tracking details. Omitted optional fields are left as they are, never cleared.
"""
input UpdateShipmentTrackingInput {
  """
  TypeID (shp_…) of the shipment to update. Must belong to the caller's tenant, otherwise a "shipment not found" field error is returned.
  """
  shipmentId: ShipmentID!
  """
  Target shipment status. Rejected with a field error unless the shipment's current status allows the transition (e.g. PICKED_UP may only go to IN_TRANSIT; RETURNED and CANCELLED are terminal).
  """
  status: ShipmentStatus!
  """
  New carrier tracking number. Null leaves the existing value untouched — this mutation cannot clear a tracking number.
  """
  trackingNumber: String
  """New carrier tracking URL. Null leaves the existing value untouched."""
  trackingUrl: String
  """
  Revised delivery estimate as an ISO 8601 timestamp with fractional seconds. When supplied but unparseable, the stored estimate is cleared.
  """
  estimatedDeliveryAt: String
  """
  Actual delivery time as an ISO 8601 timestamp with fractional seconds. Only applied when `status` is DELIVERED, and defaults to now if omitted or unparseable.
  """
  deliveredAt: String
  """
  New free-text notes on the shipment. Null leaves the existing notes untouched — notes cannot be cleared here.
  """
  notes: String
}