Hi-Trans Express Freight Status Webhook

This page will document the schema for freight status information pushed from Hi-Trans Express.

Contents

Authentication

The Freight Status webhook supports basic authentication over SSL

For HTTP Basic authentication, details can be provided in the form of 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.

Consignment Created

This is posted when a consignment is created under a customer account within our software, either by import or manual creation.

Attributes

consignmentNo

createdDateTime

Example

{
  "consignment": {
    "consignmentNo": "ARXC83459009",
    "consignmentCreatedDate": "04-01-2023"
  }
}

Pickup Completed

This is posted when a consignment has been picked up from the sender's address.

Attributes

consignmentNo

pickupCompletedDateTime

Example

{
  "consignment": {
    "consignmentNo": "ARXC83459009",
    "pickupCompleteDateTime": "04-01-2023 14:30"
  }
}

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

deliveryCompletedDateTime

deliveredPOD

Example

{
  "consignment": {
    "consignmentNo": "ARXC83459009",
    "deliveryCompletedDateTime": "04-01-2023 17:30"
    "deliveredPOD": "BASE64PDFHERE"
  }
}