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

Interplanetary Shipping API

Schemas

InterplanetaryShipment

originPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

destinationPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

object · required

shippingClass

string · enum · required

Shipping speed class

Enum values:

STANDARD

EXPRESS

PRIORITY

id

string · uuid · readOnly

radiationShielding

boolean

Whether cargo needs radiation shielding

Default: true

status

string · enum · readOnly

Enum values:

SCHEDULED

LAUNCHED

IN_TRANSIT

APPROACHING

LANDED

DELIVERED

estimatedDelivery

string · date-time · readOnly

trackingNumber

string · readOnly

createdAt

string · date-time · readOnly

Cargo

weight

number · float · required

Weight in metric tons

volume

number · float · required

Volume in cubic meters

category

string · enum · required

Enum values:

GENERAL

HAZARDOUS

BIOLOGICAL

MINERAL

EQUIPMENT

object

Simple string-to-string dictionary for cargo metadata

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

object

Dictionary with fixed keys and complex value types

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

object

SafetyCheck

procedure

string

frequency

string · enum

Enum values:

DAILY

WEEKLY

MONTHLY

SpecializedCargo

weight

number · float · required

Weight in metric tons

volume

number · float · required

Volume in cubic meters

category

string · enum · required

Enum values:

GENERAL

HAZARDOUS

BIOLOGICAL

MINERAL

EQUIPMENT

object · required

object

Simple string-to-string dictionary for cargo metadata

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

object

Dictionary with fixed keys and complex value types

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

object

ShippingRoute

routeType

string · enum · required

Enum values:

DIRECT

MULTI_HOP

required

array

Error

code

string · required

message

string · required

PaymentMethod

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching 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:

type

string · const · required

Const value: credit_card

cardNumber

string · pattern: ^[0-9]{16}$ · required

expiryDate

