Hi-Trans Express Freight Status Webhook
This page will document the schema for freight status information pushed from Hi-Trans Express.
Contents
- 1 Contents
- 2 Authentication
- 3 Consignment Status
- 3.1 Pickup Completed
- 3.1.1 Attributes
- 3.1.2 Example
- 3.2 Delivery Completed
- 3.2.1 Attributes
- 3.2.2 Example
- 3.3 Other Status'
- 3.3.1 Attributes
- 3.3.2 Example
- 3.1 Pickup Completed
Authentication
The Freight Status webhook supports basic authentication over SSL
For HTTP Basic authentication, details can be provided as a username and password/token.
Consignment Status
Status updates can be pushed, in the form of a json document, for several different stages in the freight movement lifetime. These are listed below along with the fields included and an example of each document. All times are local to the event location. Each status setup can be turned on or off at request.
Pickup Completed
This is posted when a consignment has been picked up from the sender's address.
Attributes
consignmentNo
The unique consignment number assigned to the freight.
eventDateTime
The date and time the pickup was completed in dd-MM-yyyyTHH:mm:ss
statusID
Relates to the description of the event. See table below:
StatusID | Consignment Status | Description |
|---|---|---|
21 | Departed Sender / Pickup Complete | The fleet has complete the consignment pickup |
Example
{
"consignment": {
"consignmentNo": "TST83459009",
"eventDateTime": "04-01-2023T14:30:43",
"statusID": "21"
}
}Delivery Completed
This is posted when a consignment has been delivered to the receiver’s address. This also includes the proof of delivery (POD).
Attributes
consignmentNo
The unique consignment number assigned to the freight.
eventDateTime
The date and time the delivery was completed in dd-MM-yyyyTHH:mm:ss
statusID
Relates to the description of the event. See table below:
StatusID | Consignment Status | Description |
|---|---|---|
56 | Departed Receiver / Delivery Complete | The consignment has been delivered at the delivery location. |
deliveredPOD
The proof of delivery copy in PDF format, Base 64 encoded.
Example
{
"consignment": {
"consignmentNo": "TST83459009",
"eventDateTime": "04-01-2023T17:30:21",
"statusID": "56",
"deliveredPOD": "BASE64PDFHERE"
}
}Other Status'
The other status updates via webhook contain the same payload structure, with varying statusID values that refer to which stage the consignment note is at.
These status updates are only able to display the date of the event
Attributes
consignmentNo
The unique consignment number assigned to the freight.
eventDate
The date and time the delivery was completed in dd-MM-yyyyTHH:mm:ss
statusID
Relates to the description of the event. See table below:
StatusID | ConsignmentStatus | Description |
|---|---|---|
7 | Awaiting Pickup Allocation | The consignment is currently waiting to be allocated to a fleet for pickup |
10 | Pickup Allocated | The consignment has been allocated to a fleet for pickup |
12 | Pickup Acknowledged | The fleet has acknowledged pickup allocation for consignment |
15 | Arrived at Sender | The fleet has arrived at pickup location of consignment |
22 | Futile Pickup | The fleet was unable to pick up consignment |
25 | Unshipped | The consignment is awaiting to be placed on a linehaul truck |
40 | Manifested - Pending Arrival | The consignment has been placed on a linehaul manifest |
47 | Arrived at Receiving Depot | The consignment has arrived in the receiving depot |
50 | Delivery Allocated | The consignment has been put on-board a local truck or freight forwarder for delivery |
52 | Arrived at Receiver | The consignment has arrived at the delivery location. |
58 | Futile Delivery | The consignment was unable to be delivered to the delivery location. |
Example
{
"consignment": {
"consignmentNo": "TST83459009",
"eventDateTime": "04-01-2023T14:30:43,
"statusID": "7"
}
}