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

Schemas

Endpoint

List available schemas

GET
https://api.sh.example.com/v1
/schemas

List available schemasquery Parameters

  • entityTypestring · enum
    Enum values:
    CARGO
    VESSEL
    CREW
    ROUTE
    STATION
    PLANET
    ASTEROID
    SATELLITE
  • versionstring · pattern: ^\d+\.\d+\.\d+$

List available schemasResponses

    • schemasobject[]
    • countinteger

Get schema details

GET
https://api.sh.example.com/v1
/schemas/{schemaId}

Get schema detailspath Parameters

  • schemaIdstring · required

Get schema detailsquery Parameters

  • includeStructureboolean
    Default: true

Get schema detailsResponses

    • metadataobject
    • structureobject

Get facility capabilities

GET
https://api.sh.example.com/v1
/schemas/facility-capabilities

Get facility capabilitiesquery Parameters

  • facilityIdsarray | null
  • statusesobject[]

Get facility capabilitiesResponses

    • facilitiesarray | null
    • metadataobject