Shipment related APIs

The Shipment Events API and Shipment Locations API offers functionalities for in transit trucks when moving a load.

Shipment Events API

There are many events related to a shipment that can be sent by a Carrier.

The list bellow details the events responsible to move the shipment from booked to in transit and delivered:

shipment:en-route-pickup: The first state responsible to start the haul.
shipment:check-in-pickup: Used when driver arrives at pickup facility.
shipment:check-out-pickup: Used when driver leaves the pickup facility.
shipment:check-in-delivery: Used when driver arrives at delivery facility.
shipment:check-out-delivery: Used when the driver delivers the shipment.

Carrier related events, indicate changes in the carrier, drop, etc. normally happens before the load starts to move:

shipment:carrier-updated: Used for changes on a load related to a carrier, i.e. trailer # change.
shipment:carrier-dropped: Indicates a carrier drop for a particular shipment.
shipment:driver-assigned: A carrier driver assignment.
shipment:driver-unassigned: A carrier driver unassignment.

Carrier location update, happens while the load is in transit until final delivery:

shipment:location-updated: Used to indicate the geographic coordinates of the carrier.

Shipment Locations API

This API is used to update the truck geographic location while moving a load. It is required to send the latitude, longitude, city and state, and it is recommended to send the source with the company’s name that is integrating with this API.