We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!
Shipment API

​Schemas

​Shipment

  • recipientAddressobject · required
  • senderAddressobject · required
  • packagesobject[] · minItems: 1 · maxItems: 50 · unique · required
  • 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

  • customFieldsobject

    Dictionary of custom string fields that can be added to the shipment

    Example: {"customerReference":"CUST-123","internalNotes":"Handle with care","specialInstructions":"Leave at front desk"}
  • facilityCapabilitiesobject

    Dictionary of facility capabilities and their status

    Example: {"temperatureControl":{"enabled":true,"lastChecked":"2024-03-15T10:30:00Z"},"hazardousMaterials":{"enabled":false,"lastChecked":"2024-03-14T15:45:00Z"}}
Additional properties are allowed

​Address

  • 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
  • statestring · minLength: 1 · maxLength: 100

​Package

  • weightnumber · float · min: 0.1 · max: 1000 · required

    Weight in kilograms

  • dimensionsobject · required

​Dimensions

  • lengthnumber · float · min: 1 · max: 300 · required

    Length in centimeters

  • widthnumber · float · min: 1 · max: 300 · required

    Width in centimeters

  • heightnumber · float · min: 1 · max: 300 · required

    Height in centimeters

​Error

  • codestring · minLength: 1 · maxLength: 50 · pattern: ^[A-Z_]+$ · required
  • messagestring · minLength: 1 · maxLength: 500 · required

​ShipmentHistory

  • currentShipmentobject
  • previousShipmentcircular
  • transferredAtstring · date-time

    When the shipment was transferred

​Comment

  • 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

  • repliesarray · circular

    Nested replies to this comment

​Organization

  • 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)

​LinkedShipment

  • idstring · uuid · required

    Unique identifier for the shipment

  • statusstring · enum · required
    Enum values:
    PENDING
    IN_TRANSIT
    DELIVERED
  • nextcircular
  • previouscircular

​SchemaValidationRequest

  • dataobject · required

    The data to validate against the schema

  • optionsobject

​SchemaValidationResponse

  • validboolean · required

    Whether the data is valid according to the schema

  • errorsobject[]

    Validation errors if any

  • schemaIdstring

    Identifier of the schema used for validation

  • timestampstring · date-time

    When the validation was performed

​SchemaMetadata

  • idstring · required

    Unique identifier for the schema

  • namestring · required

    Human-readable name of the schema

  • versionstring · pattern: ^\d+\.\d+\.\d+$ · required

    Version of the schema

  • descriptionstring

    Description of the schema

  • createdAtstring · date-time

    When the schema was created

  • updatedAtstring · date-time

    When the schema was last updated

  • spaceEntityTypestring · enum

    The type of space entity this schema represents

    Enum values:
    CARGO
    VESSEL
    CREW
    ROUTE
    STATION
    PLANET
    ASTEROID
    SATELLITE