TransportInstruction and TransportStatus

The entity types TransportInstruction and TransportStatus are used in creating and delivering shipments. 

TransportInstruction and TransportStatus

The actors are typically a shipper and a carrier: 

  • The shipper creates a TransportInstruction entity (using an ERP or transport administration system). Provided the IoL data sharing is setup properly, the selected carrier will be notified that a new shipment has been created by IoL using a webhook.
  • The carrier delivers the shipment and creates TransportStatus entities to report status updates along the way (such as the shipment has been picked-up, delivered, etc.). 

The creator of the TransportInstruction will be notified about new TransportStatus updates using another webhook and can update the status of the shipment in its internal systems accordingly.

The creator of the TransportInstruction becomes the data owner of the entity, and also becomes the data owner of the TransportStatus entities that the carrier creates to return status updates along the way. 

This is because the TransportStatus updates have a hard association to the TransportInstruction and belong to the TransportInstruction owned by the shipper.

If many shippers and carriers exchange TransportInstructions and TransportStatuses in a standardized way using IoL, they only need to integrate with one API and can reach all the other systems without duplicating the integration effort.

An added benefit is that data sharing can be setup to forward this data to 3rd party systems that can find or generate additional value from it, for example analytics or trust/tracking tools. 

In addition to the standardized entity properties, TransportInstruction and TransportStatus entities can also include a list of user-defined properties (name/value pairs) that extend their versatility with additional company- or project- specific data.

API Reference information is here. Also study the TransportInstruction and the TransportStatus data schemas.