Trackers
Statuses & Events
When the status of a shipment is updated by a provider, it will update to one of the statuses below on this list. This will also create an event which you can listen to via our webhooks.
# Tracker Statuses
Our status system provides detailed visibility into each stage of a shipment's journey. Statuses marked with an asterisk (*) indicate terminal states where no further updates are expected.
# Typical Status Progression
| Status | Description |
|---|---|
created | The package label was created |
provider_at_pickup | The provider has arrived and is waiting for your package (on demand only) |
package_accepted | Your package has been picked up |
in_transit | Your package is in transit. Expect multiple in_transit updates |
out_for_delivery | Your package is out for delivery |
provider_at_dropoff | When the shipping provider is at or close to the recipient (on demand only) |
delivered* | Your package was delivered |
# All Statuses
| Status | Description |
|---|---|
rates_generated | When shipping rates were initially generated |
created | The package label was created |
provider_at_pickup | The provider has arrived and is waiting for your package (On demand only) |
package_accepted | Your package has been picked up |
out_for_delivery | Your package is out for delivery |
provider_at_dropoff | When the shipping provider is at or close to the recipient (On demand only) |
delivered* | Your package was delivered |
address_issue | There is an issue with the address |
contact_provider | There was an issue with your package, please contact the provider |
delayed | The package delivery has been delayed |
attempted | A delivery was attempted but could not be completed |
rescheduled | The delivery for your package has been rescheduled |
scheduled | Your delivery has been scheduled |
driver_dispatched | Driver assigned and en route |
package_at_waypoint | Your package has arrived at an intermediate location in the delivery network |
in_transit | Your package is in transit |
pickup_available | Your package is available to be picked up at the provider location |
received | Your package has been received |
package_damaged | Your package has been damaged in transit |
picked_up | Your package has been picked up |
completed | Your package delivery has been completed |
destroyed | Your package has been destroyed |
recipient_at_pickup | Recipient has arrived and identity confirmed at pickup location |
return_to_sender* | Your package has been returned to the sender |
package_undeliverable* | The package is not able to be delivered |
package_lost* | The package has been lost. Contact the provider for more details |
canceled* | This delivery was canceled by the sender |
added_to_container | Your package has been added to container |
removed_from_container | Your package has been removed from container |
added_to_vehicle | Package loaded into vehicle |
removed_from_vehicle | Package unloaded from vehicle |
delivered_to_provider | Package transferred to provider |
# Tracker Events
| Event | Description |
|---|---|
tracker.created | When the tracker is created. |
tracker.updated | When the tracker is updated. |
tracker.coordinates_updated | The live location was updated in the shipment, but the status was not changed. |
tracker.deleted | When the tracker is deleted. |
tracker.shipment_chained | Multiple shipments linked. |
tracker.shipment_unchained | Multiple shipments unlinked. |
# Tracking Status Outstanding
js
enum TrackingStatusOutstanding {
provider_at_pickup
package_accepted
out_for_delivery
provider_at_dropoff
scheduled
driver_dispatched
package_at_waypoint
in_transit
pickup_available
recipient_at_pickup
added_to_container
removed_from_container
added_to_vehicle
removed_from_vehicle
delivered_to_provider
}
# Tracker Close Shipments Option
js
enum TrackerCloseShipmentsOption {
on_provider_updates // Outstanding shipments will be closed only when the provider sends a tracking update to the shipment.
on_all_updates // Outstanding shipments will be closed on any tracking update to the shipment.
off // Outstanding shipments will be ignored.
}
# Tracker Close Shipments Status
js
enum TrackerCloseShipmentsStatus {
delivered
picked_up
}