Shipment API
Schemas
Shipment
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"}}
Address
street
string · minLength: 1 · maxLength: 200 · requiredcity
string · minLength: 1 · maxLength: 100 · requiredcountry
string · pattern:^[A-Z]{2}$
· requiredpostalCode
string · minLength: 1 · maxLength: 20 · required
state
string · minLength: 1 · maxLength: 100
Package
weight
number · float · min: 0.1 · max: 1000 · requireddimensions
object · required
Dimensions
length
number · float · min: 1 · max: 300 · requiredwidth
number · float · min: 1 · max: 300 · requiredheight
number · float · min: 1 · max: 300 · required
Error
code
string · minLength: 1 · maxLength: 50 · pattern:^[A-Z_]+$
· requiredmessage
string · minLength: 1 · maxLength: 500 · required
ShipmentHistory
currentShipment
objectpreviousShipment
object · minProps: 1 · maxProps: 3transferredAt
string · date-time
Comment
id
string · pattern:^[a-zA-Z0-9-]+$
· requiredauthor
string · requiredtext
string · requiredtimestamp
string · date-time · required
replies
object[]
Organization
id
string · pattern:^[a-zA-Z0-9-]+$
· requiredname
string · minLength: 1 · maxLength: 200 · required
parent
objectsub
object[] · maxItems: 100
LinkedShipment
id
string · uuid · requiredstatus
string · enum · requiredEnum values:PENDINGIN_TRANSITDELIVERED
next
objectprevious
object
SchemaValidationRequest
data
object · required
options
object
SchemaValidationResponse
valid
boolean · required
errors
object[]schemaId
stringtimestamp
string · date-time
SchemaMetadata
id
string · requiredname
string · requiredversion
string · pattern:^\d+\.\d+\.\d+$
· required
description
stringcreatedAt
string · date-timeupdatedAt
string · date-timespaceEntityType
string · enumEnum values:CARGOVESSELCREWROUTESTATIONPLANETASTEROIDSATELLITE