string · pattern: ^(0[1-9]|1[0-2])/[0-… · required

cvv

string · pattern: ^[0-9]{3,4}$ · required

CargoContents

anyOf

Exactly one variant must match.

Decision Table

Variant	Matching 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

state

string · const · required

Const value: liquid

viscosity

number · min: 0 · required

Viscosity in cP

density

number · min: 0 · required

Density in kg/m³

flammable

boolean

PrimitiveUnion

anyOf

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

Decision Table

Variant	Matching Criteria
	type = string
	type = number
	type = boolean

Properties for Variant 1:

string

Text identifier

NullableString

anyOf

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

Decision Table

Variant	Matching Criteria
	type = string
	type = null

Properties for Variant 1:

string · minLength: 1

FlexibleArray

array

anyOf

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

Decision Table

Variant	Matching 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

Variant	Matching Criteria
	type = object · requires: common, optionA
	type = object · requires: common, optionB, specificToB
	type = object · requires: common

Properties for Option A:

common

string · required

Common field across all variants

optionA

string · required

specificToA

number · min: 0

LargeUnion

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching 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:

type

const · required

Const value: 1

data

string · required

EnhancedShipment

An enhanced shipment that combines base shipment properties with premium features

originPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

destinationPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

object · required

shippingClass

string · enum · required

Shipping speed class

Enum values:

STANDARD

EXPRESS

PRIORITY

required

id

string · uuid · readOnly

radiationShielding

boolean

Whether cargo needs radiation shielding

Default: true

status

string · enum · readOnly

Enum values:

SCHEDULED

LAUNCHED

IN_TRANSIT

APPROACHING

LANDED

DELIVERED

estimatedDelivery

string · date-time · readOnly

trackingNumber

string · readOnly

createdAt

string · date-time · readOnly

Additional security measures for the shipment

ComplexRoute

A complex routing configuration with nested logical operators

routeId

string · uuid · required

object · required

FuelStation

A fuel station along interplanetary routes

stationId

string · uuid · readOnly · required

Unique identifier for the fuel station

name

string · required

Name of the fuel station

location

string · enum · required

Orbital location of the station

Enum values:

Earth Orbit

Mars Orbit

Venus Orbit

Jupiter Orbit

Asteroid Belt

fuelTypes

string[]

Available fuel types at this station

Enum values:

ION

CHEMICAL

SOLAR

NUCLEAR

capacity

number

Maximum fuel capacity in metric tons

currentAvailability

number · min: 0 · max: 100

Current fuel availability percentage

Interplanetary Shipping API

Schemas

InterplanetaryShipment

originPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

destinationPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

object · required

shippingClass

string · enum · required

Shipping speed class

Enum values:

STANDARD

EXPRESS

PRIORITY

id

string · uuid · readOnly

radiationShielding

boolean

Whether cargo needs radiation shielding

Default: true

status

string · enum · readOnly

Enum values:

SCHEDULED

LAUNCHED

IN_TRANSIT

APPROACHING

LANDED

DELIVERED

estimatedDelivery

string · date-time · readOnly

trackingNumber

string · readOnly

createdAt

string · date-time · readOnly

Cargo

weight

number · float · required

Weight in metric tons

volume

number · float · required

Volume in cubic meters

category

string · enum · required

Enum values:

GENERAL

HAZARDOUS

BIOLOGICAL

MINERAL

EQUIPMENT

object

Simple string-to-string dictionary for cargo metadata

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

object

Dictionary with fixed keys and complex value types

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

object

SafetyCheck

procedure

string

frequency

string · enum

Enum values:

DAILY

WEEKLY

MONTHLY

SpecializedCargo

weight

number · float · required

Weight in metric tons

volume

number · float · required

Volume in cubic meters

category

string · enum · required

Enum values:

GENERAL

HAZARDOUS

BIOLOGICAL

MINERAL

EQUIPMENT

object · required

object

Simple string-to-string dictionary for cargo metadata

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

object

Dictionary with fixed keys and complex value types

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

object

ShippingRoute

routeType

string · enum · required

Enum values:

DIRECT

MULTI_HOP

required

array

Error

code

string · required

message

string · required

PaymentMethod

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching 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:

type

string · const · required

Const value: credit_card

cardNumber

string · pattern: ^[0-9]{16}$ · required

expiryDate

string · pattern: ^(0[1-9]|1[0-2])/[0-… · required

cvv

string · pattern: ^[0-9]{3,4}$ · required

CargoContents

anyOf

Exactly one variant must match.

Decision Table

Variant	Matching 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

state

string · const · required

Const value: liquid

viscosity

number · min: 0 · required

Viscosity in cP

density

number · min: 0 · required

Density in kg/m³

flammable

boolean

PrimitiveUnion

anyOf

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

Decision Table

Variant	Matching Criteria
	type = string
	type = number
	type = boolean

Properties for Variant 1:

string

Text identifier

NullableString

anyOf

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

Decision Table

Variant	Matching Criteria
	type = string
	type = null

Properties for Variant 1:

string · minLength: 1

FlexibleArray

array

anyOf

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

Decision Table

Variant	Matching 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

Variant	Matching Criteria
	type = object · requires: common, optionA
	type = object · requires: common, optionB, specificToB
	type = object · requires: common

Properties for Option A:

common

string · required

Common field across all variants

optionA

string · required

specificToA

number · min: 0

LargeUnion

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching 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:

type

const · required

Const value: 1

data

string · required

EnhancedShipment

An enhanced shipment that combines base shipment properties with premium features

originPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

destinationPlanet

string · enum · required

Enum values:

Earth

Mars

Venus

Mercury

Jupiter

object · required

shippingClass

string · enum · required

Shipping speed class

Enum values:

STANDARD

EXPRESS

PRIORITY

required

id

string · uuid · readOnly

radiationShielding

boolean

Whether cargo needs radiation shielding

Default: true

status

string · enum · readOnly

Enum values:

SCHEDULED

LAUNCHED

IN_TRANSIT

APPROACHING

LANDED

DELIVERED

estimatedDelivery

string · date-time · readOnly

trackingNumber

string · readOnly

createdAt

string · date-time · readOnly

Additional security measures for the shipment

ComplexRoute

A complex routing configuration with nested logical operators

routeId

string · uuid · required

object · required

FuelStation

A fuel station along interplanetary routes

stationId

string · uuid · readOnly · required

Unique identifier for the fuel station

name

string · required

Name of the fuel station

location

string · enum · required

Orbital location of the station

Enum values:

Earth Orbit

Mars Orbit

Venus Orbit

Jupiter Orbit

Asteroid Belt

fuelTypes

string[]

Available fuel types at this station

Enum values:

ION

CHEMICAL

SOLAR

NUCLEAR

capacity

number

Maximum fuel capacity in metric tons

currentAvailability

number · min: 0 · max: 100

Current fuel availability percentage