# 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](/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](/docs/articles/glossary/): A quick reference for key terms and concepts used across Sorted products, documentation and marketing. - [Ship Explained: Our shipping solution](/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](/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](/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](/docs/articles/windsor-framework-ship/): Comply with the Windsor Framework on our Shipments platform when shipping internationally and to Northern Ireland. - [Carrier service catalogue](/docs/articles/carrier-service-catalogue/): A catalogue of our Ship and Track integrated carriers, services, and delivery options. ## Insights Reporting - [Reporting: Sorted Insights Overview](/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](/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](/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](/whats%20new/): Introducing the latest updates to our Sorted products... ## Ship: Consignments API - [Consignments API Reference](/consignments-api-reference/): Consignments API package data contract. ## Ship: Consignments platform - [Allocate to a specific quote](/docs/consignments/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](/docs/consignments/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](/docs/consignments/tags/): Control which carrier services can be allocated to specific packages using tags. Match service and shipment attributes with allocation filter tags. - [Classic integration](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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. - [Deallocating a consignments](/docs/consignments/allocation/deallocating_consignments/): Remove carrier service assignments from consignments using the Deallocate endpoint. Reset packages to unallocated state for editing or reallocation. - [Get customs docs and invoices](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/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](/docs/consignments/manage-consignments/creating_new_consignments/): Record new orders in the Consignments platform using API or the user-interface. - [Delivery and pickup options overview](/docs/consignments/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](/docs/consignments/manage-consignments/getting_consignment_data/): Return the full or summary data on your consignments by reference or search by filters. - [Generate labels for packages](/docs/consignments/getting_labels/): Generate labels for entire consignments or individual packages. Create in multiple formats using our dedicated API endpoints. - [Update your existing consignments](/docs/consignments/manage-consignments/updating_existing_consignments/): Update shipping dates, delivery instructions, addresses, packages and more for existing consignments. - [Cancel consignments](/docs/consignments/manage-consignments/cancelling_consignments/): Cancel individual or bulk consignments using a simple PUT request. - [Manage your consignments](/docs/consignments/manage-consignments/managing_consignments/): Our guide on how to create, retrieve, update, and cancel consignments packages. - [Allocate using default allocation rules](/docs/consignments/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](/docs/consignments/manifesting_consignments/): Learn how to manifest package data to a carrier via our manifest endpoints. ## Ship: Shipments API - [Shipments API Reference](/shipments-api-reference/): Shipments API package data contract. ## Ship: Shipments platform - [Add paperless documents](/docs/shipments/shipments-api/adding_paperless_documents/): Learn how to upload and manage paperless trade documents for unallocated shipments using the Add, Get, and Remove Paperless Document endpoints. - [Allocate shipments overview](/docs/shipments/shipments-api/allocating-shipments/allocating_shipments/): Learn how Shipments selects carrier services for packages using allocation rules, service groups, shipping modes, and API allocation endpoints. - [Allocate to default rules](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/manage-shipments/cancelling_shipments/): Learn how to cancel a shipment using the Shipment API before it is manifested. - [Close shipment groups](/docs/shipments/shipments-api/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 labels for packages](/docs/shipments/shipments-api/getting_shipment_labels/): Learn how to retrieve and decode despatch labels using Shipment API Get Labels and Get Contents Label endpoints. - [Get shipment documents](/docs/shipments/shipments-api/getting_shipment_documents/): Learn how to retrieve customs documents and other shipment documents, including CN22s, invoices, and hazard labels. - [Get shipment quotes](/docs/shipments/shipments-api/getting_shipment_quotes/): Use the Get Quote endpoint to retrieve delivery quotes for an packages in Shipments API. - [Get shipments data](/docs/shipments/shipments-api/manage-shipments/getting_shipments/): Retrieve shipment details by shipment reference, custom reference, or carrier tracking reference using Shipments API search endpoints. - [Manage shipment quotes](/docs/shipments/shipments-api/managing_shipment_quotes/): Get delivery quotes for unallocated shipments using Shipments API 'create quote' and 'create quote by service group' endpoints. - [Manifest shipments](/docs/shipments/shipments-api/manifesting_shipments/): Learn how to use the Manifest Shipment endpoint in Shipments API to confirm and transmit shipment data to carriers for collection. - [Manifest your shipments](/docs/shipments/shipments-api/manifesting_shipments_manually/): Manifest shipments using individual, query, or shipment group endpoints in the Shipments API. - [Manually change a shipment state](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/manage-shipments/shipment_states/): Reference all shipment states used by the Shipments platform to track the lifecycle of packages from allocation to delivery. - [Shipment tags](/docs/shipments/shipments-api/using_shipment_tags/): Use shipment tags to restrict allocations to only matching carrier services and to apply filters dynamically based on shipment-specific properties. - [Get started with Shipments API](/docs/shipments/shipments-api/introduction/): Get started with Shipment APIs. Create, allocate, get quotes, customs docs, labels, and much more with our extensive API package.. - [Get started with Sorted Shipments](/docs/shipments/getting-started/): Get started with Shipments. Register an account, log in, and access the dashboard to manage your shipments and tracking data. - [Manage shipment groups](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/manage-shipments/managing_shipments/): Manage your shipments effortlessly with our flexible Shipments API endpoints. - [Shipments API integration design](/docs/shipments/shipments-api/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 new shipments](/docs/shipments/creating-new-shipments/): Register shipments manually in the Shipments user interface. - [Manage allocation windows](/docs/shipments/managing-allocation-windows/): Set time-based exclusions and post-midnight cutoffs to manage when carrier services are available for quoting. - [Manage carrier services](/docs/shipments/managing-carrier-services/): View, group, and test your enabled carrier services in Shipments. Manage allocation behavior with service groups and simulate rates for unbooked shipments. - [Manage existing shipments](/docs/shipments/managing-existing-shipments/): View, search, and manage your existing shipments in Shipments. Filter by status, access individual shipment details, and trigger key actions like allocate, manifest, or cancel. - [Manage shipping locations](/docs/shipments/managing-shipping-locations/): View and manage shipping locations. Access location settings, review activation status, and configure carrier-specific collection calendars and cut-offs. - [Manage shipping modes](/docs/shipments/managing-shipping-modes/): Set allocation rules using shipping modes in Shipments. Define volume limits, time windows, carrier services, and shipping locations to control when and how services are allocated. - [Manage shipping rules](/docs/shipments/managing-shipping-rules/): Configure business logic to allocate shipments to carrier services in Shipments. Define rules by geography, value, weight, region, tenant, channel, and more. - [Manage tenants and channels](/docs/shipments/managing-tenants-and-channels/): Set up and manage tenants and channels in Shipments. Create sub-brands, assign users, and link carrier services, accounts, and locations to each entity. - [Manage users and roles](/docs/shipments/managing-users-and-roles/): Create and manage user accounts in Shipments. Assign roles, permissions, and access across tenants and channels for tailored administration control. - [View carrier account settings](/docs/shipments/viewing-carrier-account-settings/): View carrier account configuration in Shipments. See read-only credentials, tenants, services, and locations linked to each account settings file. - [Create a shipment](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/manage-shipment-groups/getting_shipment_groups/): Retrieve and filter shipment group records using references or versioned custom references. - [Integration: Shipment groups](/docs/shipments/shipments-api/integration-designs/shipment_groups/): Manage collections of shipments. Group, allocate, lock, and manifest multiple shipments together via API. - [Edit shipment groups](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/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](/docs/shipments/shipments-api/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. ## Track - [Calculated events](/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](/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](/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](/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](/docs/track/managing-webhooks/): Automate customer updates and escalations by configuring webhooks triggered by Track shipment states and events. - [Proactive Alerts](/docs/track/proactive-alerts/): Stay ahead of delays with Proactive Alerts which flag issues in real-time before carriers even report them. - [Settings](/docs/track/settings/): Manage your API keys, SFTP accounts, carrier connectors, state labels and custom events in Track settings. - [Shipment event filters](/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](/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](/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](/docs/track/get-started/shipment-states/): Our list of tracking states and the mapped carrier events in Track. - [Register shipments](/docs/track/set-up-shipments/registering-shipments/): Quickly register shipments into Track using API, SFTP, or Email. Unlock smarter tracking and customer insights with enhanced data. - [Set up notifications](/docs/track/create-notifications/notifications/): Learn how to configure, manage, and activate automated customer notifications using email and or SMS. - [Track API user guide](/docs/track/track-api/integration-guide/): An overview of the Track API package. - [Track overview](/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](/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](/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](/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](/docs/track/get-started/monitoring-shipments/): Quickly monitor shipment states, locations, and performance metrics across Track’s dashboards. - [Get your tracking data](/docs/track/track-api/retrieving-data/): A guide on how to retrieve delivery updates using our API package. - [Personalise messaging with variables](/docs/track/create-notifications/notification-variables/): Personalise your customer messaging by using variables in your notification templates. - [Update your shipments](/docs/track/track-api/updating-shipments/): Learn how to update or delete existing shipments using our API. - [Simulated tracking](/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](/docs/track/track-api/error-codes/): Troubleshoot API errors with our guide. ## Track API - [Track API Reference](/track-api-reference/): Track API package data contract. ## Unassigned Docs - [Consignments brexit data guide](/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](/docs/articles/region-validation/): Our list of region codes against Sorted’s mandatory country-specific rules. - [TLS verion update](/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](/docs/articles/ups-oauth-guide/): Migrate your UPS API integrations to OAuth 2.0 authentication before August 2024 to ensure uninterrupted shipping. - [Postcode validation](/docs/articles/postcode-validation/): Our list of country postcode regex validation for our Ship product.