Truy vấn đơn nhập - xuất từ vận hành
GET/v1/tms/order-requests/:shownCode
Trả về đơn nhập - xuất (chưa tiếp nhận) khi đơn chưa được tiếp nhận.
Sau khi đã tiếp nhận, API trả đơn kế hoạch (PLAN) hoặc đơn thực tế (ACTUAL)
theo query view; mặc định là ACTUAL.
Ba dạng dữ liệu dùng chung nhóm field top-level. Dữ liệu điều xe nằm trong trip
(một object hoặc null) — không còn trips[].
- OR (chưa tiếp nhận) /
view=PLAN→trip: null - ACTUAL 0 trip →
null; 1 trip → trip đó - ACTUAL ≥2 trips → Nhập lấy
display_order=2, Xuất lấydisplay_order=1
Ý nghĩa địa điểm trên tuyến (route):
pickup_place: Nơi lấy container — xuất khẩu là depot lấy cont rỗng; nhập khẩu là cảng nhập.warehouse: Kho đầu tiên (tương thích); khi có nhiều kho xem thêmwarehouses[].warehouses[]: Toàn bộ kho trên tuyến theo thứ tự (RoutesPickupPoints).expected_warehouses[]: Kho dự kiến (snapshot meta) — chỉcode/name; omit khi rỗng (OR) hoặc có thể[](PLAN/ACTUAL tùy serialize).dropoff_place: Nơi hạ container — xuất khẩu là cảng hạ hàng; nhập khẩu là depot trả cont rỗng.
Response route trả code/name cho tuyến và các điểm — không trả address.
Hub điều xe nằm trong route.hub (code/name) — không còn hub_name top-level.
Chi phí (expenses[]): lấy từ phí trên chuyến chính (cùng quy tắc chọn trip),
chỉ bản ghi published và đã duyệt (is_approved). Mọi loại phí; key trùng vẫn trả nhiều dòng.
Ví dụ tích hợp GOM thường dùng: vehicle_waiting_cost_customer,
vehicle_waiting_cost_driver, other_ops_advance.
trip.statuses[]: mỗi mốc có report_name, reported_at; bổ sung location
(PICKUP_PLACE | HUB | WAREHOUSE | DROPOFF_PLACE) và action
(ARRIVE | WAITING | DEPART) khi có dữ liệu báo cáo.
Khác biệt serialize:
- Đơn nhập - xuất chưa tiếp nhận: bỏ qua (omit) các field rỗng/
undefined— không luôn trả đủ key; mảng rỗng thường không xuất hiện. - Đơn kế hoạch / đơn thực tế: giữ key và gán
nullhoặc[]khi thiếu dữ liệu.
Response area và merchandise_types[] chỉ gồm code/name — không trả
description (kể cả khi master có mô tả).
Xem thêm example Tích hợp GOM (gomTichHop) — subset field theo contract tích hợp;
schema vẫn mô tả đầy đủ envelope TMS.
Request
Responses
- 200
- 400
- 404
HTTP 200: thành công (body status 200) hoặc lỗi xác thực trong body (status 401).
Path hoặc query không hợp lệ
Không tìm thấy đơn nhập - xuất theo số lệnh hoặc theo loại yêu cầu (PLAN/ACTUAL)