1. Shipments
  2. Statuses & Events

Shipments

Statuses & Events

You can update the status of a delivery using any of the statuses from the list. This will also create an event which you can listen to via our webhooks.

Shipment Statuses

All statuses marked with an asterisk imply that the shipment is completed and no further statuses are expected.

Typical Status Progression

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)
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
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
delivery_attempted A delivery was attempted but could not be completed
delivery_rescheduled The delivery for your package has been rescheduled
delivery_scheduled Your delivery has been scheduled
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

Shipment Events

Event Description
shipment.rates_generated Shipping rates were generated
shipment.purchased When the shipment is purchased successfully
shipment.tracking_updated The provider has updated the shipment's status
shipment.completed The shipment is has been either dropped off by a shipping provider or picked up by someone
shipment.expired The shipment expired. To protect on demand couriers, shipments need to be purchased within 15 minutes
shipment.canceled The shipment was canceled, usually because the sender requested a refund
shipment.error There was an issue with a shipment, such as package damage or loss
shipment.coordinates_updated The live location was updated in the shipment, but the status was not changed