Interplanetary Shipping API

Interplanetary

Endpoint

Download schema

Create a shipment

POST

https://api.sh.example.com/v1

/interplanetary/shipments

Creates a new interplanetary shipment with the provided details

Create a shipment › Request Body

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

Create a shipment › Responses

Shipment created successfully

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

POST/interplanetary/shipments

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    originPlanet: 'Earth',
    destinationPlanet: 'Mars',
    cargo: {
      weight: 2.5,
      volume: 3,
      category: 'EQUIPMENT',
      temperatureControl: {required: true, minTemp: -10, maxTemp: 25}
    },
    shippingClass: 'PRIORITY',
    radiationShielding: true
  })
};

fetch('https://api.sh.example.com/v1/interplanetary/shipments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "originPlanet": "Earth",
  "destinationPlanet": "Mars",
  "cargo": {
    "weight": 2.5,
    "volume": 3,
    "category": "EQUIPMENT",
    "temperatureControl": {
      "required": true,
      "minTemp": -10,
      "maxTemp": 25
    }
  },
  "shippingClass": "PRIORITY",
  "radiationShielding": true
}

json

application/json

Example Responses

No example specified for this content type

application/json

Track shipment

GET

https://api.sh.example.com/v1

/interplanetary/shipments/{trackingNumber}

Get the current status and tracking information for an interplanetary shipment

Track shipment › path Parameters

trackingNumber

string · required

Track shipment › Responses

Shipment tracking information retrieved successfully

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

GET/interplanetary/shipments/{trackingNumber}

const options = {method: 'GET'};

fetch('https://api.sh.example.com/v1/interplanetary/shipments/:trackingNumber', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

No example specified for this content type

application/json

Create specialized shipment

POST

https://api.sh.example.com/v1

/interplanetary/specialized-shipments

Creates a new interplanetary shipment for specialized cargo types like cryo, quantum, or antimatter

Create specialized shipment › Request Body

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

Create specialized shipment › Responses

Specialized shipment created successfully

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

POST/interplanetary/specialized-shipments

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    originPlanet: 'Earth',
    destinationPlanet: 'Mars',
    cargo: {
      weight: 1.5,
      volume: 2,
      category: 'HAZARDOUS',
      specialization: {type: 'CRYO', containmentLevel: 4, cryogenicTemp: -196.5}
    },
    shippingClass: 'PRIORITY',
    radiationShielding: true
  })
};

fetch('https://api.sh.example.com/v1/interplanetary/specialized-shipments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "originPlanet": "Earth",
  "destinationPlanet": "Mars",
  "cargo": {
    "weight": 1.5,
    "volume": 2,
    "category": "HAZARDOUS",
    "specialization": {
      "type": "CRYO",
      "containmentLevel": 4,
      "cryogenicTemp": -196.5
    }
  },
  "shippingClass": "PRIORITY",
  "radiationShielding": true
}

json

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "originPlanet": "Earth",
  "destinationPlanet": "Earth",
  "cargo": {
    "weight": 0,
    "volume": 0,
    "category": "GENERAL",
    "metadata": {
      "manufacturer": "SpaceTech Inc",
      "batchNumber": "ST-2024-001"
    },
    "safetyChecks": {
      "default": "default"
    },
    "temperatureControl": {
      "required": true,
      "minTemp": 0,
      "maxTemp": 0
    }
  },
  "shippingClass": "STANDARD",
  "radiationShielding": true,
  "status": "SCHEDULED",
  "estimatedDelivery": "2024-08-25T15:00:00Z",
  "trackingNumber": "trackingNumber",
  "createdAt": "2024-08-25T15:00:00Z"
}

json

application/json

Plan shipping route

POST

https://api.sh.example.com/v1

/interplanetary/route-planning

Plans a shipping route with either direct or multi-hop configuration

Plan shipping route › Request Body

routeType

string · enum · required

Enum values:

DIRECT

MULTI_HOP

required

array

Plan shipping route › Responses

Route planned successfully

routeType

string · enum · required

Enum values:

DIRECT

MULTI_HOP

required

array

POST/interplanetary/route-planning

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({routeType: 'DIRECT', route: {direct: {estimatedDays: 180, fuelType: 'ION'}}})
};

fetch('https://api.sh.example.com/v1/interplanetary/route-planning', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "routeType": "DIRECT",
  "route": {
    "direct": {
      "estimatedDays": 180,
      "fuelType": "ION"
    }
  }
}

json

application/json

Example Responses

{
  "routeType": "DIRECT",
  "route": {
    "direct": {
      "estimatedDays": 0,
      "fuelType": "ION"
    }
  },
  "requirements": [
    {
      "gravitationalAssist": {
        "planet": "planet",
        "minVelocity": 0
      }
    }
  ]
}

json

application/json

List fuel stations

GET

https://api.sh.example.com/v1

/interplanetary/fuel-stations

Returns all available fuel stations along interplanetary routes

List fuel stations › query Parameters

location

string · enum

Filter by orbital location

Enum values:

Earth Orbit

Mars Orbit

Venus Orbit

Jupiter Orbit

Asteroid Belt

fuelType

string · enum

Filter by available fuel type

Enum values:

ION

CHEMICAL

SOLAR

NUCLEAR

List fuel stations › Responses

200

List of fuel stations

object[]

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

GET/interplanetary/fuel-stations

const options = {method: 'GET'};

