We're announcing 🧑‍🚀 inter-galactic shipping ✨ for 3025!
Cosmo Cargo Inc.
Interplanetary Shipping API

Schemas

InterplanetaryShipment

  • originPlanetstring · enum · required
    Enum values:
    Earth
    Mars
    Venus
    Mercury
    Jupiter
  • destinationPlanetstring · enum · required
    Enum values:
    Earth
    Mars
    Venus
    Mercury
    Jupiter
  • cargoobject · required
  • shippingClassstring · enum · required

    Shipping speed class

    Enum values:
    STANDARD
    EXPRESS
    PRIORITY
  • idstring · uuid · readOnly
  • radiationShieldingboolean

    Whether cargo needs radiation shielding

    Default: true
  • statusstring · enum · readOnly
    Enum values:
    SCHEDULED
    LAUNCHED
    IN_TRANSIT
    APPROACHING
    LANDED
    DELIVERED
  • estimatedDeliverystring · date-time · readOnly
  • trackingNumberstring · readOnly
  • createdAtstring · date-time · readOnly

Cargo

  • weightnumber · float · required

    Weight in metric tons

  • volumenumber · float · required

    Volume in cubic meters

  • categorystring · enum · required
    Enum values:
    GENERAL
    HAZARDOUS
    BIOLOGICAL
    MINERAL
    EQUIPMENT
  • metadataobject

    Simple string-to-string dictionary for cargo metadata

    Example: {"manufacturer":"SpaceTech Inc","batchNumber":"ST-2024-001"}
  • safetyChecksobject

    Dictionary with fixed keys and complex value types

    Example: {"default":"Standard equipment check","radiation":{"procedure":"Radiation level check","frequency":"DAILY"}}
  • temperatureControlobject

SafetyCheck

  • procedurestring
  • frequencystring · enum
    Enum values:
    DAILY
    WEEKLY
    MONTHLY

SpecializedCargo

  • weightnumber · float · required

    Weight in metric tons

  • volumenumber · float · required

    Volume in cubic meters

  • categorystring · enum · required
    Enum values:
    GENERAL
    HAZARDOUS
    BIOLOGICAL
    MINERAL
    EQUIPMENT
  • specializationobject · required
  • metadataobject

    Simple string-to-string dictionary for cargo metadata

    Example: {"manufacturer":"SpaceTech Inc","batchNumber":"ST-2024-001"}
  • safetyChecksobject

    Dictionary with fixed keys and complex value types

    Example: {"default":"Standard equipment check","radiation":{"procedure":"Radiation level check","frequency":"DAILY"}}
  • temperatureControlobject

ShippingRoute

  • routeTypestring · enum · required
    Enum values:
    DIRECT
    MULTI_HOP
  • routerequired
  • requirementsarray

Error

  • codestring · required
  • messagestring · required

PaymentMethod

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · type="credit_card" · requires: cardNumber, expiryDate, cvv
type = object · type="bank_transfer" · requires: accountNumber, routingNumber, bankName
type = object · type="crypto" · requires: currency, walletAddress
Properties for Credit Card:
  • typestring · const · required
    Const value: credit_card
  • cardNumberstring · pattern: ^[0-9]{16}$ · required
  • expiryDatestring · pattern: ^(0[1-9]|1[0-2])/[0-… · required
  • cvvstring · pattern: ^[0-9]{3,4}$ · required

CargoContents

anyOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · state="liquid" · requires: viscosity, density
type = object · state="solid" · requires: hardness
type = object · state="gas" · requires: pressure
Properties for Liquid Cargo:

Properties specific to liquid cargo

  • statestring · const · required
    Const value: liquid
  • viscositynumber · min: 0 · required

    Viscosity in cP

  • densitynumber · min: 0 · required

    Density in kg/m³

  • flammableboolean

PrimitiveUnion

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = string
type = number
type = boolean
Properties for Variant 1:

Text identifier

string

Text identifier

NullableString

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = string
type = null
Properties for Variant 1:
string · minLength: 1

FlexibleArray

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = string
type = number
type = object · requires: id, value
Properties for Variant 1:
string

MixedRequirements

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: common, optionA
type = object · requires: common, optionB, specificToB
type = object · requires: common
Properties for Option A:
  • commonstring · required

    Common field across all variants

  • optionAstring · required
  • specificToAnumber · min: 0

LargeUnion

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · type=1 · requires: data
type = object · type=2 · requires: data
type = object · type=3 · requires: data
type = object · type=4 · requires: data
type = object · type=5 · requires: data
Properties for Type 1:
  • typeconst · required
    Const value: 1
  • datastring · required

EnhancedShipment

  • originPlanetstring · enum · required
    Enum values:
    Earth
    Mars
    Venus
    Mercury
    Jupiter
  • destinationPlanetstring · enum · required
    Enum values:
    Earth
    Mars
    Venus
    Mercury
    Jupiter
  • cargoobject · required
  • shippingClassstring · enum · required

    Shipping speed class

    Enum values:
    STANDARD
    EXPRESS
    PRIORITY
  • premiumFeaturesrequired
  • idstring · uuid · readOnly
  • radiationShieldingboolean

    Whether cargo needs radiation shielding

    Default: true
  • statusstring · enum · readOnly
    Enum values:
    SCHEDULED
    LAUNCHED
    IN_TRANSIT
    APPROACHING
    LANDED
    DELIVERED
  • estimatedDeliverystring · date-time · readOnly
  • trackingNumberstring · readOnly
  • createdAtstring · date-time · readOnly
  • securityOptions

    Additional security measures for the shipment

ComplexRoute

  • routeIdstring · uuid · required
  • configurationobject · required