This parameter is used to determine the current status of the consignment.
ConsignmentStatus statusConsignment statuses indicate which stage the shipment is at. You can track the process using the main status codes below.
Providers may return intermediate statuses that are not in the main list. You can ignore these values or record them for tracking and reporting purposes.
Statuses may vary depending on the integration method. Always rely on the status and status_name values in the API response for the current list.
status |
status_name |
Info |
|---|---|---|
| 0 | NEW | Consignment has been created. |
| 1 | SENDED_TO_PROVIDER | Consignment has been sent to the carrier. |
| 3 | IN_TRANSIT | Consignment is in transit. |
| 4 | DELIVERED | Consignment has been delivered. |
| 5 | CANCELLED | Consignment has been cancelled. |
| 9 | RETURNED | Returned to the sender. |
| 10 | LOST | Consignment is lost. |
| 23 | CAN_NOT_DELIVERED | Consignment could not be delivered. |
| 24 | NEW_DRAFT | Draft consignment. |
| 26 | PARTIAL_DELIVERY | Partial delivery, some of the consignment packages have been delivered. |
| 29 | CANCELLED_BY_CUSTOMER | Consignment has been cancelled by the customer. |
| 30 | CANCELLED_DUE_TO_TIMEOUT | Cancelled due to timeout. |
status |
status_name |
Info |
|---|---|---|
| -1 | UNDEFINED | Non-standard status. |
| 2 | IN_WAREHOUSE | Consignment is in the warehouse. |
| 6 | ABANDONED | Consignment has been abandoned. |
| 7 | WAITING_APPROVE | Consignment is waiting for approval. |
| 8 | ARRIVED | Consignment has arrived at the delivery station or a transit station. |
| 11 | WAITING_PAYMENT | Waiting for payment. |
| 12 | PACKAGES_VERIFIED_WAITING_TO_PROCESS | Packages verified, waiting for the service provider label to be created. |
| 14 | WAITING_TO_PROCESSED | Shipment has arrived at the warehouse, waiting to be processed. |
| 13 | OFFER_ACCEPTED | Offer accepted, operations will be carried out depending on the customer's payment type. |
| 15 | OFFER_REJECTED | Offer rejected. |
| 16 | OFFER_EXPIRED | Offer expired. |
| 17 | OFFER_CANCELLED | Offer cancelled. |
| 18 | CUSTOM_CLEARANCE | In customs. |
| 19 | LOAD_DISTRIBUTION_VEHICLE | Consignment is on the distribution vehicle. |
| 20 | WAITING_FOR_OFFER | No offer matching the selected preferences was found, waiting for operator intervention. |
| 21 | LABEL_CREATED_FOR_DEPARTMENT | Label created to be forwarded to the department. |
| 22 | NOT_ACCEPTED | Consignment was not accepted. |
| 25 | DESTROYED | Consignment has been destroyed. |
| 28 | TRACKING_TIMEOUT | Tracking timeout. |
| 31 | RETURN_INITIATED | Return to sender in progress. |
| 32 | RETURN_CANCELED | Return to sender has been cancelled. |
| 27 | OTHER | Other. |