This parameter is used to determine the current status of the consignment.
ConsignmentStatus statusThe status information has two fields:
The package status and the consignment status are not the same thing. Both use the same status codes on this page. The package status shows the status of one package, and the consignment status shows the status of the full consignment.
You can get the status information in two ways: from the last status fields or from the events. These two are not the same thing. The last status shows only the current status. The events show the full history of the consignment.
The current status of the consignment or the package. It is a single value and changes when the status changes.
Consignment
| Source | Status code | Status message |
|---|---|---|
| Find Consignment | data.status |
data.status_message |
| List Consignments | data[].status |
data[].status_message |
Package
| Source | Status code | Status message |
|---|---|---|
| Find Consignment | data.packages[].current_status |
data.packages[].current_status_message |
package.status.updated webhook |
data.status |
data.statusMessage |
All status records added to the consignment. Each event has its own status code, status message and date. The events show the history of the consignment step by step.
| Source | Status code | Status message | Date |
|---|---|---|---|
| Consignment Events | data[].status |
data[].statusMessage |
data[].statusDatetime |
| Find Consignment | data.details[].status |
data.details[].message |
data.details[].status_datetime |
consignment.status.updated webhook |
data.events[].status |
data.events[].statusMessage |
data.events[].statusUpdatedAt |
Track the status from the events and at the package level:
data.details[].package_id field. This method is recommended for single-package consignments too. Thus, when a package is added to the consignment later or a package is cancelled, you can track each package separately and you do not miss any event. Events with an empty (null) package_id belong to the full consignment.To get status changes instantly, you can create a webhook.
The statuses are in 2 groups: flow statuses and final statuses.
Flow statuses show where the consignment is and in which direction the process goes. For example, the package can be on the way, in a warehouse or in the return process. In these statuses, the consignment is not complete yet. Wait for a new status.
status |
status_name |
Info |
|---|---|---|
| -1 | UNDEFINED | An unknown event that is not defined by the system. Its details are in the status message. |
| 0 | NEW | The consignment was created. It is not sent to the provider yet. You can cancel the consignment in this status. |
| 1 | SENDED_TO_PROVIDER | The consignment was sent to the provider. The package may not be given to the provider yet. In this status, the cancel request is sent to the provider. If the provider rejects the cancellation, the consignment is not cancelled. |
| 2 | IN_WAREHOUSE | The package is in a warehouse or branch. |
| 3 | IN_TRANSIT | The package is on the way. |
| 7 | WAITING_APPROVE | The consignment is waiting for approval. |
| 8 | ARRIVED | The package arrived at a delivery or transit station. |
| 11 | WAITING_PAYMENT | Payment is pending. For example, customs duty. |
| 12 | PACKAGES_VERIFIED_WAITING_TO_PROCESS | The packages were verified. The provider label is pending. |
| 13 | OFFER_ACCEPTED | The offer was accepted. It is not shown in events or webhooks. |
| 14 | WAITING_TO_PROCESSED | The consignment arrived at the warehouse and is waiting to be processed. |
| 15 | OFFER_REJECTED | The offer was rejected. It is not shown in events or webhooks. |
| 16 | OFFER_EXPIRED | Offer timeout. |
| 17 | OFFER_CANCELLED | The offer was cancelled. It is not shown in events or webhooks. |
| 18 | CUSTOM_CLEARANCE | The package is in customs. |
| 19 | LOAD_DISTRIBUTION_VEHICLE | The package is in the delivery vehicle. It will be delivered to the recipient. |
| 20 | WAITING_FOR_OFFER | No suitable offer was found. Waiting for an authorized person. |
| 21 | LABEL_CREATED_FOR_DEPARTMENT | A label was created to send to the department. |
| 22 | NOT_ACCEPTED | The recipient did not accept the package. |
| 23 | CAN_NOT_DELIVERED | The package could not be delivered to the recipient. For example, the recipient was not at the address or the address is incorrect. The package can be delivered later or returned. |
| 24 | NEW_DRAFT | Draft consignment. It can be updated before it is sent to the provider. |
| 26 | PARTIAL_DELIVERY | Part of the consignment was delivered. |
| 27 | OTHER | An event that is known and defined by the system, but does not fit any other status code. Its details are in the status message. |
| 28 | TRACKING_TIMEOUT | Tracking timeout. |
| 31 | RETURN_INITIATED | The return process started. When the return is complete, the status changes to 9 (RETURNED). |
| 32 | RETURN_CANCELED | The return was cancelled. The package can be delivered to the recipient later. |
Under normal conditions, the consignment is complete in these statuses. But if an operational error or an exceptional situation occurs, the consignment can be shipped again or the last status can be cancelled. Thus, after a final status comes, continue to track the consignment for some time and verify the last status.
status |
status_name |
Info |
|---|---|---|
| 4 | DELIVERED | The package was delivered to the recipient. |
| 5 | CANCELLED | The consignment was cancelled on the provider side. |
| 6 | ABANDONED | The consignment was abandoned. |
| 9 | RETURNED | The package was delivered to the sender. |
| 10 | LOST | The provider reported the package as lost. |
| 25 | DESTROYED | The provider destroyed the package. |
| 29 | CANCELLED_BY_CUSTOMER | The ComToHome customer cancelled the consignment. |
| 30 | CANCELLED_DUE_TO_TIMEOUT | The consignment was cancelled automatically because it did not leave 1 (SENDED_TO_PROVIDER) in the set time. |
What you must know
status code to know what the event is. If the code does not give sufficient information, read the status message.The examples below are taken from real consignments. Each table shows the status of one consignment step by step. Each row is an event that changed the status of the consignment. Depending on the provider, ComToHome or the provider writes the event in step 1. Events that did not change the status are not in the tables. Real flows can be different for each provider.
The text in the "Event description" column is in the statusMessage field of the Consignment Events response. If the message is in a different language, its meaning is given in parentheses.
In this example, 3 (IN_TRANSIT) and 2 (IN_WAREHOUSE) repeated in turn many times.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Kabul Edildi (Accepted.) |
| 3 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 4 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 5 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 6 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 7 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 8 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 9 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 10 | 4DELIVERED | Teslim Edildi (Delivered.) |
After the delivery, the "Teslim Edilen Gönderi Ücreti Yatırıldı." (the fee for the delivered consignment was deposited) event came. This event comes as 27 (OTHER), and the status of the consignment changes from 4 (DELIVERED) to 27. This event does not mean that the delivery was cancelled.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Kabul Edildi (Accepted.) |
| 3 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 4 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 5 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 6 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 7 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 8 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 9 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 10 | 4DELIVERED | Teslim Edildi (Delivered.) |
| 11 | 27OTHER | Teslim Edilen Gönderi Ücreti Yatırıldı. (The fee for the delivered consignment was deposited.) |
23 (CAN_NOT_DELIVERED) is not a final status. In this example, the package was delivered to the recipient later.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Kabul Edildi (Accepted.) |
| 3 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 4 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 5 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 6 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 7 | 23CAN_NOT_DELIVERED | Köy Dağıtımına Tabi Bekliyor (Subject to village delivery, waiting.) |
| 8 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 9 | 4DELIVERED | Teslim Edildi (Delivered.) |
In this example, 3 (IN_TRANSIT), 2 (IN_WAREHOUSE) and 19 (LOAD_DISTRIBUTION_VEHICLE) came again after 31 (RETURN_INITIATED). The last status in this example was 9 (RETURNED).
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Kabul Edildi (Accepted.) |
| 3 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 4 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 5 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 6 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 7 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 8 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 9 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 10 | 23CAN_NOT_DELIVERED | Dağıtım Adreste Yok/Kapalı-Haber Kağıdı Bırakıldı (Delivery: not at the address/closed, a notice was left.) |
| 11 | 31RETURN_INITIATED | İADE-Bekleme Süresi Bitti (Return: the waiting time ended.) |
| 12 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 13 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 14 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 15 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 16 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 17 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 18 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 19 | 9RETURNED | Göndericisine Teslim Edildi (Delivered to the sender.) |
In this example, 19 (LOAD_DISTRIBUTION_VEHICLE) and 4 (DELIVERED) came after 32 (RETURN_CANCELED).
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Kabul Edildi (Accepted.) |
| 3 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 4 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 5 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 6 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 7 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 8 | 23CAN_NOT_DELIVERED | Adres Hatalı/Adres Yetersiz (Wrong address/insufficient address.) |
| 9 | 31RETURN_INITIATED | İADE-Adres Yetersiz (Return: insufficient address.) |
| 10 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 11 | 32RETURN_CANCELED | İade İptal Edildi (The return was cancelled.) |
| 12 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 13 | 4DELIVERED | Teslim Edildi (Delivered.) |
In this example, the "Teslim İptal Edildi" (delivery cancelled) event came from the provider after the consignment changed to 4 (DELIVERED). The consignment changed back to 2 (IN_WAREHOUSE) and then changed to 4 (DELIVERED) again.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Kabul Edildi (Accepted.) |
| 3 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 4 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 5 | 3IN_TRANSIT | Torbaya Eklendi (Added to a bag.) |
| 6 | 2IN_WAREHOUSE | Gönderinin Geliş Kaydı Yapıldı (The arrival of the consignment was recorded.) |
| 7 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 8 | 4DELIVERED | Teslim Edildi (Delivered.) |
| 9 | 2IN_WAREHOUSE | Teslim İptal Edildi (The delivery was cancelled.) |
| 10 | 19LOAD_DISTRIBUTION_VEHICLE | Dağıtıcıya Verildi (Given to the courier.) |
| 11 | 4DELIVERED | Teslim Edildi (Delivered.) |
Some providers send their exception notifications as 23 (CAN_NOT_DELIVERED). In this example, the "Paketiniz yola çıktı" (your package is on its way) event in step 3 also came as an exception notification. Thus, 23 does not always mean that the package could not be delivered.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 3IN_TRANSIT | Paketiniz Alındı (We Have Your Package.) |
| 3 | 23CAN_NOT_DELIVERED | Paketiniz yola çıktı (Your package is on its way. (Clearance Completed)) |
| 4 | 3IN_TRANSIT | Tesisten Ayrıldı (Departed from facility.) |
| 5 | 4DELIVERED | TESLİM EDİLDİ (Delivered.) |
In this example, the package went through 18 (CUSTOM_CLEARANCE) before the delivery.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 2IN_WAREHOUSE | Accepted |
| 3 | 3IN_TRANSIT | The item was forwarded to the destination country (Otb) |
| 4 | 18CUSTOM_CLEARANCE | Receive item at office of exchange (Inb) |
| 5 | 2IN_WAREHOUSE | Receive item at collection point for pick-up (Inb) |
| 6 | 4DELIVERED | Deliver item (Inb) |
In this example, 3 (IN_TRANSIT) and 2 (IN_WAREHOUSE) repeated at each transfer hub.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Gönderi bilgileri taşıyıcıya gönderildi (Shipment information sent to the provider.) |
| 2 | 3IN_TRANSIT | Paket alındı - Turkey/ISTANBUL (Picked up - Turkey/ISTANBUL.) |
| 3 | 2IN_WAREHOUSE | Uluslararası gönderi serbest bırakma - İhracat - Turkey/ISTANBUL (International shipment release - Export - Turkey/ISTANBUL.) |
| 4 | 3IN_TRANSIT | Yola çıktı - Turkey/ISTANBUL (On the way - Turkey/ISTANBUL.) |
| 5 | 2IN_WAREHOUSE | Taşıyıcı merkezine geldi - France/ROISSY CHARLES DE GAULLE CEDEX (Arrived at provider hub - France/ROISSY CHARLES DE GAULLE CEDEX.) |
| 6 | 3IN_TRANSIT | Yola çıktı - France/ROISSY CHARLES DE GAULLE CEDEX (On the way - France/ROISSY CHARLES DE GAULLE CEDEX.) |
| 7 | 2IN_WAREHOUSE | Taşıyıcı merkezine geldi - United States/MEMPHIS (Arrived at provider hub - United States/MEMPHIS.) |
| 8 | 3IN_TRANSIT | Yola çıktı - United States/MEMPHIS (On the way - United States/MEMPHIS.) |
| 9 | 2IN_WAREHOUSE | Varış yeri sıralama tesisinde - Canada/EDMONTON INT'L AIRPORT (At destination sort facility - Canada/EDMONTON INT'L AIRPORT.) |
| 10 | 19LOAD_DISTRIBUTION_VEHICLE | Teslimat için taşıyıcı aracında - Canada/EDMONTON (On provider vehicle for delivery - Canada/EDMONTON.) |
| 11 | 4DELIVERED | Teslim Edildi - Canada/EDMONTON (Delivered - Canada/EDMONTON.) |
In this example, 8 (ARRIVED) came each time the package arrived at a facility.
| Step | Status | Event description (statusMessage) |
|---|---|---|
| 1 | 1SENDED_TO_PROVIDER | Sevkiyat Bilgisi Hizmet Sağlayıcıya Gönderildi (The shipment data was sent to the service provider.) |
| 2 | 3IN_TRANSIT | Processed at ISTANBUL-TURKEY |
| 3 | 8ARRIVED | Arrived at provider Sort Facility LEIPZIG-GERMANY |
| 4 | 3IN_TRANSIT | Processed at LEIPZIG-GERMANY |
| 5 | 8ARRIVED | Arrived at provider Delivery Facility GEISPOLSHEIM-FRANCE |
| 6 | 19LOAD_DISTRIBUTION_VEHICLE | Shipment is out with courier for delivery |
| 7 | 4DELIVERED | Delivered |