Chuyển tới nội dung chính

Giới thiệu

Tài liệu này hướng dẫn khách hàng tích hợp API với Hệ thống quản lý vận tải (TMS) — nhận thông tin đơn nhập - xuất từ bộ phận vận hành và tra cứu các danh mục master.

Base URL​

Mọi request gửi tới:

https://api.autotms.vn

Ví dụ endpoint nhận đơn nhập - xuất:

POST https://api.autotms.vn/v1/tms/order-requests

Quy ước dữ liệu​

  • Định dạng: JSON, tên trường dùng snake_case.
  • Batch: Một request có thể gửi từ 1 đến 200 đơn trong một mảng JSON.
  • Xử lý từng phần tử: Mỗi đơn trong mảng được xử lý độc lập; kết quả trả về có thể vừa có đơn thành công vừa có đơn lỗi.
  • Tổ chức: Tổ chức vận hành được xác định từ token đăng nhập — không cần gửi org_id trong body.

Danh mục tự động​

Nếu mã khách hàng, mã địa điểm, loại container, loại hàng, loại chi phí, vật tư đóng gói... chưa có trong hệ thống, API sẽ tự tạo danh mục tương ứng rồi gắn vào đơn. Tra cứu theo code, name hoặc key tùy từng loại danh mục.

Tài khoản người dùng​

Trường username và participants[].username phải đã tồn tại trong hệ thống — API không tự tạo tài khoản. Nếu tài khoản không tồn tại, request sẽ báo lỗi.

Cấu trúc tài liệu​

Trong mục Hệ thống quản lý vận tải:

  1. Xác thực — header và cookie bắt buộc.
  2. Nhận thông tin đơn nhập - xuất từ vận hành — POST /v1/tms/order-requests.
  3. Lấy thông tin đơn nhập - xuất từ vận hành — GET /v1/tms/order-requests/{shownCode}.
  4. Cập nhật thông tin đơn nhập - xuất từ vận hành — PUT /v1/tms/order-requests/{shownCode}.
  5. Danh mục Khách hàng — GET /v1/tms/customers.
  6. Danh mục Xe — GET /v1/tms/vehicles.
  7. Danh mục Kho — GET /v1/tms/warehouses.
  8. Danh mục Tài xế — GET /v1/tms/drivers.
  9. Danh mục Lý do hủy — GET /v1/tms/reason-catalogs.
  10. Danh mục Nhà thầu phụ — GET /v1/tms/subcontractors.
  11. Danh mục Rơ-moóc — GET /v1/tms/trailers.
  12. Danh mục Tuyến đường — GET /v1/tms/routes.
  13. Danh mục Điều phối viên — GET /v1/tms/dispatchers.

Mục Hệ thống quản lý đơn hàng dành cho API OMS — sẽ bổ sung sau.