Skip to main content
API docs by Redocly

Road Freight TMS API (0.2.0)

Download OpenAPI specification:Download

Trịnh Công Đức: ductuyetvoi@gmail.com License: MIT

Multi-tenant Transportation Management System / Hệ thống quản lý vận tải đa tổ chức: RBAC + DAC, route optimization, live GPS tracking, AI Agent, chatbot, reporting.

Auth

Authentication: login, refresh token, password management / Xác thực: đăng nhập, refresh token, đổi mật khẩu

Register a new tenant owner account / Đăng ký tài khoản chủ tổ chức mới

Request Body schema: application/json
required
Email
required
string <email>
Password
required
string >= 8 characters
FullName
required
string
OrganizationName
required
string

Responses

Request samples

Content type
application/json
{
  • "Email": "user@example.com",
  • "Password": "stringst",
  • "FullName": "string",
  • "OrganizationName": "string"
}

Login and return JWT access/refresh tokens / Đăng nhập và trả JWT access/refresh token

Request Body schema: application/json
required
Email
required
string <email>
Password
required
string

Responses

Request samples

Content type
application/json
{
  • "Email": "user@example.com",
  • "Password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get current authenticated user / Lấy thông tin user hiện tại

Authorizations:
bearerAuth

Responses

Master Data

Master data: customers, products, vehicles, drivers, depots, services / Dữ liệu nền: khách hàng, sản phẩm, xe, tài xế, kho, dịch vụ

List maintenance records / Liệt kê lịch bảo dưỡng

Authorizations:
bearerAuth

Responses

Create a vehicle maintenance schedule / Tạo lịch bảo dưỡng xe

Authorizations:
bearerAuth

Responses

Update maintenance record / Cập nhật bản ghi bảo dưỡng

Authorizations:
bearerAuth

Delete maintenance record / Xóa bản ghi bảo dưỡng

Authorizations:
bearerAuth

Orders

Order lifecycle management / Quản lý vòng đời đơn hàng

Route Planning

Route planning and VRP optimization / Lập kế hoạch và tối ưu lộ trình

Auto assign drivers to routes / Tự động phân công tài xế cho tuyến

Chấm điểm tài xế theo workload + completion rate + seniority + vehicle match, gán greedy.

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Trips

Trips, driver assignment, GPS, ePOD, completion / Chuyến đi, phân công tài xế, GPS, ePOD, hoàn tất

Driver

Driver mobile app APIs / API cho app tài xế

Reports

Reports, payroll, revenue, cost, maintenance / Báo cáo, bảng lương, doanh thu, chi phí, bảo dưỡng

Driver payroll and commission by month / Bảng lương và hoa hồng tài xế theo tháng

Authorizations:
bearerAuth
query Parameters
month
string
Example: month=2026-05
driverId
string

Responses

Get payroll configuration / Lấy cấu hình lương

Authorizations:
bearerAuth

Update payroll configuration / Cập nhật cấu hình lương

Authorizations:
bearerAuth

AI Agent

AI action execution and deep links / AI thực thi hành động

Support

Q&A chatbot and human handoff / Hỏi đáp và chuyển nhân viên hỗ trợ

Tracking

Public order tracking without login / Tra cứu đơn công khai không cần đăng nhập

Public order tracking by order code / Tra cứu đơn hàng công khai bằng mã đơn

Khách hàng dán mã đơn nhận được qua SMS/Zalo để xem trạng thái real-time:

  • Vị trí xe trên bản đồ
  • ETA + tài xế + SĐT
  • Timeline trạng thái
  • Ảnh ePOD sau khi giao
path Parameters
orderCode
required
string

Responses

System

Health, metrics, observability, audit logs / Health, metrics, giám sát hệ thống, nhật ký

List audit logs / Liệt kê audit log

Authorizations:
bearerAuth
query Parameters
action
string
Enum: "CREATE" "UPDATE" "DELETE" "LOGIN" "LOGOUT" "EXPORT"
resource
string
userId
string
from
string <date-time>
to
string <date-time>
page
integer
Default: 1
limit
integer <= 200
Default: 50

Responses

Audit log summary for the latest 24 hours / Tóm tắt audit log 24h gần nhất

Authorizations:
bearerAuth

Responses

Get maintenance alerts / Lấy cảnh báo bảo dưỡng

Authorizations:
bearerAuth

Responses