Jump to Content

Guides Recipes API Reference Changelog Discussions

API Reference

Guides Recipes API Reference Changelog Discussions

Shipium API

ping
- 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.get
- 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.get
delivery-experience
shipmentPlanning
- Shipment Planning APIpost
order-management
mega-shipment-process
- 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.post
carrier-selection
label-generation
ltl-shipment-cost
ManifestControllerV1
- Manifest all shipments for a carrier.post
ManifestControllerV2
- Manifest all shipments for a carrier.post
- Download manifest report from carrierpost
return-label-generation
package-selection
- Run the package sizing process for a partner's FC and a list of items to pack.post
- Retrieve a existing package sizing decision.get
subscription
- Subscription Timing APIpost
- Get subscription timingget
track
tracking-registration-controller
- Tracking registration endpoint to start tracking a shipment shipium did not createpost
- Tracking registration endpoint to start tracking shipments shipium did not createpost
address-component
address-validation
- Determine if an address is a valid mailing addresspost
labelErrors
- Search for carrier label errors.get
- Retrieve a shipment label error by shipiumLabelId.get
pack-ship-orchestration
partner-config
- Partner Configurationsget
- Partner Configuration for a partnerget
PickupsV1
bulk-processing-orchestration
- 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.post
- Pingget

Find address component lookup by partnerId and address

post https://api.shipium.com/api/v1/address/components/find

Language

Credentials

OAuth2

Bearer

Click Try It! to start a request and see the response here!