Deliveries
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.
All statuses marked with an asterisk imply that the shipment is completed and no further statuses are expected.
| Status | Description |
|---|---|
created | The package label was created |
provider_at_pickup | The provider has arrived and is waiting for your package (on demand only) |
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 |
| Status | Description |
|---|---|
rates_generated | When shipping rates were initially generated |
created | The package label was created |
address_issue | There is an issue with the address |
provider_at_pickup | The provider has arrived and is waiting for your package (On demand only) |
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 |
out_for_delivery | Your package is out for delivery |
package_accepted | Your package has been picked up |
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 |
provider_at_dropoff | When the shipping provider is at or close to the recipient (On demand only) |
package_damaged | Your package has been damaged in transit |
delivered* | Your package was delivered |
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 |
| Event | Description |
|---|---|
delivery.created | When the delivery is created |
delivery.tracking_updated | When you have updated the status to an intermediate status that is not completed. |
delivery.completed | The shipment is has been either dropped off by a shipping provider or picked up by someone |
delivery.canceled | The shipment was canceled, usually because the sender requested a refund |
delivery.coordinates_updated | The live location was updated in the shipment, but the status was not changed |