# Shipium API Documentation

> Documentation for Shipium API

## Guides
- [Introduction](https://docs.shipium.com/docs/introduction.md): Welcome to Shipium!
- [Get Started with Shipium](https://docs.shipium.com/docs/get-started-with-shipium.md): Shipium provides an enterprise shipping platform for modern ecommerce operations.
- [Your Shipium Account](https://docs.shipium.com/docs/your-shipium-account.md): Set up and maintain your organization's account in the Shipium Console.
- [Account Users and Roles](https://docs.shipium.com/docs/managing-users-roles.md): Manage your Shipium account users.
- [Log-In and Password](https://docs.shipium.com/docs/log-in-and-password-reset.md): Set up user log-ins and passwords for the Shipium Console.
- [Authentication](https://docs.shipium.com/docs/authentication.md): Set up your organization's authentication method to start using Shipium's services.
- [OAuth 2.0-Based Authentication](https://docs.shipium.com/docs/oauth-20-based-authentication.md): Set up your organization's OAuth clients to connect with our APIs.
- [API Key-Based Authentication](https://docs.shipium.com/docs/api-key-based-authentication.md): Set up your organization's API keys to connect with Shipium's APIs.
- [Create API Credentials](https://docs.shipium.com/docs/creating-api-credentials.md): Set up your organization's credentials to start using Shipium's APIs.
- [Use Postman with the Shipium API](https://docs.shipium.com/docs/using-your-api-credentials-with-postman.md): Use the Postman app to test Shipium API requests with both API key and OAuth 2.0 authentication.
- [SSO for Your Shipium Account](https://docs.shipium.com/docs/sso-for-your-shipium-account.md): Set up single-sign-on (SSO) log-ins for your organization's account users.
- [Configure SSO with Google Workspace](https://docs.shipium.com/docs/configure-sso-with-google-workspace.md): Set up single sign-on (SSO) logins with Google Workspace as your identity provider.
- [Configure SSO with Microsoft Azure](https://docs.shipium.com/docs/configure-sso-with-microsoft-azure.md): Set up single sign-on (SSO) logins with Azure as your identity provider.
- [Configure SSO with Okta](https://docs.shipium.com/docs/configure-sso-with-okta.md): Set up single sign-on (SSO) logins with Okta as your identity provider.
- [Certificate Authorities and Certificate Pinning](https://docs.shipium.com/docs/certificate-authorities-and-certificate-pinning.md): Set up certificate authorities for your Shipium account.
- [Shipium Console Introduction](https://docs.shipium.com/docs/shipium-console-introduction.md): Configure and maintain your organization's account in the Shipium Console.
- [Print Labels](https://docs.shipium.com/docs/print-labels.md): Print shipping and return labels directly from the Shipium Console.
- [Team Management](https://docs.shipium.com/docs/team-management.md): Manage account user and permissions for the Shipium Console.
- [Console Configuration Overview](https://docs.shipium.com/docs/shipium-configuration.md): Set up your organization's account configurations within the Shipium Console.
- [Configure | Fulfillment Configuration](https://docs.shipium.com/docs/configure-fulfillment-configuration.md): Set up and maintain your organization's fulfillment configuration within the Shipium Console.
- [Configure | Fulfillment Contexts](https://docs.shipium.com/docs/fulfillment-contexts.md): Set up and maintain your organization's fulfillment contexts within the Shipium Console.
- [Origins](https://docs.shipium.com/docs/origins.md): Set up and maintain your fulfillment network origins.
- [Carrier Contracts](https://docs.shipium.com/docs/carrier-contracts.md): Set up and maintain your fulfillment network carrier contracts.
- [Label Configuration](https://docs.shipium.com/docs/label-configuration.md): Configure shipping label properties for your fulfillment network.
- [Third Party Billing](https://docs.shipium.com/docs/third-party-billing.md): Configure your organization's account to bill another account, or third party, for the cost of shipping a package.
- [Injection](https://docs.shipium.com/docs/injection.md): Configure injection shipping sites within your fulfillment network.
- [Shipment Lanes](https://docs.shipium.com/docs/shipment-lanes.md): Configure your network for shipment lane management.
- [Configure | Packaging Configuration](https://docs.shipium.com/docs/configure-packaging-configuration.md): Determine your organization's network packaging preferences in the Shipium Console.
- [Carrier Selection](https://docs.shipium.com/docs/shipium-carrier-selection-configuration.md): Set up and maintain your organization's Carrier Selection settings within the Shipium Console.
- [Carrier Selection Shipping Report](https://docs.shipium.com/docs/carrier-selection-shipping-report.md): Access key insights into carrier selection for your organization.
- [Bulk Label Void](https://docs.shipium.com/docs/bulk-label-void.md): Void labels in bulk in one action in the Shipium Console.
- [Delivery Reporting](https://docs.shipium.com/docs/delivery-reporting.md): Monitor and investigate your shipment activity.
- [Shipment Search](https://docs.shipium.com/docs/shipment-search.md): Find shipment detail data in the Shipium Console.
- [Shipment Volume](https://docs.shipium.com/docs/shipment-volume.md): View your shipment activity over a selected time range.
- [Pack Application (Pack App)](https://docs.shipium.com/docs/pack-application-pack-app.md): Generate labels to ship packages via the Shipium Pack App.
- [Billing Management](https://docs.shipium.com/docs/billing-management.md): Shipium's billing management platform provides a comprehensive process to handle outbound parcel customer invoicing and payment collection.
- [APIs Introduction](https://docs.shipium.com/docs/apis-introduction.md): Understand the basics of Shipium's APIs.
- [API Response Codes](https://docs.shipium.com/docs/api-response-codes.md): Shipium's APIs include typical response codes.
- [Data Handling and Character Normalization](https://docs.shipium.com/docs/data-handling-and-character-normalization.md): Learn how Shipium transforms shipment data to ensure compatibility with carrier systems, including character conversions, whitespace handling, and carrier-specific restrictions.
- [Shipium's APIs](https://docs.shipium.com/docs/shipiums-apis.md): Understand which APIs suit your use cases.
- [Address Validation API](https://docs.shipium.com/docs/shipium-address-validation-api.md): Validate addresses with Shipium's Address Validation API.
- [Batch Label Creation API](https://docs.shipium.com/docs/batch-label-creation-api.md): Generate multiple shipment labels in one call with Shipium's Batch Label Creation API.
- [Carrier and Method Selection API](https://docs.shipium.com/docs/carrier-and-method-selection-api.md): Determine the carrier ship method that meets your needs with Shipium's Carrier and Method Selection API.
- [Carrier and Method Selection & Shipment Label API](https://docs.shipium.com/docs/carrier-and-method-selection-and-shipment-label-api.md): Determine carrier service method and print shipping labels all in one call with Shipium's Carrier and Method Selection & Shipment Label API.
- [Configuration APIs](https://docs.shipium.com/docs/configuration-apis.md): Modify critical components of your network configuration with Shipium's Configuration APIs.
- [Origin Configuration API](https://docs.shipium.com/docs/origin-configuration-api.md): Create and modify network origins with Shipium's Origin Configuration API.
- [Origin Schedule Configuration API](https://docs.shipium.com/docs/origin-schedule-configuration-api.md): Create and modify network origin schedules with Shipium's Origin Schedule Configuration API.
- [Delivery Promise APIs](https://docs.shipium.com/docs/delivery-promise-apis.md): Retrieve estimated delivery dates with Shipium's Delivery Promise APIs.
- [Product View Delivery Promise API](https://docs.shipium.com/docs/product-view-delivery-promise-api.md): Retrieve estimated delivery dates for product detail pages with Shipium's Product View Delivery Promise API.
- [Cart Checkout Delivery Promise API](https://docs.shipium.com/docs/cart-checkout-delivery-promise-api.md): Retrieve estimated delivery dates at cart checkout with Shipium's Cart Checkout Delivery Promise API.
- [Fulfillment Engine API](https://docs.shipium.com/docs/fulfillment-engine-api.md): Optimally fulfill orders with Shipium's Fulfillment Engine API.
- [LTL (Less Than Truckload) APIs](https://docs.shipium.com/docs/ltl-less-than-truckload-apis.md): Determine the carrier ship method that meets your LTL shipping needs and compare costs with Shipium's LTL APIs.
- [LTL Shipment Cost API](https://docs.shipium.com/docs/ltl-shipment-cost-api.md): Determine costing for less than truckload (LTL) shipments with Shipium's LTL Shipment Cost API.
- [LTL Shipment Cost Compare API](https://docs.shipium.com/docs/ltl-shipment-cost-compare-api.md): Compare the estimated cost between a less than truckload (LTL) shipment and small package shipping with Shipium's LTL Shipment Cost Compare API.
- [Packaging Planner API](https://docs.shipium.com/docs/packaging-planner-api.md): Select optimal packaging with Shipium's Packaging Planner API.
- [Pack App API](https://docs.shipium.com/docs/pack-app-api.md): Ship packages from your warehouse management system's pack stations or stores with Shipium's Pack App API.
- [Return Label API](https://docs.shipium.com/docs/return-label-api.md): Generate a return label independent of shipment label generation with Shipium's Return Label API.
- [Shipment Label API](https://docs.shipium.com/docs/shipment-label-api.md): Purchase postage and retrieve a label image with Shipium's Shipment Label API.
- [Shipment Planning API](https://docs.shipium.com/docs/shipment-planning-api.md): Determine when shipments should be shipped with Shipium's Shipment Planning API.
- [Shipment Tracking API](https://docs.shipium.com/docs/shipment-tracking-api.md): Track shipments consistently with Shipium's Shipment Tracking API.
- [Shipment Tracking Registration API](https://docs.shipium.com/docs/shipment-tracking-registration-api.md): Track non-Shipium shipments consistently with Shipium's Shipment Registration Tracking API.
- [Link API Calls Across Shipium Products](https://docs.shipium.com/docs/link-api-calls-across-shipium-products.md): Learn how to use a single identifier field to thread a consistent order identifier across Shipium' API products.
- [Delivery Promise](https://docs.shipium.com/docs/delivery-promise.md): Configure your account to use Shipium's Delivery Promise service.
- [Shipment Planning](https://docs.shipium.com/docs/shipment-planning.md): Ship customer products to meet desired delivery dates.
- [Time in Transit Estimations](https://docs.shipium.com/docs/time-in-transit-estimations.md): Understand a critical element of Shipium's estimated delivery date: time in transit (TNT) estimations.
- [Fulfillment Engine](https://docs.shipium.com/docs/fulfillment-engine.md): Configure your account to use Shipium's Fulfillment Engine service.
- [Address Validation](https://docs.shipium.com/docs/address-validation.md): Validate addresses before shipment and label generation.
- [Packaging Planner](https://docs.shipium.com/docs/packaging-planner.md): Select optimal packaging for your shipments.
- [Carrier Network](https://docs.shipium.com/docs/carrier-network.md): Integrate with Shipium's network of carriers and delivery service methods.
- [Amazon](https://docs.shipium.com/docs/amazon.md): Ensure you have provided credentials to ship with Amazon.
- [Sample API Call using Amazon](https://docs.shipium.com/docs/sample-api-call-using-amazon.md): Include required information when shipping with Amazon carrier services in your calls to Shipium's APIs.
- [AMPM](https://docs.shipium.com/docs/ampm.md): Ensure you have provided required credentials to ship with AMPM.
- [APC Postal Logistics](https://docs.shipium.com/docs/apc-postal-logistics.md): Ensure you have provided credentials to ship with APC Postal Logistics.
- [Canada Post](https://docs.shipium.com/docs/canada-post.md): Set up your billing account for Canada Post.
- [Cirro](https://docs.shipium.com/docs/cirro.md): Ensure you have provided required credentials to ship with Cirro.
- [DHL](https://docs.shipium.com/docs/dhl.md): Declare a value for packages when shipping with DHL.
- [DoorDash](https://docs.shipium.com/docs/doordash.md): Ensure you have provided credentials to ship with DoorDash.
- [Envoi](https://docs.shipium.com/docs/envoi.md): Ensure you have provided required credentials to ship with Envoi.
- [Estafeta](https://docs.shipium.com/docs/estafeta.md): Ensure you have provided required credentials to ship with Estafeta.
- [FedEx](https://docs.shipium.com/docs/fedex.md): Ensure your FedEx account is registered and verified, and create FedEx shipping labels.
- [Global-e](https://docs.shipium.com/docs/global-e.md): Ensure you have provided required credentials to ship with Global-e.
- [LaserShip](https://docs.shipium.com/docs/lasership.md): Ensure you have provided required credentials to ship with LaserShip.
- [Maersk](https://docs.shipium.com/docs/maersk.md): Ensure you have provided required credentials to ship with Maersk.
- [OnTrac](https://docs.shipium.com/docs/ontrac.md): Ensure you have provided credentials to ship with OnTrac.
- [OpenBorder](https://docs.shipium.com/docs/openborder.md): Ensure you have provided required credentials to ship with OpenBorder.
- [Paquetexpress](https://docs.shipium.com/docs/paquetexpress.md): Ensure you have provided required credentials to ship with Paquetexpress.
- [Purolator E-Ship](https://docs.shipium.com/docs/purolator-e-ship.md): Ensure you have provided required credentials to ship with Purolator E-Ship.
- [TikTok Shop](https://docs.shipium.com/docs/tiktok-shop.md): Ensure you have provided credentials to ship with TikTok Shop.
- [Uber Direct](https://docs.shipium.com/docs/uber-direct.md): Ensure you have provided required credentials to ship with Uber Direct.
- [UPS](https://docs.shipium.com/docs/ups.md): Ensure your UPS account is registered and verified.
- [USPS](https://docs.shipium.com/docs/usps-direct.md): Configure your account to use USPS service methods.
- [Supported Carriers](https://docs.shipium.com/docs/supported-carriers.md): Search Shipium's existing carrier network.
- [Carrier and Method Selection & Shipment Labels](https://docs.shipium.com/docs/carrier-method-selection-label-single-call.md): Configure your account to select the best carrier service method for your shipment, generate a shipping label, or do both at once.
- [Carrier and Method Selection](https://docs.shipium.com/docs/carrier-and-method-selection.md): Configure your account to use Shipium's Carrier and Method Selection service.
- [Additional Days to Hold a Shipment](https://docs.shipium.com/docs/additional-days-to-hold-a-shipment.md): Optionally include maximum additional days to hold a shipment at your fulfillment center in your calls to Shipium's APIs.
- [Bill a Third Party](https://docs.shipium.com/docs/bill-a-third-party.md): Configure your organization's account to bill another account, or third party, for the cost of shipping a package.
- [Bound Printed Matter](https://docs.shipium.com/docs/bound-printed-matter-support.md): Designate the contents of a package as bound printed matter when calling the Shipium APIs.
- [Business Days of Transit](https://docs.shipium.com/docs/business-days-of-transit.md): Optionally provide a value for expected business days of transit in your calls to Shipium's APIs.
- [Cancel a Shipment](https://docs.shipium.com/docs/cancel-a-shipment.md): Cancel a shipment, cancel carrier selection, and/or void a label.
- [Carrier Failover](https://docs.shipium.com/docs/carrier-failover.md): Designate a carrier as being allowed to fail over when there is an issue with a call to the carrier.
- [Carrier Selection Rules](https://docs.shipium.com/docs/carrier-selection-rules.md): Configure your organization's delivery zone rules.
- [Cubic Rating](https://docs.shipium.com/docs/cubic-rating.md): Learn about cubic rating in the Shipium platform.
- [Customs Info for Shipments](https://docs.shipium.com/docs/customs-info-api-example-definitions.md): Provide customs details about your package in your API calls.
- [Broker & Importer of Record](https://docs.shipium.com/docs/broker-importer-of-record.md): Optionally include customs information related to broker and importer of record in your API call.
- [Tax Identification Number](https://docs.shipium.com/docs/tax-identification-number.md): Include a tax identification number to associate with your shipments.
- [Desired, Exact, & Guaranteed Delivery Dates](https://docs.shipium.com/docs/desired-and-exact-delivery-dates.md): Pass optional desired, exact, and guaranteed delivery dates in your calls to Shipium's APIs.
- [Evaluated Service Methods](https://docs.shipium.com/docs/evaluated-service-methods.md): Review carriers and service methods that were evaluated but not selected for a shipment.
- [Hazardous Materials](https://docs.shipium.com/docs/hazardous-materials-support.md): Designate the contents of a package as hazmat when calling the Shipium APIs.
- [Hundredweight](https://docs.shipium.com/docs/hundredweight-support.md): Configure your account to support hundredweight shipping and designate a package as hundredweight when calling the Shipium APIs.
- [Label to Dock Door Hours](https://docs.shipium.com/docs/label-to-dock-door-hours.md): Optionally include the amount of time required between printing a label and having the package at the dock door at your fulfillment center in your calls to Shipium's APIs.
- [LTL (Less Than Truckload) Shipments](https://docs.shipium.com/docs/ltl-less-than-truckload-shipments.md): Configure your account to use Shipium's LTL APIs.
- [Manifest Shipments](https://docs.shipium.com/docs/shipment-manifesting.md): Manifest shipments via an automated or manual manifesting process.
- [Multi-Parcel Shipments](https://docs.shipium.com/docs/multi-parcel-shipments.md): Select the best carrier service method for your multi-parcel shipment, with or without generating a label, and link the packages together with one tracking number.
- [Non-US Address Formats](https://docs.shipium.com/docs/non-us-address-formats.md): Specify addresses for non-U.S. shipping.
- [Partial (Multi-Step) Shipments](https://docs.shipium.com/docs/partial-shipments.md): Create shipments with partial information, and patch data for complete shipments at a later time.
- [Peak and Other Carrier Surcharges](https://docs.shipium.com/docs/peak-and-other-carrier-surcharges.md): Configure carrier surcharges for your organization's account.
- [Perishable Items](https://docs.shipium.com/docs/perishable-item-support.md): Designate the contents of a package as containing one or more perishable items when calling the Shipium APIs.
- [Reference Fields and Carrier Mappings](https://docs.shipium.com/docs/reference-fields-and-carrier-mappings.md): Pass additional information to carriers via data fields to be associated with a shipment.
- [Schedule and Shipment Limits](https://docs.shipium.com/docs/schedule-and-shipment-limits.md): Configure your account to establish carrier schedule, shipment count, and shipment cost limits.
- [Carrier Schedule](https://docs.shipium.com/docs/carrier-schedule.md): Control carrier schedule selection associated with the inclusion of a desired delivery date or business days of transit.
- [Dynamic Shipment Count Limits](https://docs.shipium.com/docs/dynamic-shipment-count-limits.md): Configure your account to establish dynamic shipment count limits.
- [Shipment Cost Limits](https://docs.shipium.com/docs/shipment-cost-limits.md): Control shipment costs associated with the inclusion of a desired delivery date or business days of transit.
- [Shipment Count Limits](https://docs.shipium.com/docs/shipment-count-limits.md): Configure your account to establish shipment count limits.
- [Service Endorsements](https://docs.shipium.com/docs/service-endorsements.md): Include an optional service endorsement in your calls to Shipium's APIs.
- [Ship Options](https://docs.shipium.com/docs/shipment-ship-option-overview.md): Specify a ship option in your API call.
- [Configurable Ship Options](https://docs.shipium.com/docs/configurable-ship-options.md): Define your own ship option(s) from your available carrier methods.
- [Shipium Default Ship Options](https://docs.shipium.com/docs/shipium-default-ship-options.md): Explore Shipium's default ship options.
- [Special Processing Properties](https://docs.shipium.com/docs/shipment-special-processing-properties.md): Associate a special processing property with your shipment.
- [Specify Carrier Service and Method](https://docs.shipium.com/docs/specifying-carrier-service-and-method.md): Limit the set of carrier methods available when choosing a carrier and method for a shipment.
- [Specifying Payors](https://docs.shipium.com/docs/specifying-payors.md): Bill multiple payor accounts for the cost of different components of shipping a package.
- [Understanding Weight Fields](https://docs.shipium.com/docs/understanding-weight-fields.md): Understand key weight fields in the Shipium platform.
- [Weekend and Holiday Delivery](https://docs.shipium.com/docs/weekend-and-holiday-delivery.md): Learn how to configure your shipment requests to achieve the desired delivery behavior for weekend and holiday deliveries.
- [Pack Application](https://docs.shipium.com/docs/pack-application.md): Ship packages from your warehouse pack stations or stores using Shipium's Pack App.
- [Shipment Labels](https://docs.shipium.com/docs/carrier-shipment-label-flow.md): Configure your account to use Shipium's Shipment Label service.
- [Custom Document Generation](https://docs.shipium.com/docs/custom-document-generation.md): Generate packing slips and way bills as part of your existing carrier selection API workflow using Document Blueprints.
- [Label Customization](https://docs.shipium.com/docs/label-customization.md): Add or modify information on the shipping label that is returned from the carrier.
- [Common Label Augmentations](https://docs.shipium.com/docs/common-label-augmentations.md): Create common augmentations for shipping labels.
- [Label Test Mode](https://docs.shipium.com/docs/understanding-carrier-selection-label-test-mode.md): Retrieve labels for testing and validation without being charged by the carriers.
- [Labels without Costing](https://docs.shipium.com/docs/labels-without-costing.md): Generate labels without carrier service method rates.
- [Return Labels](https://docs.shipium.com/docs/return-labels.md): Provide shipment labels for your customers to return products.
- [Void a Label](https://docs.shipium.com/docs/voiding-a-specific-label.md): Void a shipment label.
- [Track and Trace](https://docs.shipium.com/docs/track-and-trace.md): An overview of Shipium's Track and Trace service, including capabilities, a quick start guide, and links to all tracking documentation
- [How Tracking Works](https://docs.shipium.com/docs/how-tracking-works.md): Learn how Shipium collects, normalizes, and delivers tracking data across carriers.
- [Getting Started with Tracking](https://docs.shipium.com/docs/getting-started-with-tracking.md): A step-by-step guide to integrating with Shipium's Track and Trace service, including authentication, tracking Shipium-labeled shipments, registering non-Shipium shipments, and setting up webhook notification
- [Tracking Troubleshooting Guide](https://docs.shipium.com/docs/tracking-troubleshooting-guide.md): Answers to frequently asked questions about Shipium's Track and Trace service, including a verification checklist, status transition reference, and error codes
- [Shipium Webhooks](https://docs.shipium.com/docs/webhook-registration.md): Receive real-time event notifications from Shipium at an endpoint you specify.
- [Webhooks for Carrier Selection & Label Updates](https://docs.shipium.com/docs/webhooks-for-carrier-selection-label-updates.md): Automatically receive updates for carrier selection and/or label generation events.
- [Webhooks for Tracking](https://docs.shipium.com/docs/webhooks-for-tracking-updates.md): Automatically receive tracking updates as they occur.
- [Webhooks for Billing Management](https://docs.shipium.com/docs/webhooks-for-billing-management.md): Automatically receive updates for Billing Management invoice events.
- [Webhooks for Pack App Order Lifecycle](https://docs.shipium.com/docs/webhooks-for-pack-app-order-lifecycle.md): Automatically receive updates for the Pack App order lifecycle.
- [Configure Custom HTTP Headers for Webhooks](https://docs.shipium.com/docs/configure-custom-http-headers-for-webhooks.md): Send custom HTTP headers with every webhook request Shipium delivers to your endpoint.
- [Simulation](https://docs.shipium.com/docs/simulation.md): Configure your account to use Shipium's Simulation service.
- [Export Shipment Data](https://docs.shipium.com/docs/export-shipment-data.md): Export shipment data from the Shipium Console.
- [Shipment File Transfers](https://docs.shipium.com/docs/shipium-historical-shipment-file-transfer.md): Transfer historical data to improve training.
- [Carrier Selection without Label Generation](https://docs.shipium.com/docs/carrier-selection-without-label-generation.md): If you use Shipium's Carrier Selection service without generating labels, this document offers best practices for providing your shipment data.
- [Reporting Product Overview](https://docs.shipium.com/docs/reporting-product-overview.md): Learn more about Shipium reporting.
- [Delivery Speed Dashboards](https://docs.shipium.com/docs/delivery-speed-dashboards.md): View reports that provide delivery speed performance.
- [Label Failovers Dashboards](https://docs.shipium.com/docs/label-failovers-dashboards.md): View reports for label failovers and their associated costs.
- [Label Generation Dashboards](https://docs.shipium.com/docs/label-generation-dashboards.md): View reports for generated labels and their associated costs.
- [On-Time Performance Dashboards](https://docs.shipium.com/docs/on-time-performance-dashboards.md): View reports that measure actual delivery date performance against desired delivery date.
- [Rate Shop Selections Dashboards](https://docs.shipium.com/docs/rate-shop-selections-dashboards.md): View reports for rates selected as part of Shipium’s Carrier Selection.
- [Selected vs. Evaluated Dashboards](https://docs.shipium.com/docs/selected-vs-evaluated-dashboards.md): View reports that compare selected shipping rates against evaluated alternatives.
- [Shipment Cost Breakdown Dashboards](https://docs.shipium.com/docs/shipment-cost-breakdown-dashboards.md): View reports that provide a detailed breakdown of rate shop selections.
- [Introduction to Shipium Orca AI Analytics](https://docs.shipium.com/docs/introduction-to-shipium-orca-ai-analytics.md): Orca Analytics is Shipium's AI co-pilot that lets you ask questions about your shipping data and get instant, actionable insights.
- [Orca AI Assistant](https://docs.shipium.com/docs/copy-of-orca-ai-assistant.md): The Orca AI Assistant is a conversational interface for exploring your shipping data and generating custom visualizations.
- [Orca AI Agent Tips & Best Practices](https://docs.shipium.com/docs/orca-ai-agent-tips-best-practices.md)
- [Sample Orca AI Agent Questions and Examples](https://docs.shipium.com/docs/sample-orca-ai-agent-questions-and-examples.md)
- [Shipium Orca AI Analytics Dashboards](https://docs.shipium.com/docs/shipium-orca-ai-analytics-dashboards.md): This guide covers the common interface elements and features shared across all Orca AI Analytics dashboards.
- [Shipium Orca AI Carrier & Label Analytics](https://docs.shipium.com/docs/shipium-orca-ai-carrier-label-analytics.md): Use Shipium's AI-powered analytics platform to understand the dynamics of your carriers and shipments.
- [Shipment Cost Dashboard](https://docs.shipium.com/docs/shipment-cost-dashboard.md): Track and analyze your shipping costs by cost component, carrier, geography, and time period.
- [Shipment Volume Dashboard](https://docs.shipium.com/docs/shipment-volume-dashboard.md): Analyze outbound shipment volume trends across carriers, service methods, and geographic destinations to understand distribution patterns and inform carrier strategies.
- [Delivery Speed Dashboard](https://docs.shipium.com/docs/delivery-speed-dashboard.md): Shipium Orca AI Analytics Carrier & Shipment delivery speed dashboard overview.
- [Rate Shop Selections Dashboard](https://docs.shipium.com/docs/rate-shop-selections.md): Shipium Navi AI Analytics Carrier & Shipment rate shop selections dashboard overview.
- [On-Time Delivery Dashboard](https://docs.shipium.com/docs/on-time-performance-dashboard.md): Monitor on-time delivery rates across carriers, service levels, origins, and destinations to identify performance issues and track trends over time.
- [Selected vs. Evaluated Carrier Selections Dashboard](https://docs.shipium.com/docs/selected-vs-evaluated-carrier-selections.md): Compare selected carrier rates against second-best alternatives to measure cost savings, analyze carrier mix, and evaluate routing engine effectiveness.
- [Delivery Status Dashboard](https://docs.shipium.com/docs/delivery-status-dashboard.md): Monitor delivery performance for recently shipped packages, track shipment aging, and identify at-risk shipments by carrier, geography, and status.
- [Label Failover Dashboard](https://docs.shipium.com/docs/label-failover-dashboard.md): Shipium Navi AI Analytics Carrier & Shipment label failover dashboard overview.
- [Shipium Orca AI Personal Metrics](https://docs.shipium.com/docs/shipium-orca-ai-personal-metrics.md): Save and share custom metrics and graphs with other users in your organization.
- [FAQ & Troubleshooting Shipium Orca AI Analytics](https://docs.shipium.com/docs/faq-troubleshooting-shipium-orca-ai-analytics.md): Find troubleshooting tips and answers to frequently asked questions about Orca AI Analytics.
- [Contact Shipium Support](https://docs.shipium.com/docs/contacting-shipium-support.md): Submit tickets for issue resolution via our Shipium customer support Help Center.
- [FAQs](https://docs.shipium.com/docs/faqs.md): Find answers to frequently asked questions.
- [Peak Season FAQ](https://docs.shipium.com/docs/peak-season-faq.md): Find answers to frequently asked questions about peak season.
- [Shipium Service Status](https://docs.shipium.com/docs/shipium-service-status.md): Check Shipium's service status.
- [Terms and Definitions](https://docs.shipium.com/docs/common-terms.md): Learn definitions for Shipium's common terminology.
- [Troubleshooting Guide](https://docs.shipium.com/docs/troubleshooting-guide.md): Troubleshoot issues for your Shipium account.
- [Overview of Shipium Javascript Local API](https://docs.shipium.com/docs/overview-of-shipium-javascript-local-api.md)
- [Integration into Your Site](https://docs.shipium.com/docs/integration-into-your-site.md)
- [API Listing](https://docs.shipium.com/docs/api-listing.md)
- [Get a Delivery Estimate](https://docs.shipium.com/docs/get-a-delivery-estimate.md)
- [Register a Customer Order](https://docs.shipium.com/docs/register-a-customer-order.md)
- [MCP](https://docs.shipium.com/docs/mcp.md)

## API Reference
- [Simple ping endpoint which will respond with a status of 1, and info of pong when all authenticationand authorizations at the OAuth level are valid.](https://docs.shipium.com/reference/ping-1.md)
- [Simple ping endpoint which will respond with a status of 1, and info of pong when all authenticationand authorizations at the OAuth level are valid.](https://docs.shipium.com/reference/trackingpingv1.md)
- [Product View Delivery Estimate](https://docs.shipium.com/reference/createdeliveryestimate.md): Report a product page view and retrieve a Delivery Estimate.
- [Get Delivery Estimate](https://docs.shipium.com/reference/getdeliveryestimate.md): Get a delivery estimate created from a product view.  Warning: this endpoint doesn't guarantee that the deliveryEstimateId can always be found immediately after being created from POST /productview.
- [Cart Delivery Date Estimate](https://docs.shipium.com/reference/calculatecartestimateddeliverydate.md): Calculate the Estimated Delivery Date for a cart with multiple origins with inventory
- [Create Shipment](https://docs.shipium.com/reference/shipmentcreatev1.md): Create a shipment from a set of existing Delivery Estimates and quantities.
- [Get Shipment](https://docs.shipium.com/reference/shipmentgetv1.md): Get a Shipment using the shipiumShipmentId or the partnerShipmentId if one was provided.
- [Cancel Shipment](https://docs.shipium.com/reference/shipmentcancelv1.md): Cancel a Shipment using the shipiumShipmentId or the partnerShipmentId.
- [Update Shipment](https://docs.shipium.com/reference/shipmentupdatev1.md): Add delivery information to a Shipment using the shipiumShipmentId or the partnerShipmentId if one was provided.
- [All-in-one Cancel](https://docs.shipium.com/reference/cancelv1.md): All in one cancel endpoint which allows users to cancel a shipment, cancel a carrier selection, or cancel and void a label. All three cancellations can be done at once with a cascading cancel.
- [Get Shipment Events](https://docs.shipium.com/reference/shipmentgeteventsv1.md): Get a Shipment, in each possible webhook event format, using the shipiumShipmentId or the partnerShipmentId if one was provided.
- [Shipment Planning API](https://docs.shipium.com/reference/shipmentplanning-1.md): Determine when a shipment should drop to the fc and ship by to arrive by a date.
- [Create an order.](https://docs.shipium.com/reference/createorderv1.md)
- [Retrieve an order.](https://docs.shipium.com/reference/getorderv1.md)
- [Update an existing order.](https://docs.shipium.com/reference/updateorderv1.md)
- [Delete an order.](https://docs.shipium.com/reference/deleteorderv1.md)
- [Search for existing orders.](https://docs.shipium.com/reference/searchordersv1.md)
- [All in one mega endpoint which allows end users to create a shipment, run carrier selection, and have the carrier generate a label based on the service level selected.](https://docs.shipium.com/reference/runmegashipmentprocessv1.md)
- [Run the carrier selection process on a existing partner shipment.](https://docs.shipium.com/reference/createcarrierselectionv1.md)
- [Retrieve a existing carrier selection.](https://docs.shipium.com/reference/getcarrierselectionv1.md)
- [Cancel an existing carrier selection.](https://docs.shipium.com/reference/cancelcarrierselectionv1.md)
- [Retrieve a list of existing carrier selections.](https://docs.shipium.com/reference/getcarrierselectionsv1.md)
- [Retrieve a previously generated shipment label.  This call is the metadata about the label, the images of the labels must be asked for specifically in the call, or directly using the `getLabelImageV1` call.](https://docs.shipium.com/reference/getlabelshortcutv1.md)
- [Manifest a previously generated shipment label shorcut version where only the shipiumLabelId is required.](https://docs.shipium.com/reference/manifestlabelshortcutv1.md)
- [Streams pdf formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpdflabelimageshortcutv1_1.md)
- [Streams png formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpnglabelimageshortcutv1_1.md)
- [Streams zpl formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getzpllabelimageshortcutv1.md)
- [Based on the carrier service selected for the shipment, a label in the formats provided by the end user will be generated and stored for alter retrieval from the carrier.](https://docs.shipium.com/reference/labelcreatev1.md)
- [Retrieve a previously generated shipment label.  This call is the metadata about the label, the images of the labels must be asked for specifically in the call, or directly using the `getLabelImageV1` call.](https://docs.shipium.com/reference/getlabelv1.md)
- [Patch a previously generated shipment label. Fields that are present in the patch will be upserted against the existing label.](https://docs.shipium.com/reference/patchlabelv1.md)
- [Manifest a previously generated shipment label.](https://docs.shipium.com/reference/manifestlabelv1.md)
- [Streams pdf formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpdflabelimagev1.md)
- [Streams png formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpnglabelimagev1_1.md)
- [Streams zpl formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getzpllabelimagev1.md)
- [Void a previously generated shipment label.](https://docs.shipium.com/reference/voidlabelv1.md)
- [Void a previously generated shipment label using the shipiumLabelId or carrierTrackingId.](https://docs.shipium.com/reference/voidlabelrpcv1.md)
- [Import a batch of labels into Shipium's system that were created outside of Shipium. There must be a shipment and a carrier selection already created within Shipium's system that each label can be associated with.](https://docs.shipium.com/reference/batchlabelimportv1.md)
- [Streams pdf formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpdflabelimageshortcutv1.md)
- [Streams png formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpnglabelimageshortcutv1.md)
- [Streams zpl formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getzpllabelimageshortcutv1_1.md)
- [Retrieve a single page of generated shipment labels that match the supplied parameters. This call is the metadata about the labels, the images of the labels must be asked for in the call, or directly using the `getLabelImageV1` call.](https://docs.shipium.com/reference/searchlabelsv1.md)
- [Streams pdf formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpdflabelimagev1_1.md)
- [Streams png formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getpnglabelimagev1.md)
- [Streams zpl formatted version of a previously requested carrier label.](https://docs.shipium.com/reference/getzpllabelimagev1_1.md)
- [Import a label into Shipium's system that was created outside of Shipium. There must be a shipment and a carrier selection already created within Shipium's system that the label can be associated with.](https://docs.shipium.com/reference/labelimportv1.md)
- [Set the partner manifest id and timestamp for any (matching) labels that meet the supplied criteria, are eligible for manifesting, and have not been manifested.](https://docs.shipium.com/reference/endofdaymanifestv1.md)
- [Update the cost of a previously generated shipment label.](https://docs.shipium.com/reference/updatelabelcostv1.md)
- [Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.](https://docs.shipium.com/reference/searchltlcostsv1_1.md)
- [Retrieve the cost for a LTL shipment.](https://docs.shipium.com/reference/createltlcostv1.md)
- [Retrieve an existing LTL shipment cost or cost comparison.](https://docs.shipium.com/reference/getltlcostv1.md)
- [Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.](https://docs.shipium.com/reference/searchltlcostsv1.md)
- [Retrieve the costs for a shipment using either LTL or parcel shipping.](https://docs.shipium.com/reference/createltlcostcomparev1.md)
- [Retrieve an existing LTL shipment cost or cost comparison.](https://docs.shipium.com/reference/getltlcostv1_1.md)
- [Manifest all shipments for a carrier.](https://docs.shipium.com/reference/manifestbycarrier.md)
- [Download manifest report from carrier](https://docs.shipium.com/reference/downloadmanifestbycarrier.md)
- [Calls the partner's configured returns service to create a return label.](https://docs.shipium.com/reference/returnslabelcreatev1.md)
- [Retrieve a previously generated returns label.  This call is the metadata about the label, the images of the labels must be asked for specifically in the call, or directly using the `getReturnsLabelImageV1` call.](https://docs.shipium.com/reference/returnsgetlabelv1.md)
- [Streams pdf formatted version of a previously requested return label.](https://docs.shipium.com/reference/getpdfreturnslabelimagev1.md)
- [Streams png formatted version of a previously requested return label.](https://docs.shipium.com/reference/getpngreturnslabelimagev1_1.md)
- [Streams zpl formatted version of a previously requested return label.](https://docs.shipium.com/reference/getzokreturnslabelimagev1_1.md)
- [Streams pdf formatted version of a previously requested return label.](https://docs.shipium.com/reference/getpdfreturnslabelimagev1_1.md)
- [Streams png formatted version of a previously requested return label.](https://docs.shipium.com/reference/getpngreturnslabelimagev1.md)
- [Streams zpl formatted version of a previously requested return label.](https://docs.shipium.com/reference/getzokreturnslabelimagev1.md)
- [/api/v1/packaging/planner](https://docs.shipium.com/reference/postapiv1packagingplanner.md)
- [Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId](https://docs.shipium.com/reference/gettrackingbyshipiumtrackingid.md)
- [Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId](https://docs.shipium.com/reference/gettrackingbycarrieridandcarriertrackingid.md)
- [Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId in bulk](https://docs.shipium.com/reference/bulksearchtrackingsbyshipiumtrackingids.md)
- [/api/v1/tracking/bulkPartnerShipmentIdSearch](https://docs.shipium.com/reference/bulksearchbytrackingsbypartnershipmentids.md)
- [Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId in bulk](https://docs.shipium.com/reference/bulksearchtrackings.md)
- [Tracking registration endpoint to start tracking a shipment shipium did not create](https://docs.shipium.com/reference/registertracking.md)
- [Tracking registration endpoint to start tracking shipments shipium did not create](https://docs.shipium.com/reference/bulkregistertracking_1.md)
- [Determine if an address is a valid mailing address](https://docs.shipium.com/reference/validatev1.md)
- [Creates an order to be packed.](https://docs.shipium.com/reference/createpackshiporderorchestrationv1.md)
- [Search for existing orders.](https://docs.shipium.com/reference/searchpackshiporderorchestrationv1.md)
- [Get an existing order.](https://docs.shipium.com/reference/getpackshiporderorchestrationv1.md)
- [Cancel an existing order.](https://docs.shipium.com/reference/cancelpackshiporderorchestrationv1.md)
- [Updates an order to be packed.](https://docs.shipium.com/reference/patchpackshiporderorchestrationv1.md)
- [Pack and ship order.](https://docs.shipium.com/reference/packshiporderorchestrationv1.md)
- [Ping](https://docs.shipium.com/reference/pingv1_1.md): Simple ping endpoint which will respond with a status of 1, and info of pong when all authentication and authorizations at the OAuth level are valid.
- [A synchronous bulk orchestration in front of the MegaShipmentProcess, allowing concurrent requests to be created and return results together. Please note that this endpoint is will block while the the full request is completely processed. Failures will not block and are returned alongside the results.](https://docs.shipium.com/reference/bulklabelgenerationv1.md)
- [Ping](https://docs.shipium.com/reference/pingv1.md): Simple ping endpoint which will respond with a status of 1, and info of pong when all authentication and authorizations at the OAuth level are valid.

## Recipes
- [Authenticate and Retrieve an OAuth Token](https://docs.shipium.com/recipes/authenticate-and-retrieve-an-oauth-token.md)
- [Authenticating for Curl](https://docs.shipium.com/recipes/authenticating-for-curl.md)
- [Call Ping (using API Key)](https://docs.shipium.com/recipes/call-ping-using-api-key.md)
- [Call Ping (using OAuth)](https://docs.shipium.com/recipes/call-ping-using-oauth.md)

## Changelog
- [Enhanced Documentation Guides](https://docs.shipium.com/changelog/enhanced-documentation-guides.md)
- [Welcome to Shipium API](https://docs.shipium.com/changelog/welcome-to-shipium-api.md)
- [Welcome to Shipium Shiptime](https://docs.shipium.com/changelog/welcome-to-shipium-shiptime.md)