For AI agents: visit https://docs.shipium.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Guides
Recipes
API Reference
Changelog
v1.1.0
Log In
API Reference
Log In
v1.1.0
Guides
Recipes
API Reference
Changelog
Ping
JUMP TO
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
Product View Delivery Estimate
post
Get Delivery Estimate
get
Cart Delivery Date Estimate
post
Create Shipment
post
Get Shipment
get
Cancel Shipment
del
Update Shipment
patch
All-in-one Cancel
post
Get Shipment Events
get
shipmentPlanning
Shipment Planning API
post
order-management
Create an order.
post
Retrieve an order.
get
Update an existing order.
post
Delete an order.
del
Search for existing orders.
get
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
Run the carrier selection process on a existing partner shipment.
post
Retrieve a existing carrier selection.
get
Cancel an existing carrier selection.
del
Retrieve a list of existing carrier selections.
get
label-generation
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.
get
Manifest a previously generated shipment label shorcut version where only the shipiumLabelId is required.
post
Streams pdf formatted version of a previously requested carrier label.
get
Streams png formatted version of a previously requested carrier label.
get
Streams zpl formatted version of a previously requested carrier label.
get
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.
post
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.
get
Patch a previously generated shipment label. Fields that are present in the patch will be upserted against the existing label.
patch
Manifest a previously generated shipment label.
post
Streams pdf formatted version of a previously requested carrier label.
get
Streams png formatted version of a previously requested carrier label.
get
Streams zpl formatted version of a previously requested carrier label.
get
Void a previously generated shipment label.
post
Void a previously generated shipment label using the shipiumLabelId or carrierTrackingId.
post
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.
post
Streams pdf formatted version of a previously requested carrier label.
get
Streams png formatted version of a previously requested carrier label.
get
Streams zpl formatted version of a previously requested carrier label.
get
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.
get
Streams pdf formatted version of a previously requested carrier label.
get
Streams png formatted version of a previously requested carrier label.
get
Streams zpl formatted version of a previously requested carrier label.
get
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.
post
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.
put
Update the cost of a previously generated shipment label.
put
ltl-shipment-cost
Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.
get
Retrieve the cost for a LTL shipment.
post
Retrieve an existing LTL shipment cost or cost comparison.
get
Retrieve a single page of LTL costs, or LTL cost comparisons, that match the supplied parameters.
get
Retrieve the costs for a shipment using either LTL or parcel shipping.
post
Retrieve an existing LTL shipment cost or cost comparison.
get
ManifestControllerV1
ManifestControllerV2
Manifest all shipments for a carrier.
post
Download manifest report from carrier
post
return-label-generation
Calls the partner's configured returns service to create a return label.
post
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.
get
Streams pdf formatted version of a previously requested return label.
get
Streams png formatted version of a previously requested return label.
get
Streams zpl formatted version of a previously requested return label.
get
Streams pdf formatted version of a previously requested return label.
get
Streams png formatted version of a previously requested return label.
get
Streams zpl formatted version of a previously requested return label.
get
packagePlanner
/api/v1/packaging/planner
post
track
Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId
get
Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId
get
Tracking endpoint to retrieve tracking info about shipments using shipiumTrackingId in bulk
post
/api/v1/tracking/bulkPartnerShipmentIdSearch
post
Tracking endpoint to retrieve tracking info about shipments using carrierId and carrierTrackingId in bulk
post
tracking-registration-controller
Tracking registration endpoint to start tracking a shipment shipium did not create
post
Tracking registration endpoint to start tracking shipments shipium did not create
post
address-validation
Determine if an address is a valid mailing address
post
pack-ship-orchestration
Creates an order to be packed.
post
Search for existing orders.
get
Get an existing order.
get
Cancel an existing order.
del
Updates an order to be packed.
patch
Pack and ship order.
post
Ping
get
Ping
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
Ping
get
Powered by
Ping
Copy Page
Updated 8 months ago
Ping
bulk-processing-orchestration
Did this page help you?
Yes
No
Updated 8 months ago
Ping
bulk-processing-orchestration
Did this page help you?
Yes
No
