Cargo API

📋 Table of Contents

• Overview

• Cargo Management

• Cargo Operations

• Cargo Tracking

• Error Responses

Overview

The Cargo API provides cargo and logistics management for the OASIS ecosystem. It handles cargo creation, shipping, tracking, and delivery.

Cargo Management

Get All Cargo

GET /api/cargo
Authorization: Bearer YOUR_TOKEN

Get Cargo by ID

GET /api/cargo/{cargoId}
Authorization: Bearer YOUR_TOKEN

Create Cargo

POST /api/cargo
Authorization: Bearer YOUR_TOKEN

Update Cargo

PUT /api/cargo/{cargoId}
Authorization: Bearer YOUR_TOKEN

Delete Cargo

DELETE /api/cargo/{cargoId}
Authorization: Bearer YOUR_TOKEN

Cargo Operations

Ship Cargo

POST /api/cargo/{cargoId}/ship
Authorization: Bearer YOUR_TOKEN

Deliver Cargo

POST /api/cargo/{cargoId}/deliver
Authorization: Bearer YOUR_TOKEN

Cancel Shipment

POST /api/cargo/{cargoId}/cancel
Authorization: Bearer YOUR_TOKEN

Cargo Tracking

Track Cargo

GET /api/cargo/{cargoId}/track
Authorization: Bearer YOUR_TOKEN

Get Cargo Status

GET /api/cargo/{cargoId}/status
Authorization: Bearer YOUR_TOKEN

Get Cargo History

GET /api/cargo/{cargoId}/history
Authorization: Bearer YOUR_TOKEN

Error Responses

Cargo Not Found

{
  "result": null,
  "isError": true,
  "message": "Cargo not found"
}

Shipment Failed

{
  "result": null,
  "isError": true,
  "message": "Shipment failed"
}

---

Navigation

← Previous: OLand API | Next: Avatar API →