Closing Shipment Groups
This page explains how to close shipment groups so that no further changes can be made to them.
Overview
The Close Shipment Group endpoint permanently closes a specified shipment group. It is intended to be used when all shipments within a group have been either manifested or cancelled and the group is no longer required.
Closed groups cannot be edited.
Caution
Once closed, shipment groups cannot be re-opened. If you want to prevent a shipment group from being edited but may still need to make changes to it later, use the Lock Shipment Group endpoint.
For more information on locking shipment groups, see the Locking and Unlocking Shipment Groups section of the Editing Shipment Groups page.
Making a Close Shipment Group Request
To call Close Shipment Group, send a POST request to https://api.sorted.com/pro/shipment_groups/{reference}/close, where {reference} is the unique reference of the shipment group you want to close. Ship closes the group, and returns a confirmation message and a link to the closed group.
Note
For full reference information on the Close Shipment Group endpoint, see the Ship API reference.
Close Shipment Group Example
The example shows a successful Close Shipment Group request for shipment group sg_00684650028894794889609836494848.
https://api.sorted.com/pro/shipment_groups/sg_00684650028894794889609836494848/close
Next Steps
- Learn how to retrieve existing shipment groups: Getting Shipment Groups
- Learn how to add and remove shipments from groups: Editing Shipment Groups