Sign in
Containers

Add/Remove Shipments

Add one or more shipments to a specific shipping container or remove the shipments from the container. With this endpoint, you can update the container's contents by adding new shipments or removing the existing ones, facilitating optimised logistics management and accurate tracking of goods within containers. <br /> <br />Note: Once the container has been manifested, the shipments cannot be added or removed.

put/v4/containers/{containerId}

Path parameters

containerIdstring required

A unique identifier assigned by the system or by you (alias) for the container to which the shipments are being added or removed. This parameter is necessary for the API to identify which container's contents need to be added or removed.

Request body

ShipmentIdsstring[] required

An array of unique identifiers for the shipments being added to or removed from the container. These IDs can be the shipment Id or tracking/barcode numbers. For consignment shipments, only consignment-level tracking/barcode numbers are permitted. <br /> <br />Note: The maximum number of shipments that can be included in a single request is 10,000, allowing for bulk management of container contents.

Mode'Add' | 'Remove'

A string specifying the mode of operation for the update. This field indicates how the shipment should be processed, such as whether to add new shipments or remove the existing ones, providing users with flexibility in managing their container effectively. <br /> <br />If the mode is Add, the system validates whether the shipment(s) being added to the container belong to the same shipping account as the container. If any shipment does not belong to the same shipping account as the container, an error is returned in the response. <br /> <br />Note: By default, this field is set to Add.

Response

The container has been successfully updated.

Changes

No recorded changes to this endpoint across all 1 revision of this API.