Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Containers

Add/Remove Shipments

Allocate shipments to a container or remove them from it before the container will be manifested.

put/v4/containers/{containerId}

Path parameters

containerIdstring required

Container Id <br />SAPIENT Container Id (assigned by SAPIENT) or Alias (assigned by you).

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.