On this page
article
Updating shipment groups
Update an existing shipment group by adding or removing shipments, or managing its locked and unlocked state before final closure.
Overview
This endpoint is used to update an existing shipment_group.
This can be used to:
- Add additional
shipmentsto the group (as long as the10,000member limit is not exceeded); or - Remove existing
shipmentsfrom the group
The
custom_reference property for a shipment_group cannot be updated once the group has been created.Lock Shipment Group (M)
This endpoint allows the customer to prevent any further inadvertent changes to a shipment_group.
It is not a requirement that customers must use this endpoint, but it provides a convenient mechanism for preventing further changes without closing the group which is an irreversible operation.
Close Shipment Group (M)
This endpoint is used when all shipments within a shipment_group have been manifested or cancelled and the group is no longer required. The group will not be deleted but will be retained in a closed state. You may still retrieve the details of the shipment_group via the API for a period of time but will no longer be able to otherwise operate on the group.
This operation is not reversible. Once a
shipment_group has been closed it cannot be re-opened.