Containers

ContainerType · required

object · required

DeliverySpeed · required

object · required

PaymentMethod · required

Shared transaction metadata for any payment method.

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

Multiple handling requirements can be specified

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}

fetch('https://api.cosmocargo.space/v2/containers/:containerId')

Example Responses

{
  "container": {
    "dimensions": {
      "length": 100,
      "width": 100,
      "height": 100
    },
    "maxWeight": 1,
    "shieldRating": "basic",
    "type": "standard",
    "stackable": true,
    "standardFeatures": [
      "anti-gravity-hooks"
    ]
  },
  "route": {
    "origin": "origin",
    "destination": "destination",
    "waypoints": [
      "string"
    ]
  },
  "deliverySpeed": {
    "type": "standard-orbit",
    "estimatedDays": 7,
    "trackingEnabled": true
  },
  "handlingRequirements": [
    {
      "type": "anti-gravity",
      "intensity": "low"
    }
  ],
  "insurance": {
    "coverageAmount": 1000,
    "deductible": 0,
    "policyNumber": "policyNumber",
    "coverageExtensions": {
      "spaceDebris": true
    }
  },
  "customer": {
    "name": "name",
    "customerId": "customerId",
    "contactInfo": {
      "notifications": [
        {
          "type": "email",
          "email": "test@example.com"
        }
      ]
    }
  },
  "payment": {
    "amount": 0,
    "currencyCode": "GCR",
    "transactionRef": "transactionRef",
    "memo": "memo"
  },
  "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

ContainerUpdate

NotificationChannel[]

notes

string

Update Container Specifications › Responses

200

Container updated successfully

ContainerType · required

object · required

DeliverySpeed · required

object · required

PaymentMethod · required

Shared transaction metadata for any payment method.

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

Multiple handling requirements can be specified

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}

fetch('https://api.cosmocargo.space/v2/containers/:containerId', {
  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'
  })
})

Example Request Body

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

json

Example Responses

{
  "container": {
    "dimensions": {
      "length": 100,
      "width": 100,
      "height": 100
    },
    "maxWeight": 1,
    "shieldRating": "basic",
    "type": "standard",
    "stackable": true,
    "standardFeatures": [
      "anti-gravity-hooks"
    ]
  },
  "route": {
    "origin": "origin",
    "destination": "destination",
    "waypoints": [
      "string"
    ]
  },
  "deliverySpeed": {
    "type": "standard-orbit",
    "estimatedDays": 7,
    "trackingEnabled": true
  },
  "handlingRequirements": [
    {
      "type": "anti-gravity",
      "intensity": "low"
    }
  ],
  "insurance": {
    "coverageAmount": 1000,
    "deductible": 0,
    "policyNumber": "policyNumber",
    "coverageExtensions": {
      "spaceDebris": true
    }
  },
  "customer": {
    "name": "name",
    "customerId": "customerId",
    "contactInfo": {
      "notifications": [
        {
          "type": "email",
          "email": "test@example.com"
        }
      ]
    }
  },
  "payment": {
    "amount": 0,
    "currencyCode": "GCR",
    "transactionRef": "transactionRef",
    "memo": "memo"
  },
  "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

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

ContainerType[]

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

ContainerType · required

object · required

DeliverySpeed · required

object · required

PaymentMethod · required

Shared transaction metadata for any payment method.

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

Multiple handling requirements can be specified

Base insurance coverage

notes

string

Additional booking notes

containerId

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

updatedAt

string · date-time

trackingUrl

string · uri

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

ContainerUpdate

NotificationChannel[]

notes

string

Update Container Specifications › Responses

200

Container updated successfully

ContainerType · required

object · required

DeliverySpeed · required

object · required

PaymentMethod · required

Shared transaction metadata for any payment method.

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

Multiple handling requirements can be specified