fetch('https://api.sh.example.com/v1/interplanetary/fuel-stations', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

[
  {
    "stationId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "location": "Earth Orbit",
    "fuelTypes": [
      "ION"
    ],
    "capacity": 0,
    "currentAvailability": 0
  }
]

json

application/json

Interplanetary Shipping API

Interplanetary

Endpoint

Download schema

Create a shipment

POST

https://api.sh.example.com/v1

/interplanetary/shipments

Creates a new interplanetary shipment with the provided details

Create a shipment › Request Body

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

Create a shipment › Responses

Shipment created successfully

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

POST/interplanetary/shipments

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    originPlanet: 'Earth',
    destinationPlanet: 'Mars',
    cargo: {
      weight: 2.5,
      volume: 3,
      category: 'EQUIPMENT',
      temperatureControl: {required: true, minTemp: -10, maxTemp: 25}
    },
    shippingClass: 'PRIORITY',
    radiationShielding: true
  })
};

fetch('https://api.sh.example.com/v1/interplanetary/shipments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "originPlanet": "Earth",
  "destinationPlanet": "Mars",
  "cargo": {
    "weight": 2.5,
    "volume": 3,
    "category": "EQUIPMENT",
    "temperatureControl": {
      "required": true,
      "minTemp": -10,
      "maxTemp": 25
    }
  },
  "shippingClass": "PRIORITY",
  "radiationShielding": true
}

json

application/json

Example Responses

No example specified for this content type

application/json

Track shipment

GET

https://api.sh.example.com/v1

/interplanetary/shipments/{trackingNumber}

Get the current status and tracking information for an interplanetary shipment

Track shipment › path Parameters

trackingNumber

string · required

Track shipment › Responses

Shipment tracking information retrieved successfully

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

GET/interplanetary/shipments/{trackingNumber}

const options = {method: 'GET'};

fetch('https://api.sh.example.com/v1/interplanetary/shipments/:trackingNumber', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

No example specified for this content type

application/json

Create specialized shipment

POST

https://api.sh.example.com/v1

/interplanetary/specialized-shipments

Creates a new interplanetary shipment for specialized cargo types like cryo, quantum, or antimatter

Create specialized shipment › Request Body

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

Create specialized shipment › Responses

Specialized shipment created successfully

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

POST/interplanetary/specialized-shipments

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    originPlanet: 'Earth',
    destinationPlanet: 'Mars',
    cargo: {
      weight: 1.5,
      volume: 2,
      category: 'HAZARDOUS',
      specialization: {type: 'CRYO', containmentLevel: 4, cryogenicTemp: -196.5}
    },
    shippingClass: 'PRIORITY',
    radiationShielding: true
  })
};

fetch('https://api.sh.example.com/v1/interplanetary/specialized-shipments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "originPlanet": "Earth",
  "destinationPlanet": "Mars",
  "cargo": {
    "weight": 1.5,
    "volume": 2,
    "category": "HAZARDOUS",
    "specialization": {
      "type": "CRYO",
      "containmentLevel": 4,
      "cryogenicTemp": -196.5
    }
  },
  "shippingClass": "PRIORITY",
  "radiationShielding": true
}

json

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "originPlanet": "Earth",
  "destinationPlanet": "Earth",
  "cargo": {
    "weight": 0,
    "volume": 0,
    "category": "GENERAL",
    "metadata": {
      "manufacturer": "SpaceTech Inc",
      "batchNumber": "ST-2024-001"
    },
    "safetyChecks": {
      "default": "default"
    },
    "temperatureControl": {
      "required": true,
      "minTemp": 0,
      "maxTemp": 0
    }
  },
  "shippingClass": "STANDARD",
  "radiationShielding": true,
  "status": "SCHEDULED",
  "estimatedDelivery": "2024-08-25T15:00:00Z",
  "trackingNumber": "trackingNumber",
  "createdAt": "2024-08-25T15:00:00Z"
}

json

application/json

Plan shipping route

POST

https://api.sh.example.com/v1

/interplanetary/route-planning

Plans a shipping route with either direct or multi-hop configuration

Plan shipping route › Request Body

routeType

string · enum · required

Enum values:

DIRECT

MULTI_HOP

required

array

Plan shipping route › Responses

Route planned successfully

routeType

string · enum · required

Enum values:

DIRECT

MULTI_HOP

required

array

POST/interplanetary/route-planning

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({routeType: 'DIRECT', route: {direct: {estimatedDays: 180, fuelType: 'ION'}}})
};

fetch('https://api.sh.example.com/v1/interplanetary/route-planning', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "routeType": "DIRECT",
  "route": {
    "direct": {
      "estimatedDays": 180,
      "fuelType": "ION"
    }
  }
}

json

application/json

Example Responses

{
  "routeType": "DIRECT",
  "route": {
    "direct": {
      "estimatedDays": 0,
      "fuelType": "ION"
    }
  },
  "requirements": [
    {
      "gravitationalAssist": {
        "planet": "planet",
        "minVelocity": 0
      }
    }
  ]
}

json

application/json

List fuel stations

GET

https://api.sh.example.com/v1

/interplanetary/fuel-stations

Returns all available fuel stations along interplanetary routes

List fuel stations › query Parameters

location

string · enum

Filter by orbital location

Enum values:

Earth Orbit

Mars Orbit

Venus Orbit

Jupiter Orbit

Asteroid Belt

fuelType

string · enum

Filter by available fuel type

Enum values:

ION

CHEMICAL

SOLAR

NUCLEAR

List fuel stations › Responses

200

List of fuel stations

object[]

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

GET/interplanetary/fuel-stations

const options = {method: 'GET'};

fetch('https://api.sh.example.com/v1/interplanetary/fuel-stations', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

[
  {
    "stationId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "location": "Earth Orbit",
    "fuelTypes": [
      "ION"
    ],
    "capacity": 0,
    "currentAvailability": 0
  }
]

json

application/json