โ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.comstatus
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
arrayArray of custom data items that can be of any type
metadata
objectEmpty object for future extensibility
โAddress
street
stringย ยทย minLength: 1ย ยทย maxLength: 200ย ยทย requiredcity
stringย ยทย minLength: 1ย ยทย maxLength: 100ย ยทย requiredcountry
stringย ยทย pattern:^[A-Z]{2}$
ย ยทย requiredISO 3166-1 alpha-2 country code
postalCode
stringย ยทย minLength: 1ย ยทย maxLength: 20ย ยทย required
state
stringย ยทย minLength: 1ย ยทย maxLength: 100
โPackage
weight
numberย ยทย floatย ยทย min: 0.1ย ยทย max: 1000ย ยทย requiredWeight in kilograms
dimensions
objectย ยทย required
โDimensions
length
numberย ยทย floatย ยทย min: 1ย ยทย max: 300ย ยทย requiredLength in centimeters
width
numberย ยทย floatย ยทย min: 1ย ยทย max: 300ย ยทย requiredWidth in centimeters
height
numberย ยทย floatย ยทย min: 1ย ยทย max: 300ย ยทย requiredHeight in centimeters
โError
code
stringย ยทย minLength: 1ย ยทย maxLength: 50ย ยทย pattern:^[A-Z_]+$
ย ยทย requiredmessage
stringย ยทย minLength: 1ย ยทย maxLength: 500ย ยทย required
โShipmentHistory
currentShipment
objectpreviousShipment
circular
transferredAt
stringย ยทย date-timeWhen the shipment was transferred
โComment
id
stringย ยทย pattern:^[a-zA-Z0-9-]+$
ย ยทย requiredUnique identifier for the comment
author
stringย ยทย requiredName of the person who wrote the comment
text
stringย ยทย requiredContent of the comment
timestamp
stringย ยทย date-timeย ยทย requiredWhen the comment was posted
replies
arrayย ยทยcircular
Nested replies to this comment
โOrganization
id
stringย ยทย pattern:^[a-zA-Z0-9-]+$
ย ยทย requiredUnique identifier for the organization
name
stringย ยทย minLength: 1ย ยทย maxLength: 200ย ยทย requiredName of the organization
parent
circular
sub
arrayย ยทย maxItems: 100ย ยทยcircular
Child organizations (array circular reference)
โLinkedShipment
id
stringย ยทย uuidย ยทย requiredUnique identifier for the shipment
status
stringย ยทย enumย ยทย requiredEnum values:PENDINGIN_TRANSITDELIVERED
next
circular
previous
circular
โSchemaValidationRequest
data
objectย ยทย requiredThe data to validate against the schema
options
object
โSchemaValidationResponse
valid
booleanย ยทย requiredWhether the data is valid according to the schema
errors
object[]Validation errors if any
schemaId
stringIdentifier of the schema used for validation
timestamp
stringย ยทย date-timeWhen the validation was performed
โSchemaMetadata
id
stringย ยทย requiredUnique identifier for the schema
name
stringย ยทย requiredHuman-readable name of the schema
version
stringย ยทย pattern:^\d+\.\d+\.\d+$
ย ยทย requiredVersion of the schema
description
stringDescription of the schema
createdAt
stringย ยทย date-timeWhen the schema was created
updatedAt
stringย ยทย date-timeWhen the schema was last updated
spaceEntityType
stringย ยทย enumThe type of space entity this schema represents
Enum values:CARGOVESSELCREWROUTESTATIONPLANETASTEROIDSATELLITE