Deliveries API
Search…
Integrations
Entities to know
Upcoming
Statuses
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 ID
Description
-2
deleted
​
For deletion. It means it’s not going to be shown on the system
-1
canceled
​
For canceling. That’s going to be shown on the system
0
not_picked_up_payable
​
It’s a state for reverse logistic
0
returned
​
That means the delivery was back to the warehouse.
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
pending_to_review
​
It needs a human review.
When the system detects a problem with the delivery data when the delivery is being created
Eg. A wrong delivery address or a geolocation problem
1
processing
​
The delivery request is being processed. At this moment the delivery can be routed with more deliveries depending on the time windows.
1
not_picked_up
​
The delivery wasn’t able to be picked up But We’re going to do another attempt
​
​
1
Address doesn't exist
​
​
2
Danger zone
​
​
3
Delivery canceled by company
​
​
4
Other reason
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.
4
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
5
going_to_pickup
​
A courier is going to the pickup location
5
at_pickup
​
The courier is at the pickup location.
​
at_pickup
100
Danger zone
​
at_pickup
101
Other reason
5
on_delivery
​
The courier has picked up the item and is on route to the drop-off location. Is the in_transit
5
hold_in_storage
​
The courier creates a middle point between pickup and delivery that enables cross-docking.
5
in_transit_storage
​
The courier collects the package from one storage to be moved to another storage.
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
​
hold_by_courier
67
Danger zone
​
hold_by_courier
68
Recipient rejected package
​
hold_by_courier
69
Package damaged on route
​
hold_by_courier
70
Delivery canceled by company
​
hold_by_courier
71
Other reason
6
dropped_off
​
The courier gave the packages to the receiver.
6
going_to_return
​
Courier is going to the return the package to the warehouse
6
at_return_point
​
Courier is on the warehouse for returning the package[Next state => returned]
7
completed
​
The delivery has been successfully completed.
Reason Statuses
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]Last modified 4mo ago
Copy link