Booking

Endpointhttps://api.cosmocargo.space/v2

Download schema

Container booking and reservation management

Request Container Quote

POST

https://api.cosmocargo.space/v2

/containers/quote

Generate a detailed quote for a container booking based on specifications, route, and service level.

Request Container Quote › Request Body

required

object · required

required

array

Multiple handling requirements can be specified

object

Base insurance coverage

Request Container Quote › Responses

Quote generated successfully

quoteId

string · required

totalCost

number · required

Total cost in galactic credits

object · required

validUntil

string · date-time · required

estimatedDelivery

string · date-time

POST/containers/quote

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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}
    }
  })
};

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

Example Request Body

{
  "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
    }
  }
}

json

Example Responses

{
  "quoteId": "quoteId",
  "totalCost": 0,
  "breakdown": {
    "containerFee": 0,
    "deliveryFee": 0,
    "handlingFees": 0,
    "insurancePremium": 0,
    "taxes": 0
  },
  "validUntil": "2024-08-25T15:00:00Z",
  "estimatedDelivery": "2024-08-25T15:00:00Z"
}

json

application/json

Book a Container

POST

https://api.cosmocargo.space/v2

/containers/book

Create a new container booking with detailed specifications. This endpoint accepts complex container configurations using composition patterns.

Book a Container › Request Body

required

object · required

required

object · required

required

array

Multiple handling requirements can be specified

object

Base insurance coverage

notes

string

Additional booking notes

Book a Container › Responses

Booking created 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

POST/containers/book

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {type: 'galactic-credits', accountNumber: 'accountNumber', autoDeduct: true},
    notes: 'notes'
  })
};

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

Example Request Body

{
  "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": {
    "type": "galactic-credits",
    "accountNumber": "accountNumber",
    "autoDeduct": true
  },
  "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": {
    "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": 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": {
    "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

Containers Quotes

Request Container Quote

POST

https://api.cosmocargo.space/v2

/containers/quote

Generate a detailed quote for a container booking based on specifications, route, and service level.

Request Container Quote › Request Body

required

object · required

required

array

Multiple handling requirements can be specified

object

Base insurance coverage

Request Container Quote › Responses

Quote generated successfully

quoteId

string · required

totalCost

number · required

Total cost in galactic credits

object · required

validUntil

string · date-time · required

estimatedDelivery

string · date-time

Book a Container

POST

https://api.cosmocargo.space/v2

/containers/book

Create a new container booking with detailed specifications. This endpoint accepts complex container configurations using composition patterns.

Book a Container › Request Body

required

object · required

required

object · required

required

array

Multiple handling requirements can be specified

object

Base insurance coverage

notes

string

Additional booking notes

Book a Container › Responses

Booking created 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

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