Manage shipments
Manage your shipments effortlessly with our flexible Shipments API endpoints.
Managing Shipments
A shipment represents a collection of goods that are to be shipped together. This section explains how to create, retrieve and edit shipments.
What is a Shipment?
In the context of the Shipments platform, the term “shipment” refers to a collection of one or more items that are shipped from the same origin address, to the same destination address, on behalf of the same Sorted customer, using the same carrier service, on the same day.
Each shipment object contains details of the shipment’s current state (for example ready_to_ship or dispatched), its contents, its origin address, and its delivery address, alongside numerous optional properties. You can create and edit shipments via the Shipments API package.
Shipments Section Contents
- Create Shipments - Explains how to create shipments.
- Get Shipments - Explains how to retrieve shipment details.
- Cancel Shipments - Explains how to cancel existing shipments.
- Add Paperless Documents - Explains how to add and retrieve a shipment’s paperless documents.
- Change Shipment States Manually - Explains how to place shipments into a particular state manually.
- List of Shipment States - Lists the various states that a shipment can assume.