• View shipped / not shipped packages
      • Search for a package
      • Manifests
      • Carrier services
      • Carrier accounts
      • Carrier service groups
    • Shipping locations
    • Collection calendars
    • Allocation rules
      • User accounts
      • Role manager
    • Audit logs
    • Get started with Consignments APIs
      • Create new consignments
      • Get your consignments data
      • Update your existing consignments
      • Cancel consignments
      • Manage your consignments
      • Allocate your packages
      • Allocate using default allocation rules
      • Deallocating a consignments
      • Allocating via service group
      • Allocate to a specific quote
    • Generate labels for packages
    • Manifest Consignments
      • Consignments API integration design
      • Quotes integration
      • Consumer options pickup integration
      • Consumer options integration
      • Classic integration
      • Delivery and pickup options overview
      • Select delivery options
      • Get pickup options
      • Get delivery options
      • Get quotes
      • Getting Quotes for an Existing Consignment
      • Managing Quotes
    • How to use metadata
    • Get customs docs and invoices
    • Allocation tags
    • Get started with Shipments API
      • Allocate shipments overview
      • Allocate within a carrier service group
      • Allocate with a specific carrier service
      • Allocate to default rules
      • Manage shipment groups
      • Create shipment groups
      • Get shipment groups
      • Edit shipment groups
      • Updating shipment groups
      • Close shipment groups
      • Manage shipments
      • Create a shipment
      • Shipment states
      • Manually change a shipment state
      • Get shipments data
      • Cancel shipments
      • Shipments API integration design
      • Integration: Allocate and manifest
      • Integration: Shipment groups
      • Integration: Quote with shipment groups
    • Add paperless documents
    • Get labels for packages
    • Get shipment documents
    • Get shipment quotes
    • Manage shipment quotes
    • Manifest an individual shipment
    • Manifest shipments
    • Shipment tags
      • 400 - Virtual Service Not Found
      • 400 - Version Header Missing
      • 400 - Version Header Error
      • 400 - Value Too Small
      • 400 - Value Too Short
      • 400 - Value Too Long
      • 400 - Value Too Large
      • 400 - Validation Error
      • 400 - Unit Mismatch
      • 400 - Unauthorised
      • 400 - Too Many Elements
      • 400 - Too Few Elements
      • 400 - Text Decoder Error
      • 400 - System Use Only
      • 400 - System Shipment State
      • 400 - Status Code Error
      • 400 - Shipment Not Found
      • 400 - Shipment Invalid State
      • 400 - Rule Conflict
      • 400 - Resource Removed
      • 400 - Resource Quarantined
      • 400 - Required Property Missing
      • 400 - Processing
      • 400 - Not Found
      • 400 - Non Unique Reference
      • 400 - No Quotes Available
      • 400 - Missing Api Key Header
      • 400 - Method Not Supported
      • 400 - Invalid Weight Unit
      • 400 - Invalid Value
      • 400 - Invalid State For Operation
      • 400 - Invalid Shipping Terms
      • 400 - Invalid Shipment Type
      • 400 - Invalid Shipment State
      • 400 - Invalid Request
      • 400 - Invalid Region
      • 400 - Invalid Reference Format
      • 400 - Invalid Radioactivity
      • 400 - Invalid Postal Code
      • 400 - Invalid Physical Form
      • 400 - Invalid Packing Group
      • 400 - Invalid Package Size Reference
      • 400 - Invalid Metadata Type
      • 400 - Invalid Hazard Class
      • 400 - Invalid Format
      • 400 - Invalid Email
      • 400 - Invalid Direction
      • 400 - Invalid Dimension Unit
      • 400 - Invalid Date Range
      • 400 - Invalid Currency
      • 400 - Invalid Cron Expression
      • 400 - Invalid Country Code
      • 400 - Invalid Contents Reference
      • 400 - Invalid Category Type
      • 400 - Invalid Carrier Service
      • 400 - Invalid Api Key
      • 400 - Invalid Address Type
      • 400 - Invalid Accessibility
      • 400 - Internal Server Error
      • 400 - File Too Large
      • 400 - Duplicate Values
      • 400 - Duplicate Tags
      • 400 - Duplicate References
      • 400 - Duplicate Metadata Key
      • 400 - Duplicate Address Type
      • 400 - Date In Past
      • 400 - Conflicting Properties
      • 400 - Carrier Service Shipment Mismatch
      • 400 - Carrier Service Not Found
      • 400 - Allocation Failed
      • 400 - Address Type Required
    • Ship
    • Track
    • Insights
    • Carriers
    • Articles
    • What's New
    • to navigate
    • to select
    • to close
      • Home
      • Ship
      • Consignments developer docs
      On this page

      support Need help? Contact Support.

      contact_support Questions? Contact Sales.

      article Check out what's new.

      integration_instructions

      Consignments developer docs

      The Consignments API lets you create and manage grouped shipments supporting full workflows from order to delivery.

      rocket_launch

      Get started with Consignments APIs

      Get started with the Sorted Consignments APIs. Create, allocate, and manage shipments from quote to …

      inventory folder

      Create and manage your consignments

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

      conveyor_belt folder

      Allocation

      Learn how to allocate packages to the most appropriate carrier service in Consignments using …

      shoppingmode

      Generate labels for packages

      Generate labels for entire consignments or individual packages. Create in multiple formats using our …

      article

      Manifest Consignments

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

      extension folder

      Consignments API integration design

      Explore the key integration designs that can be applied using the Consignments API that best fit …

      article folder

      Delivery and Pickup Options

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

      deployed_code_account folder

      Manage quotes

      Use the Quotes API to retrieve carrier pricing options and manually allocate consignments with a …

      note_stack

      Allocation tags

      Control which carrier services can be allocated to specific packages using tags. Match service and …

      article

      Get customs docs and invoices

      Retrieve CN22, CN23 customs docs and commercial invoices for international packages. Documents are …

      integration_instructions

      How to use metadata

      Store custom data on packages and related objects using the MetaData array. Use to add picker …


      support Need assistance? Contact Support.

      contact_support Questions? Contact Sales.

      article Check out what's new.


      smart_toy Working with AI? See our llm.txt.

      map_search View our sitemap.xml.

      © 2025 Sorted Group Ltd.