ShipIntegration Designs
Ready to get started with Ship? This guide explains some common integration designs for Ship's APIs, helping you to see what Ship can do for your business.
We'll cover:
Creating and manifesting a shipment
The Allocate and Manifest design is a simple call flow to create a shipment, allocate it to a scheduled or ad-hoc carrier service using criteria of your choosing, retrieve delivery labels, and manifest it with the carrier. This design would be best used to facilitate bulk shipments from a warehouse or enable a ship-from-store model.
Managing shipments in bulk with Shipment Groups
The Shipment Groups design uses Ship's Shipment Groups feature to manage a collection of shipments as a single group. This design enables you to align Ship to your warehouse operations closely, for example by manifesting and getting collection notes for all of the shipments that are due to be loaded on to a particular vehicle at once.
Note
This guide is intended as a primer for Ship. If you're already familiar with the basics of Ship, or you just need reference info for Ship's APIs, see the API Reference.
All of the URLs and examples given in this documentation relate to Ship's live production environment. To call APIs in the sandbox environment, substitute the api.sorted.com/pro portion of the API's base URL with api.sorted.com/pro-sandbox. Don't forget to use your sandbox API key (as opposed to your production API key) when making the call.
For more information on Ship's sandbox, see Using the Sandbox Environment.