Managing Shipments
In Ship, 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 PRO, 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 Ship's API suite.
Note
This section covers managing shipments using Ship's APIs. For an overview of working with shipments in the UI, see the Creating New Shipments and Managing Existing Shipments pages of the Ship Admin User Guide.
Shipments Section Contents
- Creating Shipments - Explains how to create shipments.
- Getting Shipments - Explains how to retrieve shipment details.
- Cancelling Shipments - Explains how to cancel existing shipments.
- Adding Paperless Documents - Explains how to add and retrieve a shipment's paperless documents.
- Changing 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.