🚥 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 event 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).
To test these statuses, you can use the Ship24 sample tracking numbers listed in the section below.
statusMilestone | Label | Description |
---|---|---|
pending | Pending | The shipment doesn’t have events available yet or can’t be found. |
info_received | Info. Received | The shipment has been declared electronically and/or is in preparation by the shipper. |
in_transit | In Transit | The shipment has been accepted or picked up from the shipper and is on the way. |
out_for_delivery | Out for Delivery | The shipment is about to be delivered, usually the same day. |
failed_attempt | Failed Attempt | A delivery attempt was made and failed (Recipient not available, business closed, etc.) |
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) |
delivered | Delivered | The shipment has been delivered. (Delivered at home, picked up from a pickup point, etc.) |
exception | Exception | The shipment can’t be delivered due to issues that seem to be final (Returning, returned, lost, destroyed, etc.) |
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 | Events 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. | |
transit_handover | Shipment picked-up or received by the carrier. | |
transit_origin_country_departure | Shipment departed from origin country. (in case of an international shipment) | |
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 or payment may be required. | |
customs_rejected | Shipment rejected by customs. | |
customs_cleared | Shipment cleared by 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 delivery, which usually could be solved. | |
delivery_refused | Shipment refused by the recipient. | |
delivery_delivered | Shipment has been delivered. | |
exception | Event related to an exception/issue which is usually final. | |
exception_return | Shipment undeliverable, will be or being returned. | |
exception_lost | Shipment lost by the carrier. | |
exception_discarded | Shipment destroyed by the carrier. |
If you are looking for more specific statusCode
or notice any detection issue with the shipments you are tracking, don't hesitate to contact us.
Ship24 Sample Tracking Numbers​
You can use the following tracking numbers to test the different statuses. Each sample allows you to simulate a set of events, including statuses encountered in real shipment tracking, along with all corresponding statusMilestone
updates.
You can reuse the same sample multiple times by modifying the last three characters of the sample to any three-digit combination (e.g., SHIP24_SAMPLE_DELIVERED_000
, SHIP24_SAMPLE_DELIVERED_123
, SHIP24_SAMPLE_DELIVERED_888
). This will effectively create a new Tracker, with tracking results remaining the same as the version ending with 000
. Alternatively, if you want to recreate a tracker with the exact same tracking number, you can do it by providing a unique clientTrackerId
for each new Tracker.
Desired statusMilestone | Sample Tracking Number |
---|---|
pending | SHIP24_SAMPLE_PENDING_000 |
info_received | SHIP24_SAMPLE_INFO_RECEIVED_000 |
in_transit | SHIP24_SAMPLE_IN_TRANSIT_000 |
out_for_delivery | SHIP24_SAMPLE_OUT_FOR_DELIVERY_000 |
failed_attempt | SHIP24_SAMPLE_FAILED_ATTEMPT_000 |
available_for_pickup | SHIP24_SAMPLE_AVAILABLE_FOR_PICKUP_000 |
delivered | SHIP24_SAMPLE_DELIVERED_000 |
exception | SHIP24_SAMPLE_EXCEPTION_000 |