Overview
Shipment API
This API allows you to create and track shipments through the Ship Happens platform.
Authentication
All endpoints require a valid API key passed in the X-API-Key header.
Endpoint
Shipments
Create a new shipment
POST
https://api.sh.example.com/v1
/shipments
Creates a new shipment with the provided details
Request Body
recipientAddressobjectsenderAddressobjectpackagesobject[]
idstringoptionalstatusstringoptionaltrackingNumberstringoptionalcreatedAtstringoptional
Responses
recipientAddressobjectsenderAddressobjectpackagesobject[]idstringoptionalstatusstringoptionaltrackingNumberstringoptionalcreatedAtstringoptional
Track a shipment
GET
https://api.sh.example.com/v1
/shipments/{trackingNumber}
Get the current status and tracking information for a shipment
path Parameters
trackingNumberrequiredstring
Responses
recipientAddressobjectsenderAddressobjectpackagesobject[]idstringoptionalstatusstringoptionaltrackingNumberstringoptionalcreatedAtstringoptional