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

  • 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

  • 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

      Shipping speed class

      Enum values:
      STANDARD
      EXPRESS
      PRIORITY
    • idstringย ยทย uuidย ยทย readOnly
    • radiationShieldingboolean

      Whether cargo needs radiation shielding

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

Get the current status and tracking information for an interplanetary shipment

โ€‹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

      Shipping speed class

      Enum values:
      STANDARD
      EXPRESS
      PRIORITY
    • idstringย ยทย uuidย ยทย readOnly
    • radiationShieldingboolean

      Whether cargo needs radiation shielding

    • statusstringย ยทย enumย ยทย readOnly
      Enum values:
      SCHEDULED
      LAUNCHED
      IN_TRANSIT
      APPROACHING
      LANDED
      DELIVERED
    • estimatedDeliverystringย ยทย date-timeย ยทย readOnly
    • trackingNumberstringย ยทย readOnly
    • createdAtstringย ยทย date-timeย ยทย readOnly