Deleting & Cancelling Consignments

Overview

This guide explains how to delete or cancel consignments in different states through the MachShip interface or the API.

Pending Consignments

Pending consignments can be deleted at any time. When a pending consignment is converted into an unmanifested consignment, the originating pending consignment/s are deleted automatically.

To delete pending consignments:

POST https://live.machship.com/apiv2/pendingConsignments/deletePendingConsignments

Request body (array of pending consignment IDs):

[
  0
]

Unmanifested Consignments

A consignment that is unmanifested can be deleted via the MachShip UI or the API.

To delete unmanifested consignments:

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

Request body (array of consignment IDs):

[
  0
]

Manifested Consignments

Once a consignment has been manifested, and the carrier has been notified, it cannot be deleted or cancelled via MachShip.

To cancel this consignment with the carrier you would need to contact the carrier directly.

Broker and enterprise level users with specific permissions are able to change the status of the consignment to cancelled via the UI and API - but this will not notify the carrier.

To change a consignment's status to cancelled:

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

Request body:

[
  {
    "consignmentId": 0,
    "status": 10, // cancelled status
    "statusDateTimeLocal": "2025-03-25T00:07:42.023Z",
    "itemReference": "string",
    "extraInformation": "string"
  }
]