Changing Consignment Status Via API

• Overview
• Limitations
• Via The API

Overview

MachShip provides the ability to manually update consignment statuses through the API. A "manual" status is one that is not triggered from an external carrier's system but rather one that has come to MachShip from its own API, or the interface.

Limitations

There are several important limitations to consider when updating consignment statuses:

1. Only manifested consignments can be updated, not unmanifested.
2. Only brokers OR enterprise clients can perform status updates - broker clients and their API keys cannot
3. Status date/time cannot be in the future (the timezone used is based on the location):
   • For completed statuses, the 'to' location timezone is used
   • For other statuses, the 'from' location timezone is used
4. Cannot change a consignment back to unmanifested status

Via The API

To update consignment statuses, use the following endpoint:

POST https://live.machship.com/apiv2/consignments/updateConsignmentStatuses

Request Body

{
  "consignmentId": 123456,
  "status": 5,
  "statusDateTimeLocal": "2025-02-18T11:00:00",
  "itemReference": "ITEM001",
  "extraInformation": "Delayed due to weather conditions"
}

Field Descriptions

Status Codes