Create a new shipment
POST
https://api.sh.example.com/v1
/shipments
Headers
X-Correlation-ID
string · uuidIdempotency-Key
string · uuidX-API-Version
string | null · enumEnum values:2024-012023-12Default: 2024-01X-Request-Priority
string · enumEnum values:highnormallowDefault: normal
Request Body
recipientAddress
object · requiredsenderAddress
object · requiredpackages
object[] · minItems: 1 · maxItems: 50 · unique · required
id
string · uuidExample: 123e4567-e89b-12d3-a456-426614174000recipientEmail
string · emailExample: recipient@example.comnotes
object[]status
string | null · enumEnum values:CREATEDIN_TRANSITDELIVEREDEXCEPTIONtrackingNumber
string · pattern:^[A-Z0-9]{10,20}$
createdAt
string · date-timecomments
object[] · enum · maxItems: 100Enum values:PENDINGAPPROVEDREJECTEDtags
string[]Enum values:FRAGILEEXPRESSINTERNATIONALCUSTOMS_REQUIREDfacilities
string[]Enum values:LAX1JFK2ORD3DFW4SEA5customData
arraymetadata
objectcustomFields
objectExample: {"customerReference":"CUST-123","internalNotes":"Handle with care","specialInstructions":"Leave at front desk"}facilityCapabilities
objectExample: {"temperatureControl":{"enabled":true,"lastChecked":"2024-03-15T10:30:00Z"},"hazardousMaterials":{"enabled":false,"lastChecked":"2024-03-14T15:45:00Z"}}
Responses
recipientAddress
object · requiredsenderAddress
object · requiredpackages
object[] · minItems: 1 · maxItems: 50 · unique · requiredid
string · uuidExample: 123e4567-e89b-12d3-a456-426614174000recipientEmail
string · emailExample: recipient@example.comnotes
object[]status
string | null · enumEnum values:CREATEDIN_TRANSITDELIVEREDEXCEPTIONtrackingNumber
string · pattern:^[A-Z0-9]{10,20}$
createdAt
string · date-timecomments
object[] · enum · maxItems: 100Enum values:PENDINGAPPROVEDREJECTEDtags
string[]Enum values:FRAGILEEXPRESSINTERNATIONALCUSTOMS_REQUIREDfacilities
string[]Enum values:LAX1JFK2ORD3DFW4SEA5customData
arraymetadata
objectcustomFields
objectExample: {"customerReference":"CUST-123","internalNotes":"Handle with care","specialInstructions":"Leave at front desk"}facilityCapabilities
objectExample: {"temperatureControl":{"enabled":true,"lastChecked":"2024-03-15T10:30:00Z"},"hazardousMaterials":{"enabled":false,"lastChecked":"2024-03-14T15:45:00Z"}}
Track a shipment
GET
https://api.sh.example.com/v1
/shipments/{trackingNumber}
path Parameters
trackingNumber
string · required
Headers
X-Correlation-ID
string · uuidX-API-Version
string | null · enumEnum values:2024-012023-12Default: 2024-01X-Cache-Control
string · enumEnum values:no-cachemax-age=60Default: max-age=60
Responses
recipientAddress
object · requiredsenderAddress
object · requiredpackages
object[] · minItems: 1 · maxItems: 50 · unique · requiredid
string · uuidExample: 123e4567-e89b-12d3-a456-426614174000recipientEmail
string · emailExample: recipient@example.comnotes
object[]status
string | null · enumEnum values:CREATEDIN_TRANSITDELIVEREDEXCEPTIONtrackingNumber
string · pattern:^[A-Z0-9]{10,20}$
createdAt
string · date-timecomments
object[] · enum · maxItems: 100Enum values:PENDINGAPPROVEDREJECTEDtags
string[]Enum values:FRAGILEEXPRESSINTERNATIONALCUSTOMS_REQUIREDfacilities
string[]Enum values:LAX1JFK2ORD3DFW4SEA5customData
arraymetadata
objectcustomFields
objectExample: {"customerReference":"CUST-123","internalNotes":"Handle with care","specialInstructions":"Leave at front desk"}facilityCapabilities
objectExample: {"temperatureControl":{"enabled":true,"lastChecked":"2024-03-15T10:30:00Z"},"hazardousMaterials":{"enabled":false,"lastChecked":"2024-03-14T15:45:00Z"}}
Hold shipment
PUT
https://api.sh.example.com/v1
/shipments/{shipmentId}/hold
path Parameters
shipmentId
string · uuid · required
query Parameters
holdDuration
string · date-time
Headers
X-Hold-Operator
string · enumEnum values:SYSTEMADMINCUSTOMERAGENT
cookie Parameters
preferredLocation
string
Request Body
holdUntil
string · date-time · required
reason
string · enumEnum values:RECIPIENT_REQUESTCUSTOMS_HOLDWEATHER_DELAYADDRESS_VERIFICATIONPAYMENT_PENDINGfacilityId
string · enumEnum values:LAX1JFK2ORD3DFW4SEA5
Responses
status
string · enumEnum values:ON_HOLDHOLD_PENDINGHOLD_REJECTEDholdLocation
string · enumEnum values:LAX1 - Los Angeles HubJFK2 - New York HubORD3 - Chicago HubDFW4 - Dallas HubSEA5 - Seattle HubholdUntil
string · enum · date-timeEnum values:2025-01-15T17:00:00Z2025-01-16T09:00:00Z2025-01-17T14:00:00Z