Deliveries
Statuses & Events
When the status of a delivery 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.
# Delivery Statuses
All statuses marked with an asterisk imply that the delivery is completed and no further statuses 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 |
scheduled | Your delivery has been scheduled |
rescheduled | The delivery for your package has been rescheduled |
driver_dispatched | A driver has been dispatched to pickup the delivery |
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 | Indicates that the package has been received at the provider location |
recipient_at_pickup | Indicates that the recipient has arrived at the pickup location |
package_damaged | Your package has been damaged in transit |
picked_up | Your package has been picked up |
completed | Your package has been delivered |
destroyed | Your package has been destroyed |
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 | The delivery was added to a shipping container |
removed_from_container | The delivery was removed from a shipping container |
added_to_vehicle | The delivery is on a delivery vehicle |
removed_from_vehicle | The delivery is off of a delivery vehicle |
delivered_to_provider | The delivery has been handed off to the next shipping provider |
# Shipment Events
| Event | Description |
|---|---|
delivery.created | When the delivery is created successfully. |
delivery.updated | When the delivery is updated successfully. |