Shipments
Statuses & Events
You can update the status of a shipment 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) |
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 shipment |
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 shipment was added to a shipping container |
removed_from_container | The shipment was removed from a shipping container |
added_to_vehicle | The shipment is on a delivery vehicle |
removed_from_vehicle | The shipment is off of a delivery vehicle |
delivered_to_provider | The shipment has been handed off to the next shipping provider |
# Shipment Refund Statuses
| Status | Description |
|---|---|
requested | A refund has been requested but not yet processed |
refunded | The refund has been processed and funds have been returned |
rejected | The refund request was denied |
# Shipment Tags
| Tag | Description |
|---|---|
oversize | Indicates that the shipment exceeds standard size limits. |
fragile | Signifies that the shipment contains delicate items that require careful handling. |
perishable | Denotes that the shipment contains items that may spoil or degrade over time, requiring timely delivery. |
dry_cleaning | Indicates that the shipment includes items that require dry cleaning services. |
lithium | Signifies that the shipment contains lithium batteries, which may have specific shipping regulations. |
alcohol | Indicates that the shipment contains alcoholic beverages, subject to legal shipping restrictions. |
cannabis | Denotes that the shipment includes cannabis products, which may be regulated based on jurisdiction. |
confidential | Signifies that the contents of the shipment are sensitive or private and should be handled with discretion. |
express_priority | Indicates that the shipment is prioritized for expedited delivery. |
security_concern | Denotes that the shipment is subject to additional security measures due to its contents or destination. |
cold_storage | Indicates that the shipment requires temperature-controlled storage during transit. |
high_value | Signifies that the shipment contains high-value items that may require special handling or insurance. |
requires_equipment | Indicates that special equipment is needed for the handling or transportation of the shipment. |
# Shipment Events
| Event | Description |
|---|---|
shipment.shipment__rates_generated | Shipping rates were generated |
shipment.shipment__created | When the shipment is created successfully |
shipment.shipment__purchased | When the shipment is purchased successfully |
shipment.shipment__updated | When the shipment is updated successfully |
shipment.shipment__refunded | The shipment was successfully refunded. |
shipment.shipment__expired | The shipment expired. To protect on demand couriers, shipments need to be purchased within 15 minutes |