# Sorted Product Documentation

This `llm.txt` is a human-readable, machine-friendly guide for AI crawlers and retrieval tools. It points models to the canonical docs, outlines what to prefer or avoid, and provides a curated, per-product index of key pages with titles and short descriptions. It does **not** enforce access (use `robots.txt` for that); instead, it improves grounding, reduces AI assumptions, and helps agents choose the right, up-to-date pages. Treat this as a structured index of Sorted’s product docs to help AI integrations stay accurate and reliable.

Canonical Base URL: https://docs.sorted.com/



## Articles
- [Sorted and Microsoft Azure Infrastructure](https://docs.sorted.com/docs/articles/sorted-microsoft-azure-infrastructure/): Learn how Sorted leverages Microsoft Azure to deliver secure, scalable, and agile infrastructure for enterprise logistics solutions.
- [Sorted Glossary](https://docs.sorted.com/docs/articles/glossary/): A quick reference for key terms and concepts used across Sorted products, documentation and marketing.
- [Ship Explained: Our shipping solution](https://docs.sorted.com/docs/articles/ship-explained/): Learn more about Ship and uncover the essential digital components known as Shipping Data Units (SDUs), the key data elements that represent a parcel and its journey from warehouse to doorstep.
- [Ship Explained: API packages](https://docs.sorted.com/docs/articles/ship-api-comparison/): A look at Sorted’s Consignments and Shipments API packages, helping you understand the difference between warehouse dispatch and flexible, on-demand shipping.

## Carrier Integrations
- [The Windsor Framework on Consignments](https://docs.sorted.com/docs/articles/windsor-framework-ship-consignments/): Comply with the Windsor Framework on our Consignments platform when shipping internationally and to Northern Ireland.
- [The Windsor Framework on Shipments](https://docs.sorted.com/docs/articles/windsor-framework-ship/): Comply with the Windsor Framework on our Shipments platform when shipping internationally and to Northern Ireland.
- [Carrier service catalogue](https://docs.sorted.com/docs/articles/carrier-service-catalogue/): A catalogue of our Ship and Track integrated carriers, services, and delivery options.

## Insights Reporting
- [Reporting: Sorted Insights Overview](https://docs.sorted.com/docs/articles/sorted-insights-overview/): Learn more about what Sorted Insights can offer. Explore, filter, and understanding your shipping data reporting.
- [Reporting: Get the most from the Wisdom data package](https://docs.sorted.com/docs/articles/sorted-insights-wisdom/): Learn how to make the most out of the Sorted Insights Wisdom package using raw shipping data directly in your own data warehouse for flexible analysis and reporting.
- [Reporting: Get access to Sorted Insights](https://docs.sorted.com/docs/articles/power-bi-report-access/): Enable Power BI access for your organisation by assigning licenses and coordinating access to your reports.

## Release notes
- [What's new](https://docs.sorted.com/whats%20new/): Introducing the latest updates to our Sorted products...

## Ship
- [Carrier services](https://docs.sorted.com/docs/ship/ship-user-guides/carrier-settings/carrier-services/): How to view, enable, disable, and manage carrier services in the Ship dashboard, including rate and allocation settings.
- [User accounts](https://docs.sorted.com/docs/ship/ship-user-guides/manage-users/users/): Create, edit, and manage user accounts in the Ship dashboard, including assigning roles, permissions and shipping locations.
- [View shipped / not shipped packages](https://docs.sorted.com/docs/ship/ship-user-guides/view-shipments/not-shipped---shipped/): Learn how to filter and view shipped and not shipped packages in the Ship dashboard, including the detailed states of each package.
- [Carrier accounts](https://docs.sorted.com/docs/ship/ship-user-guides/carrier-settings/carrier-accounts/): Learn how to view and edit your carrier accounts in Ship. Update your carrier account details and manage the associated shipping locations.
- [Role manager](https://docs.sorted.com/docs/ship/ship-user-guides/manage-users/roles/): Learn how to create and manage user roles in the Ship dashboard, including assigning permissions across account, carrier, and shipment management features.
- [Search for a package](https://docs.sorted.com/docs/ship/ship-user-guides/view-shipments/search-for-a-package/): Learn how to quickly find individual packages in Ship using the global search bar.
- [Carrier service groups](https://docs.sorted.com/docs/ship/ship-user-guides/carrier-settings/carrier-service-groups/): Create and manage carrier service groups in Ship. Control which carrier services are used for specific carrier service groups.
- [Manifests](https://docs.sorted.com/docs/ship/ship-user-guides/view-shipments/manifests/): Learn how to view and print carrier manifest documents (Consignments API users only).
- [Shipping locations](https://docs.sorted.com/docs/ship/ship-user-guides/shipping-locations/): Manage your shipping locations in Ship.
- [Collection calendars](https://docs.sorted.com/docs/ship/ship-user-guides/collection-calendars/): Learn how to configure carrier collection times and exceptions for each shipping location in Ship.
- [Allocation rules](https://docs.sorted.com/docs/ship/ship-user-guides/allocation-rules/): Learn what allocation rules are, why they’re used, and how they help automate carrier allocation workflows.
- [Shipping rules](https://docs.sorted.com/docs/ship/ship-user-guides/shipping-rules/): Learn what shipping rules are, why they’re used, and how they help automate carrier allocation workflows.
- [Shipping modes](https://docs.sorted.com/docs/ship/ship-user-guides/shipping-modes/): Learn what shipping modes are, why they’re used, and how they help automate carrier allocation workflows.
- [Audit logs](https://docs.sorted.com/docs/ship/ship-user-guides/audit/): View user activity and system actions in the Ship dashboard through recorded audit logs.

## Ship: Consignments API developer docs
- [Allocate to a specific quote](https://docs.sorted.com/docs/ship/consignments-dev-docs/allocation/allocating_to_a_specific_quote/): Use Consignment's Allocate With Quote endpoint to assign consignments to a specific carrier offer based on quote references, ideal for customer service workflows.
- [Allocating via service group](https://docs.sorted.com/docs/ship/consignments-dev-docs/allocation/allocating_via_service_group/): Use Consignment's Allocate With Service Group endpoint to assign packages from a custom pool of services. Ideal for routing based on goods type or region.
- [Allocation tags](https://docs.sorted.com/docs/ship/consignments-dev-docs/tags/): Control which carrier services can be allocated to specific packages using tags. Match service and shipment attributes with allocation filter tags.
- [Classic integration](https://docs.sorted.com/docs/ship/consignments-dev-docs/integration-designs/classic_flow/): Follow the classic integration in Consignments API to create, allocate, label, and manifest consignments using the simplest integration route.
- [Consumer options integration](https://docs.sorted.com/docs/ship/consignments-dev-docs/integration-designs/consumer_options_flow/): Present delivery timeslot choices to your customers during checkout using the Consignments API Consumer Options integration, including label and manifest automation.
- [Consumer options pickup integration](https://docs.sorted.com/docs/ship/consignments-dev-docs/integration-designs/consumer_options_pickup_flow/): Integrate consumer pickup options into your checkout flow using Consignments APIs. Allow customers to select pickup points, generate labels and manifests.
- [Deallocate consignments](https://docs.sorted.com/docs/ship/consignments-dev-docs/allocation/deallocating_consignments/): Remove carrier service assignments from consignments using the Deallocate endpoint. Reset packages to an unallocated state for editing or reallocation.
- [Get customs docs and invoices](https://docs.sorted.com/docs/ship/consignments-dev-docs/getting_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.
- [Get delivery options](https://docs.sorted.com/docs/ship/consignments-dev-docs/delivery-and-pickup-options/getting_delivery_options/): Use our Delivery Options endpoint to preview available delivery windows and services. Return summaries or detailed options before booking.
- [Get pickup options](https://docs.sorted.com/docs/ship/consignments-dev-docs/delivery-and-pickup-options/getting_pickup_options/): Offer flexible collection with our Pickup Options endpoint. Return pickup points and time slots before order creation based on customer address and product details.
- [How to use metadata](https://docs.sorted.com/docs/ship/consignments-dev-docs/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.
- [Quotes integration](https://docs.sorted.com/docs/ship/consignments-dev-docs/integration-designs/quotes_flow/): Integrate quote-based allocation with the Consignments API. Select the best service from multiple quotes, allocate, label, and manifest.
- [Select delivery options](https://docs.sorted.com/docs/ship/consignments-dev-docs/delivery-and-pickup-options/selecting_options/): Convert delivery or pickup options into live consignments using the Select Option endpoint. Automatically allocate, label, and prepare your packages for manifesting.
- [Consignments API integration design](https://docs.sorted.com/docs/ship/consignments-dev-docs/integration-designs/flows/): 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.
- [Get quotes](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-quotes/getting_quotes/): Send package and address data to retrieve live delivery quotes before consignment creation. Compare prices, services, and eligibility.
- [Get started with Consignments APIs](https://docs.sorted.com/docs/ship/consignments-dev-docs/introduction/): Get started with the Sorted Consignments APIs. Create, allocate, and manage shipments from quote to manifest with our flexible REST endpoints.
- [Getting Quotes for an Existing Consignment](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-quotes/getting_quotes_for_an_existing_consignment/): Retrieve quotes for a package that already exists in the Consignments platform. Compare qualified and unqualified services before allocation.
- [Managing Quotes](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-quotes/managing_quotes/): Use our Quotes API to retrieve carrier pricing options and manually allocate consignments with a selected quote. Ideal for expedited or exception workflows.
- [Allocate your packages](https://docs.sorted.com/docs/ship/consignments-dev-docs/allocation/allocating_consignments/): Learn how to allocate packages to the most appropriate carrier service in Consignments using configurable rules, tags, and flexible API endpoints.
- [Create new consignments](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-consignments/creating_new_consignments/): Record new orders in the Consignments platform using API or the user-interface.
- [Delivery and pickup options overview](https://docs.sorted.com/docs/ship/consignments-dev-docs/delivery-and-pickup-options/using_delivery_and_pickup_options/): Offer your customers flexible delivery or pickup slots. Create time-windowed options using carrier rules.
- [Get your consignments data](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-consignments/getting_consignment_data/): Return the full or summary data on your consignments by reference or search by filters.
- [Generate labels for packages](https://docs.sorted.com/docs/ship/consignments-dev-docs/getting_labels/): Generate labels for entire consignments or individual packages. Create in multiple formats using our dedicated API endpoints.
- [Update your existing consignments](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-consignments/updating_existing_consignments/): Update shipping dates, delivery instructions, addresses, packages and more for existing consignments.
- [Cancel consignments](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-consignments/cancelling_consignments/): Cancel individual or bulk consignments using a simple PUT request.
- [Manage your consignments](https://docs.sorted.com/docs/ship/consignments-dev-docs/manage-consignments/managing_consignments/): Our guide on how to create, retrieve, update, and cancel consignments packages.
- [Allocate using default allocation rules](https://docs.sorted.com/docs/ship/consignments-dev-docs/allocation/allocating_using_default_allocation_rules/): Automatically allocate assign to the cheapest eligible carrier with one request using predefined business rules in Consignments.
- [Manifest Consignments](https://docs.sorted.com/docs/ship/consignments-dev-docs/manifesting_consignments/): Learn how to manifest package data to a carrier via our manifest endpoints.

## Ship: Consignments API reference
- [Consignments API Reference](https://docs.sorted.com/consignments-api-reference/): Consignments API package data contract.

## Ship: Shipments API developer docs
- [Allocate to default rules](https://docs.sorted.com/docs/ship/shipments-dev-docs/allocating-shipments/allocating_to_default_rules/): Use the Allocate shipment endpoints to automatically assign packages to eligible carrier services based on your predefined rules and modes.
- [Allocate with a specific carrier service](https://docs.sorted.com/docs/ship/shipments-dev-docs/allocating-shipments/allocating_with_a_specific_carrier_service/): Assign shipments to a specific carrier service using the 'allocate with carrier service' endpoints, ideal for tighter control over shipment routing.
- [Allocate within a carrier service group](https://docs.sorted.com/docs/ship/shipments-dev-docs/allocating-shipments/allocating_within_a_carrier_service_group/): Use a carrier service group to allocate shipments only from a specified pool of carrier services. Ideal for grouping services by use case like hazardous or premium delivery.
- [Cancel shipments](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipments/cancelling_shipments/): Learn how to cancel a shipment using the Shipment API before it is manifested.
- [Close shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipment-groups/closing_shipment_groups/): Use the close shipment group endpoint to permanently close a group after its shipments are manifested or cancelled.
- [Get shipments data](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipments/getting_shipments/): Retrieve shipment details by shipment reference, custom reference, or carrier tracking reference using Shipments API search endpoints.
- [Manually change a shipment state](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipments/changing_shipment_states_manually/): Learn how to use the Change Shipment State endpoint to manually adjust shipment states for exceptional cases.
- [Shipment states](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipments/shipment_states/): Reference all shipment states used by the Shipments platform to track the lifecycle of packages from allocation to delivery.
- [Allocate shipments overview](https://docs.sorted.com/docs/ship/shipments-dev-docs/allocating-shipments/allocating_shipments/): Learn how Shipments selects carrier services for packages using allocation rules, service groups, shipping modes, and API allocation endpoints.
- [Get started with Shipments API](https://docs.sorted.com/docs/ship/shipments-dev-docs/introduction/): Get started with Shipment APIs. Create, allocate, get quotes, customs docs, labels, and much more with our extensive API package..
- [Manage shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipment-groups/managing_shipment_groups/): Create, manage, and manifest multiple shipments at once using shipment groups. Streamline operations by batching outbound packages by carrier or workflow.
- [Manage shipments](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipments/managing_shipments/): Manage your shipments effortlessly with our flexible Shipments API endpoints.
- [Shipments API integration design](https://docs.sorted.com/docs/ship/shipments-dev-docs/integration-designs/integration_design_guide/): 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.
- [Create a shipment](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipments/creating_shipments/): Submit new shipment data with the create shipments endpoint and manage your shipments effortlessly with our flexible shipment management API requests.
- [Create shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipment-groups/creating_shipment_groups/): Use the create shipment groups API to create and manage shipment batches. Validate shipments, assign custom references, and handle versioned group identifiers.
- [Integration: Allocate and manifest](https://docs.sorted.com/docs/ship/shipments-dev-docs/integration-designs/classic/): Use Ship’s classic integration design to create, allocate, label, and manifest shipments. Ideal for simple, scheduled carrier collections with static delivery promises.
- [Get shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipment-groups/getting_shipment_groups/): Retrieve and filter shipment group records using references or versioned custom references.
- [Integration: Shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/integration-designs/shipment_groups/): Manage collections of shipments. Group, allocate, lock, and manifest multiple shipments together via API.
- [Edit shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipment-groups/editing_shipment_groups/): Add or remove shipments from a shipment group in bulk or individually, and manage grouped lock states.
- [Integration: Quote with shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/integration-designs/3a_quote_with_shipment_groups/): Follow the Quote with Shipment Groups integration design to create, quote, allocate, and manifest shipments in a batch. Enabling efficient pre-checking and group processing.
- [Updating shipment groups](https://docs.sorted.com/docs/ship/shipments-dev-docs/manage-shipment-groups/updating_shipment_groups/): Update an existing shipment group by adding or removing shipments, or managing its locked and unlocked state before final closure.
- [Add paperless documents](https://docs.sorted.com/docs/ship/shipments-dev-docs/adding_paperless_documents/): Learn how to upload and manage paperless trade documents for unallocated shipments using the Add, Get, and Remove Paperless Document endpoints.
- [Get labels for packages](https://docs.sorted.com/docs/ship/shipments-dev-docs/getting_shipment_labels/): Learn how to retrieve and decode despatch labels using Shipment API Get Labels and Get Contents Label endpoints.
- [Get shipment documents](https://docs.sorted.com/docs/ship/shipments-dev-docs/getting_shipment_documents/): Learn how to retrieve customs documents and other shipment documents, including CN22s, invoices, and hazard labels.
- [Get shipment quotes](https://docs.sorted.com/docs/ship/shipments-dev-docs/getting_shipment_quotes/): Use the Get Quote endpoint to retrieve delivery quotes for an packages in Shipments API.
- [Manage shipment quotes](https://docs.sorted.com/docs/ship/shipments-dev-docs/managing_shipment_quotes/): Get delivery quotes for unallocated shipments using Shipments API 'create quote' and 'create quote by service group' endpoints.
- [Manifest an individual shipment](https://docs.sorted.com/docs/ship/shipments-dev-docs/manifesting_shipments_manually/): Manifest shipments using individual, query, or shipment group endpoints in the Shipments API.
- [Manifest shipments](https://docs.sorted.com/docs/ship/shipments-dev-docs/manifesting_shipments/): Learn how to use the Manifest Shipment endpoint in Shipments API to confirm and transmit shipment data to carriers for collection.
- [Shipment tags](https://docs.sorted.com/docs/ship/shipments-dev-docs/using_shipment_tags/): Use shipment tags to restrict allocations to only matching carrier services and to apply filters dynamically based on shipment-specific properties.

## Ship: Shipments API reference
- [Shipments API Reference](https://docs.sorted.com/shipments-api-reference/): Shipments API package data contract.

## Track
- [Calculated events](https://docs.sorted.com/docs/track/get-started/calc-events/): Track’s Calculated Events can flag late or missing shipments automatically. Stay proactive with real-time delivery insights.
- [Create tracking pages](https://docs.sorted.com/docs/track/tracking-pages/): Build branded, no-code shipment tracking pages in minutes. Customise layout, links, and design with Track's intuitive editor.
- [Custom events](https://docs.sorted.com/docs/track/custom-events/): Define custom events and manually trigger shipment updates unique to your delivery operations, enabling targeted customer communications beyond automated tracking events.
- [Customise shipment states](https://docs.sorted.com/docs/track/get-started/customise-shipment-state-labels/): Easily tailor shipment state labels in Track to match your brand’s voice across multiple languages.
- [Manage webhooks](https://docs.sorted.com/docs/track/managing-webhooks/): Automate customer updates and escalations by configuring webhooks triggered by Track shipment states and events.
- [Proactive Alerts](https://docs.sorted.com/docs/track/proactive-alerts/): Stay ahead of delays with Proactive Alerts which flag issues in real-time before carriers even report them.
- [Settings](https://docs.sorted.com/docs/track/settings/): Manage your API keys, SFTP accounts, carrier connectors, state labels and custom events in Track settings.
- [Shipment event filters](https://docs.sorted.com/docs/track/manage-shipment-filters/): Set up Shipment Event Filters and define which delivery events you want to capture, enabling real-time notifications and webhooks to keep you and your customers informed.
- [Track javascript plugin](https://docs.sorted.com/docs/track/tracking-plugin/): Embed Track’s shipment tracking directly into your website using our JavaScript plugin. Brand it your way, no redirect or login needed.
- [Track reporting](https://docs.sorted.com/docs/track/reporting/): Monitor notification performance with Track’s reporting tools. Explore delivery insights, email stats, and smart filter behavior all in one place.
- [Tracking carrier states](https://docs.sorted.com/docs/track/get-started/shipment-states/): Our list of tracking states and the mapped carrier events in Track.
- [Register shipments](https://docs.sorted.com/docs/track/set-up-shipments/registering-shipments/): Quickly register shipments into Track using API, SFTP, or Email.
- [Set up notifications](https://docs.sorted.com/docs/track/create-notifications/notifications/): Learn how to configure, manage, and activate automated customer notifications using email and or SMS.
- [Track overview](https://docs.sorted.com/docs/track/get-started/ui-help/): A quick look at the Track user-interface and an overview of it's features.
- [Get started with Track](https://docs.sorted.com/docs/track/get-started/quick-start/): Get started with registering shipments and learn how to filter and track your shipment data. Keep customers updated by creating branded tracking pages and send automatic notifications.
- [Group your registered shipments](https://docs.sorted.com/docs/track/set-up-shipments/grouping-shipments/): Easily group multiple shipments into one customer-facing experience using shared metadata and Track's auto-load functionality.
- [User management](https://docs.sorted.com/docs/track/get-started/user-management/): Manage Track users with ease. Invite, edit, and set role-based permissions to control access across your organisation.
- [View shipments](https://docs.sorted.com/docs/track/get-started/monitoring-shipments/): Quickly monitor shipment states, locations, and performance metrics across Track’s dashboards.
- [Personalise messaging with variables](https://docs.sorted.com/docs/track/create-notifications/notification-variables/): Personalise your customer messaging by using variables in your notification templates.

## Track - Developer Docs
- [Track API user guide](https://docs.sorted.com/docs/track/track-api/integration-guide/): An overview of the Track API package.
- [Get your tracking data](https://docs.sorted.com/docs/track/track-api/retrieving-data/): A guide on how to retrieve delivery updates using our API package.
- [Update your shipments](https://docs.sorted.com/docs/track/track-api/updating-shipments/): Learn how to update or delete existing shipments using our API.
- [Simulated tracking](https://docs.sorted.com/docs/track/track-api/using-simulated-tracking/): Our guide on how to simulate tracking events for testing and demonstrations on your Track platform.
- [Error codes](https://docs.sorted.com/docs/track/track-api/error-codes/): Troubleshoot API errors with our guide.

## Track API reference
- [Track API Reference](https://docs.sorted.com/track-api-reference/): Track API package data contract.

## Unassigned Docs
- [400 - Address Type Required](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/address_type_required/):  check_circle The address_type_required error code is returned when an address is provided without specifying the address_type. All addresses must include a valid address_type. When creating or …
- [400 - Allocation Failed](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/allocation_failed/):  check_circle The error code allocation_failed will be returned when an attempt has been made to allocate a shipment, but there were no valid carrier services available. For example, if you ask …
- [400 - Carrier Service Not Found](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/carrier_service_not_found/):  check_circle The carrier_service_not_found error code will be returned when an attempt is made to allocate a shipment with a specific carrier service, but the carrier service does not exist or could …
- [400 - Carrier Service Shipment Mismatch](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/carrier_service_shipment_mismatch/):  check_circle The error code carrier_service_shipment_mismatch is returned when you attempt to allocate an on_demand shipment with a scheduled carrier service, or to allocate a scheduled shipment with …
- [400 - Conflicting Properties](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/conflicting_properties/):  check_circle The error code conflicting_properties means that 2 or more properties in a single request conflict with one another. This error can be returned, for example, when attempting to update a …
- [400 - Date In Past](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/date_in_past/):  check_circle The error code date_in_past is used when a date value is provided for a property such as required_delivery_date but the date is in the past. The date_in_past error code will not be …
- [400 - Duplicate Address Type](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/duplicate_address_type/):  check_circle The duplicate_address_type error code is returned when a request includes 2 or more addresses with the same address_type value. If 2 or more addresses include the same address_type value …
- [400 - Duplicate Metadata Key](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/duplicate_metadata_key/):  check_circle The error code duplicate_metadata_key is returned if you provided 2 or more of the same key values for a metadata object. Metadata is a collection of “key-value” pairs that …
- [400 - Duplicate References](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/duplicate_references/):  check_circle The error code duplicate_references is returned when a collection of references includes 2 or more duplicates. Shipments API will not attempt to de-dupe incoming values, because our aim …
- [400 - Duplicate Tags](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/duplicate_tags/):  check_circle The duplicate_tags error code will be returned if the same tag value is added to a shipment more than once. For example, this code will be returned if you attempt to create a shipment …
- [400 - Duplicate Values](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/duplicate_values/):  check_circle The error code duplicate_values will be returned if a list that should contain unique properties includes 2 or more duplicate values. This error code would be returned, for example, you …
- [400 - File Too Large](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/file_too_large/):  check_circle The file_too_large error code will be returned if you attempt to save or transmit a file via API and the size of the file is greater than the allowed limit. For example, if a particular …
- [400 - Internal Server Error](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/internal_server_error/):  check_circle The error code internal_server_error is returned whenever an unexpected or unhandled error occurs in a Sorted API. This error code will be returned in rare situations where an unforeseen …
- [400 - Invalid Accessibility](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_accessibility/):  check_circle The error code invalid_accessibility is returned when a request is made the includes an invalid value for the accessibility property of dangerous_goods. This error code would be …
- [400 - Invalid Address Type](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_address_type/):  check_circle The error code invalid_address_type is returned when an invalid value is provided for the address_type property of an address. This error code will be returned, for example, if an …
- [400 - Invalid Api Key](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_api_key/):  check_circle The invalid_api_key error code is returned when the API key provided with your request is not valid. All requests to Sorted APIs require a valid API key to be provided in the x-api-key …
- [400 - Invalid Carrier Service](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_carrier_service/):  check_circle The error code invalid_carrier_service is returned when an attempt is made to use a carrier service but the provided reference is not valid. This error code will be returned, for …
- [400 - Invalid Category Type](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_category_type/):  check_circle The invalid_category_type error code will be returned if an attempt is made to create a shipment with customs_documentation but an invalid value is provided for the category_type …
- [400 - Invalid Contents Reference](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_contents_reference/):  check_circle The invalid_contents_reference error code will be returned if you provide an invalid reference for shipment_contents. The shipment_contents reference format is sc_[0-9]{32}. This error …
- [400 - Invalid Country Code](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_country_code/):  check_circle The invalid_country_code error will be returned if you provide an invalid value for a country ISO code. This error code will be returned, for example, if you provide an unrecognised …
- [400 - Invalid Cron Expression](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_cron_expression/):  check_circle The invalid_cron_expression error code will be returned if you provide an invalid CRON expression value. You are unlikely to experience this error, as Shipments API no longer exposes API …
- [400 - Invalid Currency](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_currency/):  check_circle The invalid_currency error code will be returned if you provide an invalid currency code. Currency codes should be provided in the three character ISO4217 format such as:
GBP USD AUD EUR …
- [400 - Invalid Date Range](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_date_range/):  check_circle The invalid_date_range error code will be returned if your request includes an invalid date_range. The date_range object includes 2 properties: start and end.
In order for a date_range …
- [400 - Invalid Dimension Unit](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_dimension_unit/):  check_circle The invalid_dimension_unit error code will be returned if you provide an invalid or unrecognised value for a unit property within a dimensions object When expressing dimensions, the …
- [400 - Invalid Direction](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_direction/):  check_circle The invalid_direction error code will be returned if you provide an invalid value for the direction property of a shipment It is only currently possible for a shipment to be either: …
- [400 - Invalid Email](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_email/):  check_circle The invalid_email error code is provided if you provide an invalid format of email address When creating shipments, a contact is required for each address. For each contact, a valid …
- [400 - Invalid Format](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_format/):  check_circle The invalid_format error code will be returned if you make a request to an API endpoint which includes either a route parameter or a query string parameter for format This error code …
- [400 - Invalid Hazard Class](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_hazard_class/):  check_circle The invalid_hazard_class error code will be returned if you provide an invalid value for the hazard_class property of dangerous_goods. This error code will be returned, for example, if …
- [400 - Invalid Metadata Type](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_metadata_type/):  check_circle The invalid_metadata_type error code will be returned if you provide an invalid type value when creating or updating an object containing metadata. This error code would be returned, for …
- [400 - Invalid Package Size Reference](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_package_size_reference/):  check_circle The invalid_package_size_reference error code will be returned if you provide a package_size_reference value when creating or updating a shipment but the value does not identify an …
- [400 - Invalid Packing Group](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_packing_group/):  check_circle The invalid_packing_group error code will be returned if you attempt to create or update a shipment containing dangerous_goods and do not provide a valid value for packing_group. This …
- [400 - Invalid Physical Form](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_physical_form/):  check_circle The invalid_physical_form error code will be returned if you attempt to create or update a shipment containing dangerous_goods and do not provide a valid value for physical_form. This …
- [400 - Invalid Postal Code](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_postal_code/):  check_circle The invalid_postal_code error code is returned if you provide a postal_code value that is not in a valid format for the corresponding country_iso_code This error code will be returned, …
- [400 - Invalid Radioactivity](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_radioactivity/):  check_circle The invalid_radioactivity error code will be returned if you attempt to create or update a shipment containing dangerous_goods and do not provide a valid value for radioactivity. This …
- [400 - Invalid Reference Format](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_reference_format/):  check_circle The invalid_reference_format error code will be returned if a specific format of reference is required for a specific API endpoint This error code will be returned, for example, if an …
- [400 - Invalid Region](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_region/):  check_circle The invalid_region error code will be returned if you attempt to create or update a shipment but provide an invalid region for an address. This error code will be returned, for example, …
- [400 - Invalid Request](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_request/):  check_circle The invalid_request error code will be returned as a ‘parent’ error when your request was deemed to be invalid. This error code is generally returned when your request has …
- [400 - Invalid Shipment State](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_shipment_state/):  check_circle The invalid_shipment_state error code is returned if your request includes one or more state values for a shipment but one or more of the provided values is invalid. This error code will …
- [400 - Invalid Shipment Type](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_shipment_type/):  check_circle The invalid_shipment_type error code is returned when an attempt is made to create or update a shipment but the shipment_type value provided is invalid. This error code will be returned, …
- [400 - Invalid Shipping Terms](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_shipping_terms/):  check_circle The invalid_shipping_terms error code will be returned if you attempt to create or update a shipment and do not provide a valid value for shipping_terms for any one of the …
- [400 - Invalid State For Operation](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_state_for_operation/):  check_circle The invalid_state_for_operation error code is returned if your request requires a shipment to be in a particular state, but the shipment is not in that state (or one of the valid states …
- [400 - Invalid Value](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_value/):  check_circle The invalid_value error code is a ‘general’ error code returned when the value for a given property is not valid. This error code could be returned, for example, if you …
- [400 - Invalid Weight Unit](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/invalid_weight_unit/):  check_circle The invalid_weight_unit error code is returned if you provide an invalid or unrecognised value for unit when specifying the weight of an object such as shipment_contents. This error code …
- [400 - Method Not Supported](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/method_not_supported/):  check_circle The method_not_supported error code is returned when you make an API call to a valid URL but using the incorrect HTTP verb. For example, when requesting a shipment, the correct HTTP verb …
- [400 - Missing Api Key Header](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/missing_api_key_header/):  check_circle The missing_api_key_header error code indicates that you have not provided an x-api-key header value with your request. All API requests to the Shipments API require an x-api-key header …
- [400 - No Quotes Available](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/no_quotes_available/):  check_circle The no_quotes_available error code indicates that your request to retrieve quotes did not find any valid results. This error code will be returned, for example, if you request quotes and …
- [400 - Non Unique Reference](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/non_unique_reference/):  check_circle The non_unique_reference error code will be returned in rare circumstances when you make an attempt to allocate a shipment with a virtual_service but you have both a carrier service and …
- [400 - Not Found](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/not_found/):  check_circle The not_found error code will be returned when no resource was found with a provided reference or at the provided path. This error code will be returned, for example, if you attempt to …
- [400 - Processing](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/processing/):  check_circle The processing error code will be returned if you make an attempt to retrieve an object that is still being processed. This error code could be returned, for example, in circumstances …
- [400 - Required Property Missing](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/required_property_missing/):  check_circle The required_property_missing error code will be returned when a request property is required but you did not provide a value. This error code could be returned in a variety of …
- [400 - Resource Quarantined](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/resource_quarantined/):  check_circle The resource_quarantined error code will be returned in the event of an uploaded file being quarantined due to a virus risk. Sorted will always endeavour to protect our own platform, as …
- [400 - Resource Removed](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/resource_removed/):  check_circle The resource_removed error code will be returned if you make a request to retrieve an object that has been removed from the Sorted platform. There are several circumstances in which this …
- [400 - Rule Conflict](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/rule_conflict/):  check_circle The rule_conflict error code will be returned when the properties of a request conflict with an existing object. This error code is only likely to be returned in very limited …
- [400 - Shipment Invalid State](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/shipment_invalid_state/):  check_circle The shipment_invalid_state error code will be returned as a child error of an allocation_failed response when a shipment is not in a valid state to be allocated.
It is only possible to …
- [400 - Shipment Not Found](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/shipment_not_found/):  check_circle The shipment_not_found error code is returned when a specific shipment cannot be found. This error code can be returned, for example, when you make an attempt to retrieve a shipment that …
- [400 - Status Code Error](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/status_code_error/):  check_circle The status_code_error is returned when the Sorted API returns an unexpected status code. Generally, this error code should be extremely rare and is only returned in circumstances in …
- [400 - System Shipment State](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/system_shipment_state/):  check_circle The system_shipment_state error code is returned when you attempt to use a state value that is reserved for system use. There are several “transition” states that a shipment …
- [400 - System Use Only](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/system_use_only/):  check_circle The system_use_only error code will be returned if one or more properties have been provided in an API call but those properties are reserved for system use only. For example, this error …
- [400 - Text Decoder Error](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/text_decoder_error/):  check_circle The text_decoder_error error code will be returned when you make an attempt to call an API endpoint with either an explicit UTF8 content-type header or an unspecified charset with a …
- [400 - Too Few Elements](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/too_few_elements/):  check_circle The error code too_few_elements will be returned if you do not provide enough values in a collection when creating or updating an object. This error code would be returned, for example, …
- [400 - Too Many Elements](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/too_many_elements/):  check_circle The too_many_elements error code will be returned if you attempt to include more elements in a collection than the maximum or limit for that collection. This error code will be returned, …
- [400 - Unauthorised](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/unauthorised/):  check_circle The unauthorised error code will be returned when you make an attempt to call an API endpoint for which your account has not been granted access. This can occur, for example, if your …
- [400 - Unit Mismatch](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/unit_mismatch/):  check_circle The unit_mismatch error code will be returned if the value for two or more units does not match within a single request. This can occur in 3 key situations:
when the weight.unit value in …
- [400 - Validation Error](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/validation_error/):  check_circle The validation_error code is a general ’top-level’ error code returned when there was a validation error with your request. A “validation error” essentially means …
- [400 - Value Too Large](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/value_too_large/):  check_circle The value_too_large error code is returned when a single value is larger than the permitted maximum. This could be returned for example, if the maximum value for latitude is exceeded …
- [400 - Value Too Long](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/value_too_long/):  check_circle The value_too_long error code will be returned if the length of a provided value is longer than the permitted maximum. This error code would be returned for example, if a property had a …
- [400 - Value Too Short](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/value_too_short/):  check_circle The value_too_short error code will be returned when a property value is provided that is shorter than the permitted mimumum. This could be returned, for example, if you provide a …
- [400 - Value Too Small](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/value_too_small/):  check_circle The value_too_small error code is returned when a single value is small than the permitted minimum. This could be returned for example, if the minimum value for longitude is exceeded …
- [400 - Version Header Error](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/version_header_error/):  check_circle The version_header_error code will be returned if the value of the provided x-api-version header is not valid. Sorted currently supports version 1.1 of APIs only. If any other value is …
- [400 - Version Header Missing](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/version_header_missing/):  check_circle The version_header_missing code will be returned if the x-api-version header is not provided. Sorted currently supports version 1.1 of APIs only. If an x-api-version header is not …
- [400 - Virtual Service Not Found](https://docs.sorted.com/docs/ship/shipments-dev-docs/api-error-messages/virtual_service_not_found/):  check_circle The virtual_service_not_found error code will be returned if an attempt is made to allocate a shipment with a ‘virtual service’, but the reference provided does not identify …
- [Consignments brexit data guide](https://docs.sorted.com/docs/articles/brexit-guide/): Navigate post-Brexit shipping with our Consignments platform. Ensure your consignments meet all customs and carrier data requirements for seamless international delivery.
- [Region validation rules](https://docs.sorted.com/docs/articles/region-validation/): Our list of region codes against Sorted’s mandatory country-specific rules.
- [TLS verion update](https://docs.sorted.com/docs/articles/tls-version-update/): Prepare for upcoming security updates as we will require TLS 1.2+ connections from April 2024 to protect data across platforms.
- [UPS switches API authentication to OAuth 2.0](https://docs.sorted.com/docs/articles/ups-oauth-guide/): Migrate your UPS API integrations to OAuth 2.0 authentication before August 2024 to ensure uninterrupted shipping.
- [Postcode validation](https://docs.sorted.com/docs/articles/postcode-validation/): Our list of country postcode regex validation for our Ship product.