Add/Remove Shipments

put

https://api.intersoftsapient.net/v4/internationalArrivalsContainers/rm/{containerId}

Add one or more shipments to a container or remove the existing ones before the container is manifested, facilitating optimised logistics management and accurate tracking of goods within containers.

Path Params

containerId

string

required

An identifier assigned by the SAPIENT system or by you (alias), or a barcode number for the container for which the shipments are being added or removed.

Body Params

Update Container Request

ShipmentIds

array of strings

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.

Note: The maximum number of shipments that can be included in a single request is 10,000, allowing for bulk management of container contents.

ShipmentIds*

Mode

string

enum

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.

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.

Note: By default, this field is set to Add.

Allowed:

Responses

200

The container has been successfully updated.

401

Unauthorized

403

Forbidden

404

The container does not exist.

500

Internal Server Error

400Invalid request response.