Appendix
Event Types
Event Type | Description | Additional Element Requirements* |
---|---|---|
ARRIVED_AT_STOP |
The vehicle transporting the shipment has arrived at a stop. The address on the event is the arrived stop address. | Location city, state, postal code, country. |
AVAILABLE_FOR_PICKUP |
The shipment is ready for pickup. | Location city, state, postal code, country recommended. |
CANCELLED |
Shipment tracking has been cancelled. | |
DELAYED |
The progress of the shipment's transit has been delayed. | |
DELIVERED |
The shipment has been delivered. | |
DELIVERY_MISSED |
A delivery was attempted but unable to be completed. | |
DEPARTED_STOP |
The vehicle transporting the shipment has departed a stop. The address on the event is the departed stop address. | Location city, state, postal code, country. |
ETA |
The estimated arrival time of the shipment to the final destination. | Estimated time of arrival. |
EXCEPTION |
A problem with the shipment has occurred. | Location city, state, postal code, country recommended. |
HELD |
The shipment is being held by the carrier. | |
LOADED_FOR_DELIVERY |
The shipment has been loaded onto the vehicle for delivery. | Location city, state, postal code, country recommended. |
OUT_FOR_DELIVERY |
The shipment is out for delivery. | Location city, state, postal code, country. |
PICKED_UP |
The shipment has been picked up. | Location city, state, postal code, country recommended. |
POSITION_UPDATE |
The update is reporting the current location of the shipment. | Required. |
RETURN_TO_SENDER |
||
SHIPMENT_CREATED |
The shipment has been created. | |
SHIPMENT_RECEIVED |
The shipment has been received. |
*beyond the Carrier ID, shipment ID, timestamp, and Event Type requirements