Page Comparison

...

For HTTP Basic authentication, details can be provided in the form of as a username and password/token.

...

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.

Consignment Created

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

Attributes

consignmentNocreatedDateTime

The unique consignment number assigned to the freight.

consignmentCreatedDate

The date the consignment note was created in our system.

Example

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

...

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.

pickupCompletedDateTime

Example

...

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 issigned to the freight.

deliveryCompletedDateTime

The date and time the delivery was completed

deliveredPOD

The proof of delivery copy in PDF format, Base 64 encoded.

Example

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

...