Shipment API

Schemas

Shipment

idstring · uuid
Example: 123e4567-e89b-12d3-a456-426614174000
recipientEmailstring · email
Example: recipient@example.com
statusstring | null · enum
Enum values:
CREATED
IN_TRANSIT
DELIVERED
EXCEPTION
trackingNumberstring · pattern: ^[A-Z0-9]{10,20}$
createdAtstring · date-time
commentsobject[] · enum · maxItems: 100
Enum values:
PENDING
APPROVED
REJECTED
tagsstring[]
Enum values:
FRAGILE
EXPRESS
INTERNATIONAL
CUSTOMS_REQUIRED
facilitiesstring[]
Enum values:
LAX1
JFK2
ORD3
DFW4
SEA5
customDataarray
Array of custom data items that can be of any type
metadataobject
Empty object for future extensibility

streetstring · minLength: 1 · maxLength: 200 · required
citystring · minLength: 1 · maxLength: 100 · required
countrystring · pattern: ^[A-Z]{2}$ · required
ISO 3166-1 alpha-2 country code
postalCodestring · minLength: 1 · maxLength: 20 · required

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the comment
authorstring · required
Name of the person who wrote the comment
textstring · required
Content of the comment
timestampstring · date-time · required
When the comment was posted

idstring · pattern: ^[a-zA-Z0-9-]+$ · required
Unique identifier for the organization
namestring · minLength: 1 · maxLength: 200 · required
Name of the organization

parentcircular
subarray · maxItems: 100 · circular
Child organizations (array circular reference)