Consignments

Get started with Consignments APIs

Get started with the Sorted Consignments APIs. Create, allocate, and manage shipments from quote to manifest with our flexible REST endpoints.

Create and manage your consignments

Our guides on how to best create, get and update your consignments using our flexible API endpoints.

Allocation

Learn how to allocate packages to the most appropriate carrier service in Consignments using configurable rules, tags, and flexible API endpoints.

Generate labels for packages

Generate labels for entire consignments or individual packages. Create in multiple formats using our dedicated API endpoints.

Manifest Consignments

Learn how to manifest package data to a carrier via our manifest endpoints.

Consignments API integration design

Explore the key integration designs that can be applied using the Consignments API that best fit your delivery operations. From the simple create a consignment integration, to the more specific 'point of purchase' delivery options and being able to select from available quotes.

Delivery and Pickup Options

Offer your customers flexible delivery or pickup slots. Providing more delivery choice and options of pickup lockers.

Manage quotes

Use the Quotes API to retrieve carrier pricing options and manually allocate consignments with a selected quote. Compare prices, services, and eligibility.

How to use metadata

Store custom data on packages and related objects using the `MetaData` array. Use to add picker info, custom statuses, or other business fields with flexibility.

Get customs docs and invoices

Retrieve CN22, CN23 customs docs and commercial invoices for international packages. Documents are auto-generated post-allocation with the Customs Docs endpoint.

Allocation tags

Control which carrier services can be allocated to specific packages using tags. Match service and shipment attributes with allocation filter tags.