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

​Interplanetary

Endpoint

​Create a shipment

POST
https://api.sh.example.com/v1
/interplanetary/shipments

​Create a shipment › Request Body

  • 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
    Enum values:
    STANDARD
    EXPRESS
    PRIORITY
  • idstring · uuid · readOnly
  • radiationShieldingboolean
    Default: true
  • statusstring · enum · readOnly
    Enum values:
    SCHEDULED
    LAUNCHED
    IN_TRANSIT
    APPROACHING
    LANDED
    DELIVERED
  • estimatedDeliverystring · date-time · readOnly
  • trackingNumberstring · readOnly
  • createdAtstring · date-time · readOnly

​Create a shipment › Responses

    • 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
      Enum values:
      STANDARD
      EXPRESS
      PRIORITY
    • idstring · uuid · readOnly
    • radiationShieldingboolean
      Default: true
    • statusstring · enum · readOnly
      Enum values:
      SCHEDULED
      LAUNCHED
      IN_TRANSIT
      APPROACHING
      LANDED
      DELIVERED
    • estimatedDeliverystring · date-time · readOnly
    • trackingNumberstring · readOnly
    • createdAtstring · date-time · readOnly

​Track shipment

GET
https://api.sh.example.com/v1
/interplanetary/shipments/{trackingNumber}

​Track shipment › path Parameters

  • trackingNumberstring · required

​Track shipment › Responses

    • 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
      Enum values:
      STANDARD
      EXPRESS
      PRIORITY
    • idstring · uuid · readOnly
    • radiationShieldingboolean
      Default: true
    • statusstring · enum · readOnly
      Enum values:
      SCHEDULED
      LAUNCHED
      IN_TRANSIT
      APPROACHING
      LANDED
      DELIVERED
    • estimatedDeliverystring · date-time · readOnly
    • trackingNumberstring · readOnly
    • createdAtstring · date-time · readOnly

​Create specialized shipment

POST
https://api.sh.example.com/v1
/interplanetary/specialized-shipments

​Create specialized shipment › Request Body

  • 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
    Enum values:
    STANDARD
    EXPRESS
    PRIORITY
  • idstring · uuid · readOnly
  • radiationShieldingboolean
    Default: true
  • statusstring · enum · readOnly
    Enum values:
    SCHEDULED
    LAUNCHED
    IN_TRANSIT
    APPROACHING
    LANDED
    DELIVERED
  • estimatedDeliverystring · date-time · readOnly
  • trackingNumberstring · readOnly
  • createdAtstring · date-time · readOnly

​Create specialized shipment › Responses

    • 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
      Enum values:
      STANDARD
      EXPRESS
      PRIORITY
    • idstring · uuid · readOnly
    • radiationShieldingboolean
      Default: true
    • statusstring · enum · readOnly
      Enum values:
      SCHEDULED
      LAUNCHED
      IN_TRANSIT
      APPROACHING
      LANDED
      DELIVERED
    • estimatedDeliverystring · date-time · readOnly
    • trackingNumberstring · readOnly
    • createdAtstring · date-time · readOnly

​Plan shipping route

POST
https://api.sh.example.com/v1
/interplanetary/route-planning

​Plan shipping route › Request Body

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

​Plan shipping route › Responses

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