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

Create a shipment

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

Creates a new interplanetary shipment with the provided details

Request Body

  • originPlanet
    string
  • destinationPlanet
    string
  • cargo
    object
  • shippingClass
    string

    Shipping speed class

  • id
    string
    optional
  • radiationShielding
    boolean
    optional

    Whether cargo needs radiation shielding

  • status
    string
    optional
  • estimatedDelivery
    string
    optional
  • trackingNumber
    string
    optional
  • createdAt
    string
    optional

Responses

    • originPlanet
      string
    • destinationPlanet
      string
    • cargo
      object
    • shippingClass
      string

      Shipping speed class

    • id
      string
      optional
    • radiationShielding
      boolean
      optional

      Whether cargo needs radiation shielding

    • status
      string
      optional
    • estimatedDelivery
      string
      optional
    • trackingNumber
      string
      optional
    • createdAt
      string
      optional

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

  • trackingNumber
    string
    required

Responses

    • originPlanet
      string
    • destinationPlanet
      string
    • cargo
      object
    • shippingClass
      string

      Shipping speed class

    • id
      string
      optional
    • radiationShielding
      boolean
      optional

      Whether cargo needs radiation shielding

    • status
      string
      optional
    • estimatedDelivery
      string
      optional
    • trackingNumber
      string
      optional
    • createdAt
      string
      optional