Last updated

Delete a Shipment

Delete an Ocean shipment to stop tracking the shipment in Project44's and delete its record in Movement.

Requirements

Have the following information:

  • Master Shipment ID (this is the id returned in the 200 OK response during shipment creation).

Workflow

Complete these steps:

  1. Prepare a DELETE request to /api/v4/shipments/{shipmentId}/tracking.
  2. Replace {shipmentId} with the actual Master Shipment ID.
    Example:
    DELETE /api/v4/shipments/93294f58-f87a-48e0-9f68-7d3f6e0aaa2f/tracking
  3. Submit the request.

Expected Response

The request is successfully submitted and confirmed when a 204 No Content response is received.

Delete a related container shipment

To delete a related container shipment that was created as part of a BOOKING_NUMBER or BILL_OF_LADING shipment, first get the shipment ID of the related container shipment from the relatedShipments array in the 200 OK response of a GET request to /api/v4/shipments/{shipmentId}/tracking for the parent BOOKING_NUMBER or BILL_OF_LADING shipment.

After retrieving the required shipment ID, follow the same deletion workflow described above to remove the related container shipment. Once deleted, the container shipment will no longer be tracked in Project44 and its record will be removed from Movement. The parent BOOKING_NUMBER or BILL_OF_LADING shipment will continue to be tracked in Project44, but the deleted container shipments will no longer be included in the tracking data.

Additionally, the identifiers of deleted containers will appear in the exclusionList of the Shipment Plan for the BOOKING_NUMBER or BILL_OF_LADING shipment. You can confirm this by making another GET request to /api/v4/shipments/{shipmentId}/tracking with the parent BOOKING_NUMBER or BILL_OF_LADING shipment ID and checking the exclusionList.

The parent shipment tracking data will look like below. Please note that this is not the full response, but only the relevant part showing the exclusionList in the Shipment Plan.

{
    "id": "53294f58-f87a-48e0-9f68-7d3f6e0aaa3f",
    "identifiers":[
        {
            "type": "BOOKING_NUMBER",
            "value": "MEDUAB12345"
        },
        {
            "type": "CARRIER_SCAC",
            "value": "MSCU"
        }
    ],
    "plan":
    {
        "exclusions": [
            {
                "type": "CONTAINER_ID",
                "value": "CON12345645"
            },
            {
                "type": "CARRIER_SCAC",
                "value": "MSCU"
            }
        ]
    }
}

Errors

  • 400 Invalid request
  • 401 Invalid or missing credentials
  • 403 User not authorized to perform this operation
  • 404 Not Found
  • 409 Conflict - This error occurs when a BOOKING_NUMBER or BILL_OF_LADING shipment cannot be deleted due to the presence of related container shipments that must be deleted first. The Master Shipment ID of these related containers can be found as id in the relatedShipments array in the GET requests for the BOOKING_NUMBER or BILL_OF_LADING shipment at /api/v4/shipments/{shipmentId}/tracking.
    To resolve this, you need to delete the related container shipments first using the DELETE API, one by one, as outlined in the workflow steps. Once all related container shipments are deleted, you can proceed to delete the BOOKING_NUMBER or BILL_OF_LADING shipment.

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Please refer to our Shipment Schema for more information on all fields and objects.