We're announcing 🧑🚀 inter-galactic shipping ✨ for 3025!
Search
Documentation
Shipments API
API Catalog
Shipment Management
Create a new shipment
post
Track a shipment
get
Cancel shipment
delete
Hold shipment
put
Update shipment priority
put
Get available service levels
get
Rates & Billing
Calculate shipping rates
post
Add insurance
post
International Shipping
Update customs documentation
put
Pay import duties
post
Documentation
Get shipping label
get
Get commercial invoice
get
Get commercial invoice (legacy)
get
Tracking & Notifications
Get shipment tracking events
get
Set up notifications
post
Schemas
List available schemas
get
Get schema details
get
Get facility capabilities
get
Organization Management
List all organizations
get
Create a new organization
post
Route Planning
Get estimated delivery time
get
Other endpoints
Health check
get
Get API version
get
Schemas
powered by Zudoku
Menu
Shipment API
Tracking & Notifications
Endpoint
https://api.sh.example.com/v1
https://api.staging.sh.example.com/v1
https://api.dev.sh.example.com/v1
API information
Get shipment tracking events
GET
https://api.sh.example.com/v1
/shipments/{shipmentId}/events
Get shipment tracking events ›
path Parameters
shipmentId
string
·
uuid
·
required
Get shipment tracking events ›
Responses
shipmentId
string
·
uuid
events
object[]
Show properties
Set up notifications
POST
https://api.sh.example.com/v1
/shipments/{shipmentId}/notifications
Set up notifications ›
path Parameters
shipmentId
string
·
uuid
·
required
Set up notifications ›
Request Body
email
string[]
sms
string[]
webhooks
string[]
events
string[]
Enum values:
PICKUP_SCHEDULED
IN_TRANSIT
OUT_FOR_DELIVERY
DELIVERED
EXCEPTION
Documentation
Schemas