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

Interplanetary Shipping API

This API enables interplanetary shipping capabilities through the Ship Happens platform.

Authentication

All endpoints require a valid API key passed in the X-API-Key header.


Endpoint
Interplanetary

Create a shipment

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

Creates a new interplanetary shipment with the provided details

Request Body

  • originPlanetstring
  • destinationPlanetstring
  • cargoobject
  • shippingClassstring

    Shipping speed class

  • idstringoptional
  • radiationShieldingbooleanoptional

    Whether cargo needs radiation shielding

  • statusstringoptional
  • estimatedDeliverystringoptional
  • trackingNumberstringoptional
  • createdAtstringoptional

Responses

    • originPlanetstring
    • destinationPlanetstring
    • cargoobject
    • shippingClassstring

      Shipping speed class

    • idstringoptional
    • radiationShieldingbooleanoptional

      Whether cargo needs radiation shielding

    • statusstringoptional
    • estimatedDeliverystringoptional
    • trackingNumberstringoptional
    • createdAtstringoptional

Track shipment

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

Get the current status and tracking information for an interplanetary shipment

path Parameters

  • trackingNumberrequiredstring

Responses

    • originPlanetstring
    • destinationPlanetstring
    • cargoobject
    • shippingClassstring

      Shipping speed class

    • idstringoptional
    • radiationShieldingbooleanoptional

      Whether cargo needs radiation shielding

    • statusstringoptional
    • estimatedDeliverystringoptional
    • trackingNumberstringoptional
    • createdAtstringoptional