In SortedPRO, a consignment represents a collection of goods that are to be shipped together. This section explains how to create, retrieve and edit consignments.
What Is a Consignment?
In the context of PRO, the term "consignment" refers to a collection of one or more packages 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. A consignment must contain at least one package.
A package is a physical object to be shipped. Packages have dimensions, weight and value properties, and can contain items. Items are not mandatory properties within a package.
As an example, suppose that a clothing retailer has received a customer order for a necklace, a bracelet, a coat, and a hat. As the necklace and bracelet are both physically small, the retailer elects to ship them in the same package. As such, this sales order would break down to:
- Four items - The necklace, the bracelet, the coat, and the hat.
- Three packages - One containing the necklace and bracelet, one containing the coat, and one containing the hat.
- A single consignment corresponding to everything on the order.
Consignments Section Contents
- Creating New Consignments - Explains how to use the Create Consignment endpoint, and how to generate consignments from quotes and orders.
- Getting Consignment Data - Explains how to retrieve data on an individual consignment, and search for consignments that meet set criteria.
- Updating Existing Consignments - Explains how to update a consignment's details and edit its component packages.
- Cancelling Consignments - Explains how to set a consignment's status to Cancelled.
All of the URLs and examples given in this documentation relate to PRO's live production environment. To call APIs in the sandbox environment, substitute the
api.electioapp.com portion of the API's base URL with
apisandbox.electioapp.com. Don't forget to use your sandbox API key (as opposed to your production API key) when making the call.
For more information on PRO's sandbox, see Using the Sandbox Environment.