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

​Schemas

Endpoint

Endpoints for retrieving and validating data schemas used across the Cosmo Cargo platform.

​List available schemas

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

Retrieve a list of all available data schemas in the Cosmo Cargo platform

​List available schemas › query Parameters

  • entityTypestring · enum

    Filter schemas by space entity type

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

    Filter schemas by version

​List available schemas › Responses

    • schemasobject[]
    • countinteger

      Total number of schemas returned

​Get schema details

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

Retrieve detailed information about a specific schema, including its structure

​Get schema details › path Parameters

  • schemaIdstring · required

    Unique identifier of the schema

​Get schema details › query Parameters

  • includeStructureboolean

    Whether to include the full schema structure

    Default:

​Get schema details › Responses

    • metadataobject

      Metadata about a schema

    • structureobject

      The JSON Schema structure

​Get facility capabilities

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

Retrieve detailed capability information for space cargo facilities, including their operational status and supported features

​Get facility capabilities › query Parameters

  • facilityIdsarray | null

    Array of facility IDs to test

  • statusesobject[]

    Array of status configurations

​Get facility capabilities › Responses

    • facilitiesarray | null
    • metadataobject
Tracking & NotificationsOrganization Management