Deliveries API
Search
K

Statuses

A delivery will transition through different states during its life cycle. The meaning of these statuses are described in the table below.
When a delivery is a draft, its still without a specific status. Statuses only work for non-draft deliveries.
Delivery Status
Description
Code
State
Pending to review
A delivery is created with pick-up or drop-off missing information (contact, location) and needs review.
pending_to_review
1
Scheduled
[Legacy] Used when a delivery entered in a routing process. No longer used.
scheduled
1
Processing
A delivery is created successfully into the platform.
processing
1
Broadcasting
A delivery has been published to a driver network.
broadcasting
2
Assigned
A delivery has been assigned to a driver.
assigned
3
Confirmed to pickup
A delivery has been confirmed for a driver to be done.
confirmed_to pickup
4
Going to pickup
A driver is going to the pick-up address.
going_to_pickup
5
At pickup
A driver is in the pick-up address.
at_pickup
5
On delivery
A driver is out for delivery.
on_delivery
5
Going to dropoff
A driver is going to the drop-off address.
going_to_dropoff
6
At dropoff
A driver is in the drop-off address.
at_dropoff
6
Dropped off
A driver is waiting for delivery proof (photo, signature, recipient information).
dropped_off
6
Completed
A driver has successfully completed a delivery.
completed
7
Canceled
A delivery has been canceled.
canceled
-1
Returning
[Legacy] Used when a driver was returning to the pick-up address to return a package. No longer used.
returning
0
Going to return
A driver is going to the pick-up address to return a delivery.
going_to_return
6
At return point
A driver is in the pick-up address to return a delivery.
at_return_point
6
Returned
A driver has successfully returned a delivery.
returned
0
Not picked up
A driver has informed that a delivery has not being picked-up.
not_picked_up
1
Not picked up payable
A driver has informed that a delivery has not being picked-up, but will be payed to them.
not_picked_up_payable
0
Hold by courier
A delivery is hold by the assigned driver until a new attempt is made or it is returned to the pick-up address.
hold_by_courier
6
Hold in storage
A delivery is hold in a warehouse facility until a new attempt is made or it is returned to the pick-up address.
hold_in_storage
5