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.
Status ID | Sub-Status | Reason-Status | Description |
1 | scheduled: | ​ | The delivery is scheduled for a future time. An operator can merge the delivery with others in a route, or leave the system to process it. |
1 | processing: | ​ | The delivery request is being processed. At this moment the delivery can be routed with more deliveries depending on the time windows. |
2 | broadcasting: | ​ | The delivery is broadcasted to the nearest and available courier. |
3 | assigned: | ​ | The delivery was assigned to an specific courier. Waiting for his response. If is not confirmed after a period of time the status changes to broadcasting. |
4 | confirmed_to_pickup: | ​ | A courier confirms to pick up the delivery task and is en route to the pickup location. |
5 | at_pickup: | ​ | The courier is at the pickup location. |
5 | on_delivery: | ​ | The courier has picked up the item and is on route to the drop-off location. Is the in_transit |
6 | going_to_dropoff | ​ | The courier notify which drop-off address has to go. This action will trigger the sending of tracking link. |
6 | at_dropoff | ​ | The courier is at the drop-off location. |
6 | hold_by_courier: | ​ | The items carried by the courier are in mobile warehouse until next delivery intent |
​ | hold_by_courier: | 10 | Person not authorized to receive package |
​ | hold_by_courier: | 11 | Address not found, need change |
6 | dropped_off | ​ | The courier gave the packages to the receiver. |
7 | completed: | ​ | The delivery has been successfully completed. |
-1 | canceled: | ​ | This delivery was canceled by the API client. |
-1 | not_picked_up: | ​ | The courier went to the point but didn't pickup or didn't get to the point |
​ | not_picked_up: | 1 | Address doesn't exist |
​ | not_picked_up: | 2 | Danger zone |
​ | not_picked_up: | 3 | Delivery canceled by company |
​ | not_picked_up: | 4 | Other reason |
0 | returning: | ​ | The courier is returning the delivery to the pickup location. We will calculate this if the driver confirms a return trip. |
​ | returning: | 5 | Danger zone |
​ | returning: | 6 | Recipient rejected package |
​ | returning: | 7 | Package damaged on route |
​ | returning: | 8 | Delivery canceled by company |
​ | returning: | 9 | Other reason |
0 | returned: | ​ | The courier has returned the package to the warehouse |
These are sub-statuses that specify in detail any resolution taken in the master status, this can also be attached to incidents. If you need to have custom reason statusesfor hold_by_courier, not_picked_up or returningyou can contact us at [email protected]
