🚥 Status
Along with the event's status, which is the raw event's text provided by the courier, Ship24 is automatically detecting the meaning of this status and provides a normalized and codified version of it.
This information is available using 3 fields, depending on the degree of detail you require:
- The
statusCode
which provides the codified meaning of a specific event. - The
statusCategory
which provides the codified category of a specific event. - The
statusMilestone
which provides the overall status of the shipment at the time of the event.
for example,
{
"eventId": "67a64a66-c0cd-429c-a00b-4a30499fd997",
"status": "ENTREGADO. Su envÃo está entregado.",
"occurrenceDatetime": "2023-01-09T15:11:00",
...
"statusCode": "delivery_delivered", // -> Meaning of this specific event (delivered)
"statusCategory": "delivery", // -> Category of this specific event (during "delivery" phase)
"statusMilestone": "delivered" // -> Overall status of the shipment at this time (delivered)
}
While the statusCategory
and statusCode
may be empty on non-significant events, the statusMilestone
will be provided on each and every events of a shipment. If you need a high-level status of your shipment, statusMilestone
is a great choice.
statusMilestone
​
The statusMilestone
provides an overall status of the shipment at any point in time. The field statusMilestone
is provided both at event-level (overall status of the shipment during the occurrence of the event) and at shipment-level (overall status of the shipment at the present time).
statusMilestone | Label | Description | Sample tracking number for testing |
---|---|---|---|
pending | Pending | The shipment doesn’t have events available yet or can’t be found. | SHIP24TEST2023H1M00 |
info_received | Info. Received | The shipment has been declared electronically and/or is in preparation by the shipper. | SHIP24TEST2023H1M10 |
in_transit | In Transit | The shipment has been accepted or picked up from the shipper and is on the way. | SHIP24TEST2023H1M20 |
out_for_delivery | Out for Delivery | The shipment is about to be delivered, usually the same day. | SHIP24TEST2023H1M30 |
failed_attempt | Failed Attempt | A delivery attempt was made and failed (Recipient not available, business closed, etc.) | SHIP24TEST2023H1M40 |
available_for_pickup | To Pick Up | The shipment is ready to be picked up by the receiver. (At a pickup point such as a post office, a locker, or a local business) | SHIP24TEST2023H1M50 |
delivered | Delivered | The shipment has been delivered. (Delivered at home, picked-up from a pickup point, etc.) | SHIP24TEST2023H1M60 |
exception | Exception | The shipment can’t be delivered due to issues that seems to be final (Returning, returned, lost, destroyed, etc.) | SHIP24TEST2023H1M70 |
The tracking numbers provided in Sample tracking number for testing are dummy tracking numbers that allows you to test your application on specific milestones code.
statusCode
and statusCategory
​
The statusCode
and statusCategory
provides the codified meaning of a specific event. If the event is not significant, it may not be provided.
statusCategory | statusCode | Description |
---|---|---|
data | Event related to data exchange, without physical meaning. | |
data_order_created | Delivery order created. The delivery order is electronically declared in the courier's system. | |
data_order_cancelled | Delivery order cancelled. the delivery order has been cancelled in the courier's system. | |
data_delivery_proposed | Final delivery methods and/or time slots have been proposed to the receiver and the courier is waiting for his feedback. | |
data_delivery_decided | Final delivery methods and/or time slots has been decided (by courier, sender, receiver or unknown). | |
transit | Event related to overall transit. | |
destination | Event related to the arrival at the destination country. | |
destination_arrival | Shipment arrived in the destination country. | |
customs | Event related to the customs clearance. | |
customs_received | Shipment received by/Presented to the customs. | |
customs_exception | Exception or delay during customs clearance. Additional documents/payment may be required. | |
customs_rejected | Shipment rejected by the customs. | |
customs_cleared | Shipment cleared by the customs. | |
delivery | Event related to the delivery phase. | |
delivery_available_for_pickup | Shipment available for pickup at a pick-up point or at the Post Office. | |
delivery_out_for_delivery | Shipment delivery in progress. | |
delivery_attempted | Delivery attempted and unsuccessful. Usually, the delivery will be tried again the next day or the shipment will be left at a pick-up point. | |
delivery_exception | Issue during delivery or preventing the delivery. | |
delivery_delivered | Shipment has been delivered. | |
exception | Event related to an exception/issue. | |
exception_return | Shipment undeliverable, will be or being returned. |
If you are looking for more specific statusCode
or notice any detection issue on the parcels you are tracking, don't hesitate to contact us!