Content in this article:
-
Shipment status information
- 1.1 Shipment vs package level
- 1.2 Status codes
- 1.3 Change rate -
Status feedback request and response
- 2.1 Status feedback request
- 2.2 Status feedback response
- 2.3 Response example
1. Shipment status information
Many carriers can send status feedback regarding your shipments. This feedback is processed in Transsmart and available for your application to retrieve it. The information consists not only of the actual status of the shipment but could also contain additional information like who accepted the package, the timestamp of the drop, etc.
1.1 Shipment vs package level
Statuses are available both on the shipment and package levels. When you have a shipment with multiple packages, each package will have its own unique status. For instance, a shipment with 2 packages of which one has already been delivered will contain this status information:
Shipment : TRNS
Package 1 : DONE
Package 2 : TRNS
1.2 Status codes
Transsmart uses a predefined list of status codes. The feedback from the carrier contains carrier-specific status codes. These are mapped to the Transsmart status codes.
| Code | Description |
| NEW | The shipment is made, but not yet registered at the carrier. |
| BOOK | The shipment is booked and registered at the carrier. |
| LABL | The label/labels of the shipment are printed |
| MANI | The shipment is registered at the carrier (only with manifesting carriers). |
| ACCEP | The shipment is accepted by the carrier. |
| ERR/REFU | The shipment has not been booked. An error has occurred. You will receive an error message. |
| TRNS | The shipment is in transit with the carrier. |
| DONE | The shipment is delivered and confirmed by the carrier. |
| APOD | Automatic Proof of Delivery. This status is given after a certain period to shipments from which we don’t receive carrier status feedback. |
| DEL | The shipment is deleted. If necessary, your pick-up request at the carrier will also be canceled. |
| UNKNOWN | The shipment has received a status code from the carrier that we did not recognize. This code is temporary. |
| ONHOLD | This status is either set automatically by Transsmart after printing per configuration or manually set by the customer. |
1.3 Change rate
Each carrier has a different schedule for sending status feedback to Transsmart. Some carriers use a 15-minute update interval, others send an update only twice per day. We recommend retrieving the current status of a shipment via Transsmart every hour or two.
2 Status feedback request and response
2.1 Status feedback request
The status feedback request has to be done at: v2/statuses/
There are several mandatory parameters in this call. They are explained in the table below.
| Parameter | Description |
| account | The accountID of the account of which you want to receive the status |
| reference | The reference of the shipment of which you want a status update. |
| isDetailed | True (for a detailed status overview including carrier statuses) or false (for only the Transsmart status) |
| currentStatusOnly | True (only the current shipment status) or false (for complete status history) |
2.2 Status feedback response
In the status response, you will first receive a shipment status based on the shipment AWB. Per shipment line, you will also receive a status. This is the status of the corresponding package. In addition to the package's AWB and Transsmart status, you will also receive information about the carrier status, carrier status description, and the date/time when the status was last updated. Of course, the carrier status will only be given when available and after the information is transferred to the carrier.
2.3 Response example
An example response can be found in the technical documentation. This response consists of a status per package/ AWB in the shipment.