docs/
294 pages · Updated July 7, 2026
Pages
- Shipment File Transfers
- 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.
- OnTrac
- Label Settings
- Origin Configuration API
- Surcharge Modifiers
- Rate Tables
- Update an existing order.
- Create Shipment
- Carrier Service Methods
- Retrieve an order.
- Update Shipment
- Cart Delivery Date Estimate
- Create an order.
- Shipment Planning API
- Carrier Failover
- Product View Delivery Estimate
- Carrier Limits
- All-in-one Cancel
- Get Shipment Events
- Carrier Accounts
- Cancel Shipment
- Get Shipment
- Get Delivery Estimate
- Injection
- 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.
- Run the carrier selection process on a existing partner shipment.
- Streams pdf formatted version of a previously requested carrier label.
- Carrier Selection
- Multi-Parcel Shipments
- 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.
- Cancel an existing carrier selection.
- Retrieve a existing carrier selection.
- Search for existing orders.
- Delete an order.
- Welcome to Shipium Shiptime
- Retrieve a list of existing carrier selections.
- Enhanced Documentation Guides
- Welcome to Shipium API
- Determine if an address is a valid mailing address
- Tenants
- account-users-and-roles
- Package Sizes
- Packaging Planner
- Webhooks for Carrier Selection & Label Updates
- partial-shipments
- Webhooks for Tracking
- Hundredweight
- simulation
- Bill a Third Party
- Peak and Other Carrier Surcharges
- 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.
- Webhooks for Pack App Order Lifecycle
- Creates an order to be packed.
- Pack and ship order.
- Updates an order to be packed.
- Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId in bulk
- Download manifest report from carrier
- /api/v1/ping
- Streams pdf formatted version of a previously requested carrier label.
- Streams pdf formatted version of a previously requested return label.
- Ping
- 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.
- /api/v1/packaging/planner
- webhooks-for-billing-management
- Calls the partner's configured returns service to create a return label.
- 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.
- /api/v1/packaging/ping
- Retrieve an existing LTL shipment cost or cost comparison.
- Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.
- Streams pdf formatted version of a previously requested return label.
- billing-management
- Search for existing orders.
- Streams png formatted version of a previously requested carrier label.
- Manifest all shipments for a carrier.
- Carrier Contracts
- Streams zpl formatted version of a previously requested return label.
- Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.
- Update the cost of a previously generated shipment label.
- Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId in bulk
- Tracking registration endpoint to start tracking shipments shipium did not create
- Retrieve an existing LTL shipment cost or cost comparison.
- Streams png formatted version of a previously requested return label.
- Shipment File Transfers
- 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.
- Streams zpl formatted version of a previously requested carrier label.
- Sample API Call using Amazon
- Tracking registration endpoint to start tracking a shipment shipium did not create
- Streams png formatted version of a previously requested carrier label.
- Streams zpl formatted version of a previously requested return label.
- Update the specified carrier labels with the carrier and Shipium manifest ids.
- Ping
- Get an existing order.
- ManifestControllerV1
- Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId
- Weekend and Holiday Delivery
- Cancel an existing order.
- Retrieve Shipium details for a previously generated shipment label.
- /api/v1/tracking/bulkPartnerShipmentIdSearch
- 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.
- Streams png formatted version of a previously requested return label.
- 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.
- Shipium Orca AI Personal Metrics
- Void a previously generated shipment label using the shipiumLabelId or carrierTrackingId.
- Streams pdf formatted version of a previously requested carrier label.
- Return Label API
- Streams zpl formatted version of a previously requested carrier label.
- pack-application-pack-app
- Label Failover Dashboard
- Void a previously generated shipment label.
- Export Shipment Data
- Common Label Augmentations
- Cart Checkout Delivery Promise API
- FAQs
- Hazardous Materials
- API Response Codes
- Contact Shipium Support
- Getting Started with Tracking
- Custom Document Generation
- Terms and Definitions
- Retrieve the cost for a LTL shipment.
- Register a Customer Order
- Delivery Speed Dashboards
- Dynamic Shipment Count Limits
- How Tracking Works
- MCP
- Non-US Address Formats
- Shipment Volume Dashboard
- Carrier and Method Selection API
- Broker & Importer of Record
- Peak Season FAQ
- Get a Delivery Estimate
- Label Failovers Dashboards
- Manifest a previously generated shipment label.
- Tracking Troubleshooting Guide
- Amazon
- Streams png formatted version of a previously requested carrier label.
- On-Time Performance Dashboards
- Label Generation Dashboards
- Retrieve the costs for a shipment using either LTL or parcel shipping.
- Shipment Cost Dashboard
- Streams pdf formatted version of a previously requested carrier label.
- Shipium Orca AI Analytics Dashboards
- Uber Direct
- Patch a previously generated shipment label. Fields that are present in the patch will be upserted against the existing label.
- Selected vs. Evaluated Carrier Selections Dashboard
- Shipment Cost Breakdown Dashboards
- Troubleshooting Guide
- Business Days of Transit
- Delivery Speed Dashboard
- FedEx
- 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.
- Rate Shop Selections Dashboard
- Delivery Status Dashboard
- Customs Info for Shipments
- Selected vs. Evaluated Dashboards
- 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.
- Labels without Costing
- Rate Shop Selections Dashboards
- USPS
- configure-fulfillment-configuration
- Streams png formatted version of a previously requested carrier label.
- On-Time Delivery Dashboard
- Reporting Product Overview
- evaluated-service-methods
- Configure Custom HTTP Headers for Webhooks
- Tax Identification Number
- Label Customization
- Shipment Search
- Manifest Shipments
- Orca AI Assistant
- Shipment Cost Limits
- Origin Schedule Configuration API
- FAQ & Troubleshooting Shipium Orca AI Analytics
- Fulfillment Engine
- Integration into Your Site
- Shipium Orca AI Carrier & Label Analytics
- Sample Orca AI Agent Questions and Examples
- Overview of Shipium Javascript Local API
- Shipium Service Status
- API Listing
- Carrier Selection without Label Generation
- shipment-label-api
- Orca AI Agent Tips & Best Practices
- Desired, Exact, & Guaranteed Delivery Dates
- Understanding Weight Fields
- Carrier and Method Selection
- Shipment Count Limits
- Product View Delivery Promise API
- Introduction to Shipium Orca AI Analytics
- UPS
- Pack Application
- Shipment Labels
- Label Test Mode
- Void a Label
- Track and Trace
- Shipment Tracking Registration API
- Shipium Webhooks
- Configure | Fulfillment Contexts
- Packaging Planner
- Perishable Items
- Shipium Default Ship Options
- Ship Options
- Time in Transit Estimations
- Canada Post
- Service Endorsements
- Shipium's APIs
- Reference Fields and Carrier Mappings
- Carrier and Method Selection & Shipment Labels
- Print Labels
- Cancel a Shipment
- TikTok Shop
- Specify Carrier Service and Method
- Link API Calls Across Shipium Products
- Schedule and Shipment Limits
- Configure SSO with Microsoft Azure
- Carrier Network
- Carrier Schedule
- Label to Dock Door Hours
- Shipment Lanes
- Bound Printed Matter
- LTL (Less Than Truckload) Shipments
- Return Labels
- Configure SSO with Google Workspace
- Paquetexpress
- Third Party Billing
- Purolator E-Ship
- DHL
- Delivery Promise
- Shipment Planning
- Bulk Label Void
- APIs Introduction
- LTL (Less Than Truckload) APIs
- Shipium Console Introduction
- OpenBorder
- Maersk
- Cirro
- Multi-Parcel Shipments
- Additional Days to Hold a Shipment
- Subscription Timing
- DoorDash
- Global-e
- Account Users and Roles
- Estafeta
- Envoi
- APC Postal Logistics
- Origins
- Use Postman with the Shipium API
- Configure | Packaging Configuration
- Data Handling and Character Normalization
- AMPM
- Carrier Selection Shipping Report
- Address Validation
- Configuration APIs
- Label Configuration
- Configure SSO with Okta
- Delivery Promise APIs
- OAuth 2.0-Based Authentication
- Shipment Volume
- Console Configuration Overview
- Create API Credentials
- SSO for Your Shipium Account
- Cubic Rating
- Pack App API
- Team Management
- API Key-Based Authentication
- Fulfillment Engine API
- Subscription Timing API
- Carrier and Method Selection & Shipment Label API
- Certificate Authorities and Certificate Pinning
- Delivery Reporting
- Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId
- Streams zpl formatted version of a previously requested carrier label.
- Manifest a previously generated shipment label shorcut version where only the shipiumLabelId is required.
- Authentication
- Streams zpl formatted version of a previously requested carrier label.
- 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.
- Your Shipium Account
- Get Started with Shipium
- Log-In and Password
- reference
- Introduction
- Changelog
- index.html
- Recipes
- index-2.html
- Address Validation API
- Carrier Selection Rules
- Configurable Ship Options
- Packaging Planner API
- Special Processing Properties
- LaserShip
- LTL Shipment Cost Compare API
- LTL Shipment Cost API