Cargo Container Specifications API

Containers

Endpointhttps://api.cosmocargo.space/v2

Container type specifications and capabilities

List Available Container Types

GET

https://api.cosmocargo.space/v2

/containers

Retrieve all available container types across the galaxy. Each container type has unique specifications and capabilities.

List Available Container Types › query Parameters

category

string · enum

Filter by container category

Enum values:

standard

specialized

hazardous

luxury

maxVolume

number

Maximum volume in cubic parsec-meters

List Available Container Types › Responses

200

List of available containers

array

total

integer

GET/containers

const options = {method: 'GET'};

fetch('https://api.cosmocargo.space/v2/containers', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "containers": [
    {
      "dimensions": {
        "length": 0,
        "width": 0,
        "height": 0
      },
      "maxWeight": 0,
      "shieldRating": "basic",
      "type": "standard",
      "stackable": true,
      "standardFeatures": [
        "anti-gravity-hooks"
      ]
    }
  ],
  "total": 0
}

json

application/json

Get Container Details

GET

https://api.cosmocargo.space/v2

/containers/{containerId}

Retrieve detailed information about a specific container booking.

Get Container Details › path Parameters

containerId

string · pattern: ^CNT-[A-Z0-9]{8}$ · required

Unique container identifier

Get Container Details › Responses

Container details

required

object · required

required

object · required

required

bookingId

string · pattern: ^BK-[A-Z0-9]{10}$ · required

status

string · enum · required

Enum values:

pending

confirmed

in-transit

delivered

cancelled

createdAt

string · date-time · required

array

Multiple handling requirements can be specified

object

Base insurance coverage

notes

string

Additional booking notes

containerId

string · pattern: ^CNT-[A-Z0-9]{8}$

updatedAt

string · date-time

trackingUrl

string · uri

GET/containers/{containerId}

const options = {method: 'GET'};

fetch('https://api.cosmocargo.space/v2/containers/:containerId', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "container": {
    "dimensions": {
      "length": 0,
      "width": 0,
      "height": 0
    },
    "maxWeight": 0,
    "shieldRating": "basic",
    "type": "standard",
    "stackable": true,
    "standardFeatures": [
      "anti-gravity-hooks"
    ]
  },
  "route": {
    "origin": "origin",
    "destination": "destination",
    "waypoints": [
      "string"
    ]
  },
  "deliverySpeed": {
    "type": "standard-orbit",
    "estimatedDays": 0,
    "trackingEnabled": true
  },
  "handlingRequirements": [
    {
      "type": "anti-gravity",
      "intensity": "low"
    }
  ],
  "insurance": {
    "coverageAmount": 0,
    "deductible": 0,
    "policyNumber": "policyNumber",
    "coverageExtensions": {
      "spaceDebris": true
    }
  },
  "customer": {
    "name": "name",
    "customerId": "customerId",
    "contactInfo": {
      "notifications": [
        {
          "type": "email",
          "email": "test@example.com"
        }
      ]
    }
  },
  "payment": {
    "type": "galactic-credits",
    "accountNumber": "accountNumber",
    "autoDeduct": true
  },
  "notes": "notes",
  "bookingId": "bookingId",
  "containerId": "containerId",
  "status": "pending",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "trackingUrl": "https://www.example.com/path/to/resource"
}

json

application/json

Update Container Specifications

PATCH

https://api.cosmocargo.space/v2

/containers/{containerId}

Modify container specifications before departure. Some modifications may incur additional fees.

Update Container Specifications › path Parameters

containerId

string · required

Update Container Specifications › Request Body

Partial update to container specifications

array

notes

string

Update Container Specifications › Responses

200

Container updated successfully

required

object · required

required

object · required

required

bookingId

string · pattern: ^BK-[A-Z0-9]{10}$ · required

status

string · enum · required

Enum values:

pending

confirmed

in-transit

delivered

cancelled

createdAt

string · date-time · required

array

Multiple handling requirements can be specified

object

Base insurance coverage

notes

string

Additional booking notes

containerId

string · pattern: ^CNT-[A-Z0-9]{8}$

updatedAt

string · date-time

trackingUrl

string · uri

PATCH/containers/{containerId}

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    handlingRequirements: [{type: 'anti-gravity', intensity: 'low'}],
    notifications: [{type: 'email', email: 'test@example.com'}],
    notes: 'notes'
  })
};

