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
  • notesobject[]
  • 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
  • metadataobject
  • customFieldsobject
    Example: {"customerReference":"CUST-123","internalNotes":"Handle with care","specialInstructions":"Leave at front desk"}
  • facilityCapabilitiesobject
    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
  • postalCodestring · minLength: 1 · maxLength: 20 · required
  • statestring · minLength: 1 · maxLength: 100

​Package

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

​Dimensions

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

​Error

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

​ShipmentHistory

  • currentShipmentobject
  • previousShipmentobject · minProps: 1 · maxProps: 3
  • transferredAtstring · date-time

​Comment

  • idstring · pattern: ^[a-zA-Z0-9-]+$ · required
  • authorstring · required
  • textstring · required
  • timestampstring · date-time · required
  • repliesobject[]

​Organization

  • idstring · pattern: ^[a-zA-Z0-9-]+$ · required
  • namestring · minLength: 1 · maxLength: 200 · required
  • parentobject
  • subobject[] · maxItems: 100

​LinkedShipment

  • idstring · uuid · required
  • statusstring · enum · required
    Enum values:
    PENDING
    IN_TRANSIT
    DELIVERED
  • nextobject
  • previousobject

​SchemaValidationRequest

  • dataobject · required
  • optionsobject

​SchemaValidationResponse

  • validboolean · required
  • errorsobject[]
  • schemaIdstring
  • timestampstring · date-time

​SchemaMetadata

  • idstring · required
  • namestring · required
  • versionstring · pattern: ^\d+\.\d+\.\d+$ · required
  • descriptionstring
  • createdAtstring · date-time
  • updatedAtstring · date-time
  • spaceEntityTypestring · enum
    Enum values:
    CARGO
    VESSEL
    CREW
    ROUTE
    STATION
    PLANET
    ASTEROID
    SATELLITE