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 schemas › query Parameters

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

​List available schemas › Responses

    • schemasobject[]
    • countinteger

​Get schema details

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

​Get schema details › path Parameters

  • schemaIdstring · required

​Get schema details › query Parameters

  • includeStructureboolean
    Default: true

​Get schema details › Responses

    • metadataobject
    • structureobject

​Get facility capabilities

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

​Get facility capabilities › query Parameters

  • facilityIdsarray | null
  • statusesobject[]

​Get facility capabilities › Responses

    • facilitiesarray | null
    • metadataobject
Tracking & NotificationsOrganization Management