Shipment
idrecipientEmailNotes about the shipment
statustrackingNumber^[A-Z0-9]{10,20}$createdAttagsfacilitiesArray of custom data items that can be of any type
metadataEmpty object for future extensibility
Dictionary of custom string fields that can be added to the shipment
Dictionary of facility capabilities and their status
Real-time tracking information for this shipment
Tracking details for return shipment if applicable
Address
streetcitycountry^[A-Z]{2}$ย ยทย requiredISO 3166-1 alpha-2 country code
postalCodestatePackage
weightWeight in kilograms
Dimensions
lengthLength in centimeters
widthWidth in centimeters
heightHeight in centimeters
Error
code^[A-Z_]+$ย ยทย requiredmessageShipmentValidationError
codeSpecific validation error code
messageHuman-readable error message
fieldField that failed validation
suggestionSuggested fix for the error
TrackingDetails
currentLocationCurrent location of the shipment
lastUpdateLast tracking update timestamp
estimatedDeliveryEstimated delivery date and time
carrierCarrier handling the shipment
ShipmentHistory
transferredAtWhen the shipment was transferred
Comment
id^[a-zA-Z0-9-]+$ย ยทย requiredUnique identifier for the comment
authorName of the person who wrote the comment
textContent of the comment
timestampWhen the comment was posted
Nested replies to this comment
Organization
id^[a-zA-Z0-9-]+$ย ยทย requiredUnique identifier for the organization
nameName of the organization
The parent organization (direct object circular reference)
Child organizations (array circular reference)
LinkedShipment
idUnique identifier for the shipment
statusA shipment that's part of a chain (e.g. multi-leg delivery)
A shipment that's part of a chain (e.g. multi-leg delivery)
SchemaValidationRequest
dataThe data to validate against the schema
SchemaValidationResponse
validWhether the data is valid according to the schema
Validation errors if any
schemaIdIdentifier of the schema used for validation
timestampWhen the validation was performed
SchemaMetadata
idUnique identifier for the schema
nameHuman-readable name of the schema
version^\d+\.\d+\.\d+$ย ยทย requiredVersion of the schema
descriptionDescription of the schema
createdAtWhen the schema was created
updatedAtWhen the schema was last updated
spaceEntityTypeThe type of space entity this schema represents