Shipment API

Schemas

Endpoint

Download schema

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

List available schemas

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/schemas

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

List available schemas › query Parameters

entityType

string · enum

Filter schemas by space entity type

Enum values:

CARGO

VESSEL

CREW

ROUTE

STATION

PLANET

ASTEROID

SATELLITE

version

string · pattern: ^\d+\.\d+\.\d+$

Filter schemas by version

List available schemas › Responses

200

List of schemas retrieved successfully

object[]

count

integer

Total number of schemas returned

GET/schemas

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//schemas', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "schemas": [
    {
      "id": "cargo-manifest-v1",
      "name": "Cargo Manifest",
      "version": "1.0.0",
      "description": "Schema for interplanetary cargo manifests",
      "createdAt": "2024-06-15T08:00:00Z",
      "updatedAt": "2024-06-15T08:00:00Z",
      "spaceEntityType": "CARGO"
    },
    {
      "id": "vessel-specs-v2",
      "name": "Vessel Specifications",
      "version": "2.1.0",
      "description": "Technical specifications for space vessels",
      "createdAt": "2024-05-10T14:30:00Z",
      "updatedAt": "2024-07-22T09:15:00Z",
      "spaceEntityType": "VESSEL"
    },
    {
      "id": "route-plan-v3",
      "name": "Route Planning",
      "version": "3.0.2",
      "description": "Interplanetary route planning and navigation",
      "createdAt": "2024-04-01T11:45:00Z",
      "updatedAt": "2024-07-15T16:20:00Z",
      "spaceEntityType": "ROUTE"
    }
  ],
  "count": 3
}

json

application/json

Get schema details

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/schemas/{schemaId}

Retrieve detailed information about a specific schema, including its structure

Get schema details › path Parameters

schemaId

string · required

Unique identifier of the schema

Get schema details › query Parameters

includeStructure

boolean

Whether to include the full schema structure

Default: true

Get schema details › Responses

Schema details retrieved successfully

object

Metadata about a schema

structure

object

The JSON Schema structure

GET/schemas/{schemaId}

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//schemas/:schemaId', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "metadata": {
    "id": "cargo-manifest-v1",
    "name": "Cargo Manifest",
    "version": "1.0.0",
    "description": "Schema for interplanetary cargo manifests",
    "createdAt": "2024-06-15T08:00:00Z",
    "updatedAt": "2024-06-15T08:00:00Z",
    "spaceEntityType": "CARGO"
  },
  "structure": {
    "type": "object",
    "required": [
      "manifestId",
      "vesselId",
      "items"
    ],
    "properties": {
      "manifestId": {
        "type": "string",
        "description": "Unique identifier for the cargo manifest"
      },
      "vesselId": {
        "type": "string",
        "description": "ID of the vessel carrying the cargo"
      },
      "departureDate": {
        "type": "string",
        "format": "date-time",
        "description": "When the vessel departs"
      },
      "items": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "itemId": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "quantity": {
              "type": "integer",
              "minimum": 1
            },
            "weight": {
              "type": "number"
            },
            "hazardClass": {
              "type": "string",
              "enum": [
                "NONE",
                "CLASS_1",
                "CLASS_2",
                "CLASS_3"
              ]
            }
          }
        }
      }
    }
  }
}

json

application/json

Get facility capabilities

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/schemas/facility-capabilities

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

Get facility capabilities › query Parameters

facilityIds

array | null

Array of facility IDs to test

object[]

Array of status configurations

Get facility capabilities › Responses

200

Test response with array and nullable types

array | null

object

GET/schemas/facility-capabilities

const options = {method: 'GET'};

fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//schemas/facility-capabilities', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "facilities": [
    {
      "id": "LAX1",
      "status": "ACTIVE",
      "capabilities": [
        "CARGO",
        "MAINTENANCE"
      ]
    },
    {
      "id": "JFK2",
      "status": null,
      "capabilities": [
        "CARGO",
        "PASSENGER",
        "STORAGE"
      ]
    }
  ],
  "metadata": {
    "tags": [
      "SPACE",
      "INTERNATIONAL"
    ],
    "coordinates": [
      34.0522,
      -118.2437
    ]
  }
}

