Shipments API integration design
Explore the core integration patterns for Shipments API. View the data flows that create, allocate, label, group, and manifest shipments with ‘real-world’ delivery examples.
Integration design
This is the integrations landing page showcases some of the common integration designs the Shipments API package can offer:
Create and manifest 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.
Manage shipments in bulk with Shipment Groups
The Shipment Groups design uses Shipment Groups feature to manage a collection of shipments as a single group. This design enables you to align Shipments API closely to your warehouse operations, 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.