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

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
  • cargo
    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

  • 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

    • originPlanet
      string · enum · required
      Enum values:
      Earth
      Mars
      Venus
      Mercury
      Jupiter
    • destinationPlanet
      string · enum · required
      Enum values:
      Earth
      Mars
      Venus
      Mercury
      Jupiter
    • cargo
      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

    • 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

​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

    • originPlanet
      string · enum · required
      Enum values:
      Earth
      Mars
      Venus
      Mercury
      Jupiter
    • destinationPlanet
      string · enum · required
      Enum values:
      Earth
      Mars
      Venus
      Mercury
      Jupiter
    • cargo
      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

    • 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