Manifest consignments

​​

 

​

This API is to create a new manifest.

​

POST /v6-api/rest/manifests

​

Request payload example below:

​

{

"manifestDate": "2025-10-20",

"departureDate": "2025-10-20",

"departureTime": "12:00",

"estimatedArrivalDate": "2025-10-20",

"estimatedArrivalTime": "12:00",

"fullLoadCategory": "MC",

"halfLoadCategory": "LC",

"fromLocationCode": "TOOWONG",

"fromLocationSuburb": "TOOWONG",

"fromLocationPostcode": "4066",

"fromLocationState": "QLD",

"toLocationCode": "CASTLEH",

"toLocationSuburb": "CASTLE HILL",

"toLocationPostcode": "2154",

"toLocationState": "NSW",

"agent": "APT",

"carrier" : "22",

"vehicle" : "22",

"driver" : "22",

"fromDepot": "QLDD",

"toDepot": "NSWD",

"tripNo": "J8943",

"description": "overnight run",

"manifestedConsignments": ["C28256,C28257,C28258"]

}

​

​

Example response payload:

{"manifestId":12345,"manifestNo":"M12345"}

​

​​

​

​

This API is to update a manifest

​​​​​

PATCH /v6-api/rest/manifests

Request payload example below:

​​​

{

"manifestNo": "M12599",

"estimatedLoadTime": "2026-03-27 16:00",

"actualLoadTime": "2026-03-27 16:30",

"estimatedDepartureTime": "2026-03-28 06:30",

"actualDepartureTime": "2026-03-28 07:00",

"estimatedArrivalTime": "2026-03-28 17:00",

"actualArrivalTime": "2026-03-28 17:30",

"agentInvoiceNumber" :"ABC1234",

"tripNo" :"50234",

"stage" :"PIC"

}

​​​

Available stages:

NEW: new manifest

ALO: allocated

ACC: accepted

PIC: picked up by driver

POP: in-transit

DEL : on board for delivery

POD: final delivery

​

​

​

​

​

​

This API is to manifest a list of consignments (to confirm the consignments are ready for despatch)

​​​​

POST /v6-api/rest/manifests/manifestConsignments

Request payload: array of connote reference number as below example:

​

{ "connoteNos":["A","b","c"],"manifestNo":"M123456"}

​

Note : If manifestNo is not supplied then a new manifest is created.

Example response payload:

{"manifestId":1111,"manifestNo":"M12345"}

​​​