fetch('https://api.cosmocargo.space/v2/containers/:containerId', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Request Body

{
  "handlingRequirements": [
    {
      "type": "anti-gravity",
      "intensity": "low"
    }
  ],
  "notifications": [
    {
      "type": "email",
      "email": "test@example.com"
    }
  ],
  "notes": "notes"
}

json

Example Responses

{
  "container": {
    "dimensions": {
      "length": 0,
      "width": 0,
      "height": 0
    },
    "maxWeight": 0,
    "shieldRating": "basic",
    "type": "standard",
    "stackable": true,
    "standardFeatures": [
      "anti-gravity-hooks"
    ]
  },
  "route": {
    "origin": "origin",
    "destination": "destination",
    "waypoints": [
      "string"
    ]
  },
  "deliverySpeed": {
    "type": "standard-orbit",
    "estimatedDays": 0,
    "trackingEnabled": true
  },
  "handlingRequirements": [
    {
      "type": "anti-gravity",
      "intensity": "low"
    }
  ],
  "insurance": {
    "coverageAmount": 0,
    "deductible": 0,
    "policyNumber": "policyNumber",
    "coverageExtensions": {
      "spaceDebris": true
    }
  },
  "customer": {
    "name": "name",
    "customerId": "customerId",
    "contactInfo": {
      "notifications": [
        {
          "type": "email",
          "email": "test@example.com"
        }
      ]
    }
  },
  "payment": {
    "type": "galactic-credits",
    "accountNumber": "accountNumber",
    "autoDeduct": true
  },
  "notes": "notes",
  "bookingId": "bookingId",
  "containerId": "containerId",
  "status": "pending",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "trackingUrl": "https://www.example.com/path/to/resource"
}

json

application/json

Booking

List Available Container Types

GET

https://api.cosmocargo.space/v2

/containers

Retrieve all available container types across the galaxy. Each container type has unique specifications and capabilities.

List Available Container Types › query Parameters

category

string · enum

Filter by container category

Enum values:

standard

specialized

hazardous

luxury

maxVolume

number

Maximum volume in cubic parsec-meters

List Available Container Types › Responses

200

List of available containers

array

total

integer

Get Container Details

GET

https://api.cosmocargo.space/v2

/containers/{containerId}

Retrieve detailed information about a specific container booking.

Get Container Details › path Parameters

containerId

string · pattern: ^CNT-[A-Z0-9]{8}$ · required

Unique container identifier

Get Container Details › Responses

Container details

required

object · required

required

object · required

required

bookingId

string · pattern: ^BK-[A-Z0-9]{10}$ · required

status

string · enum · required

Enum values:

pending

confirmed

in-transit

delivered

cancelled

createdAt

string · date-time · required

array

Multiple handling requirements can be specified

object

Base insurance coverage

notes

string

Additional booking notes

containerId

string · pattern: ^CNT-[A-Z0-9]{8}$

updatedAt

string · date-time

trackingUrl

string · uri

const options = {method: 'GET'}; fetch('https://api.cosmocargo.space/v2/containers/:containerId', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "container": { "dimensions": { "length": 0, "width": 0, "height": 0 }, "maxWeight": 0, "shieldRating": "basic", "type": "standard", "stackable": true, "standardFeatures": [ "anti-gravity-hooks" ] }, "route": { "origin": "origin", "destination": "destination", "waypoints": [ "string" ] }, "deliverySpeed": { "type": "standard-orbit", "estimatedDays": 0, "trackingEnabled": true }, "handlingRequirements": [ { "type": "anti-gravity", "intensity": "low" } ], "insurance": { "coverageAmount": 0, "deductible": 0, "policyNumber": "policyNumber", "coverageExtensions": { "spaceDebris": true } }, "customer": { "name": "name", "customerId": "customerId", "contactInfo": { "notifications": [ { "type": "email", "email": "test@example.com" } ] } }, "payment": { "type": "galactic-credits", "accountNumber": "accountNumber", "autoDeduct": true }, "notes": "notes", "bookingId": "bookingId", "containerId": "containerId", "status": "pending", "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z", "trackingUrl": "https://www.example.com/path/to/resource" }

Update Container Specifications

PATCH

https://api.cosmocargo.space/v2

/containers/{containerId}

Modify container specifications before departure. Some modifications may incur additional fees.

Update Container Specifications › path Parameters

containerId

string · required

Update Container Specifications › Request Body

Partial update to container specifications

array

notes

string

Update Container Specifications › Responses

200

Container updated successfully

required

object · required

required

object · required

required

bookingId

string · pattern: ^BK-[A-Z0-9]{10}$ · required

status

string · enum · required

Enum values:

pending

confirmed

in-transit

delivered

cancelled

createdAt

string · date-time · required

array

Multiple handling requirements can be specified

object

Base insurance coverage

notes

string

Additional booking notes

containerId

string · pattern: ^CNT-[A-Z0-9]{8}$

updatedAt

string · date-time

trackingUrl

string · uri

const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: JSON.stringify({ handlingRequirements: [{type: 'anti-gravity', intensity: 'low'}], notifications: [{type: 'email', email: 'test@example.com'}], notes: 'notes' }) }; fetch('https://api.cosmocargo.space/v2/containers/:containerId', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "handlingRequirements": [ { "type": "anti-gravity", "intensity": "low" } ], "notifications": [ { "type": "email", "email": "test@example.com" } ], "notes": "notes" }