json

application/json

Documentation Organization Management

List available schemas

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/schemas

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

List available schemas › query Parameters

entityType

string · enum

Filter schemas by space entity type

Enum values:

CARGO

VESSEL

CREW

ROUTE

STATION

PLANET

ASTEROID

SATELLITE

version

string · pattern: ^\d+\.\d+\.\d+$

Filter schemas by version

List available schemas › Responses

200

List of schemas retrieved successfully

object[]

count

integer

Total number of schemas returned

const options = {method: 'GET'}; fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//schemas', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "schemas": [ { "id": "cargo-manifest-v1", "name": "Cargo Manifest", "version": "1.0.0", "description": "Schema for interplanetary cargo manifests", "createdAt": "2024-06-15T08:00:00Z", "updatedAt": "2024-06-15T08:00:00Z", "spaceEntityType": "CARGO" }, { "id": "vessel-specs-v2", "name": "Vessel Specifications", "version": "2.1.0", "description": "Technical specifications for space vessels", "createdAt": "2024-05-10T14:30:00Z", "updatedAt": "2024-07-22T09:15:00Z", "spaceEntityType": "VESSEL" }, { "id": "route-plan-v3", "name": "Route Planning", "version": "3.0.2", "description": "Interplanetary route planning and navigation", "createdAt": "2024-04-01T11:45:00Z", "updatedAt": "2024-07-15T16:20:00Z", "spaceEntityType": "ROUTE" } ], "count": 3 }

Get schema details

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/schemas/{schemaId}

Retrieve detailed information about a specific schema, including its structure

Get schema details › path Parameters

schemaId

string · required

Unique identifier of the schema

Get schema details › query Parameters

includeStructure

boolean

Whether to include the full schema structure

Default: true

Get schema details › Responses

Schema details retrieved successfully

object

Metadata about a schema

structure

object

The JSON Schema structure

const options = {method: 'GET'}; fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//schemas/:schemaId', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "metadata": { "id": "cargo-manifest-v1", "name": "Cargo Manifest", "version": "1.0.0", "description": "Schema for interplanetary cargo manifests", "createdAt": "2024-06-15T08:00:00Z", "updatedAt": "2024-06-15T08:00:00Z", "spaceEntityType": "CARGO" }, "structure": { "type": "object", "required": [ "manifestId", "vesselId", "items" ], "properties": { "manifestId": { "type": "string", "description": "Unique identifier for the cargo manifest" }, "vesselId": { "type": "string", "description": "ID of the vessel carrying the cargo" }, "departureDate": { "type": "string", "format": "date-time", "description": "When the vessel departs" }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "integer", "minimum": 1 }, "weight": { "type": "number" }, "hazardClass": { "type": "string", "enum": [ "NONE", "CLASS_1", "CLASS_2", "CLASS_3" ] } } } } } } }

Get facility capabilities

GET

https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io

/schemas/facility-capabilities

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

Get facility capabilities › query Parameters

facilityIds

array | null

Array of facility IDs to test

object[]

Array of status configurations

Get facility capabilities › Responses

200

Test response with array and nullable types

array | null

object

const options = {method: 'GET'}; fetch('https://8f9618f3bc0f4eec989627ceaafd5e4d_oas.api.mockbin.io//schemas/facility-capabilities', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "facilities": [ { "id": "LAX1", "status": "ACTIVE", "capabilities": [ "CARGO", "MAINTENANCE" ] }, { "id": "JFK2", "status": null, "capabilities": [ "CARGO", "PASSENGER", "STORAGE" ] } ], "metadata": { "tags": [ "SPACE", "INTERNATIONAL" ], "coordinates": [ 34.0522, -118.2437 ] } }