A shipment describes a structure of a multimodal logistics journey. Shipments are useful when the lifetime of an asset you are tracking spans across multiple tracker devices.
A shipment consists of segments.
Devices assigned to a shipment generate traces and events for the entire shipment. The
shipmentId of a shipment can be used in similar fashion as a
trackingId in Tracking APIs (where applicable). For example, one can query shipment traces and events and associate aliases and metadata to a shipment.
A new shipment should be instantiated for each separate logistical journey. However, if the structure of the shipment is recurring, a shipment plan can be defined.
A shipment segment can have a subshipment assigned to it in place of the
trackingId, that is if the
trackingId of a segment contains a
shipmentId the segment has a subshipment. Subshipments have the following limitations:
subShipmentproperty set to
Shipments are managed via the shipments endpoint.
Shipments can also be created, managed and visualized via the Shipment Tracking web application.