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