Sử dụng API này để lấy tất cả lượt giao hàng.
Request
- URL:
/shippingroutes - Method: GET
Query Parameter
| Key | Mô tả | Kiểu dữ liệu | Mặc định |
|---|---|---|---|
| company_id | ID công ty | Interger (Bắt buộc) | |
| page | Trang cần lấy dữ liệu (để phân trang) | Interger | 1 |
| limit | Số dữ liệu lấy mỗi trang | Integer | 50 |
| sort_by | Tiêu chí sắp xếp kết quả (xem thêm bên dưới) | String | id |
| sort_type | Thứ tự lấy kết quả | String (ASC hoặc DESC) | ASC |
| keyword | Tìm kiếm từ khóa theo mã lượt, ghi chú. | String | |
| creator_id | Tìm theo ID người tạo | Integer | 0 |
| from_warehouse_id | Tìm theo ID bưu cục xuất phát | Integer | 0 |
| shipper_id | Tìm theo User ID của shipper | Integer | 0 |
| ymd | Tìm theo ngày của lượt | Integer (YYYYMMDD) | 0 |
| status | Tìm theo trạng thái lượt | Integer | String (cách nhau dấu phẩy) | 0 |
| id | Tìm theo ID lượt giao hàng | Integer | 0 |
| not_status_list | Tìm lượt không thuộc trạng thái | Integer[] | [] |
Các tiêu chí sắp xếp ‹sort_by›
| Giá trị | Mô tả |
|---|---|
| id | ID của vận đơn (mặc định) |
| code | Mã lượt giao hàng |
| counttotal | Tổng số vận đơn |
| countdone | Tổng số vận đơn hoàn thành |
| countsuccess | Tổng số vận đơn thành công |
| countfail | Tổng số vận đơn thất bại |
| countremain | Tổng số vận đơn chưa hoàn thành |
| ymd | Ngày lượt giao |
| status | Trạng thái lượt giao hàng |
| datecreated | Ngày tạo |
| datemodified | Ngày cập nhật |
Response
Success response
Nếu request thành công, bạn nhận được response với các thông tin sau
| Đối tượng JSON trả về (Content-Type: application/json) - 200 OK | ||
|---|---|---|
| Tên | Mô tả | Kiểu dữ liệu |
| total | Tổng số lượt giao hàng tìm thấy | Integer |
| currentpage | Số trang hiện tại đang lấy kết quả | Integer |
| limit | Số dòng dữ liệu lấy trong một trang | Integer |
| items | Danh sách lượt giao hàng trả về | ShippingRoute[] |
| Cấu trúc JSON của đối tượng ‹ShippingRoute› | ||
|---|---|---|
| Tên | Mô tả | Kiểu dữ liệu |
| company_id | ID công ty | Integer |
| creator_id | ID người tạo | Integer |
| id | ID của lượt giao hàng | Integer |
| code | Mã lượt giao hàng | String |
| note | Ghi chú cho lượt (chỉ có khi tạo bằng API) | String |
| shipper_id | User ID của shipper | Integer |
| from_warehouse_id | ID của bưu cục xuất phát | Integer |
| to_warehouse_id | ID của bưu cục kết thúc (Chưa hỗ trợ tính năng này) | Integer |
| distance_geotravel_ratio | (Không sử dụng) | Float |
| count_total | Tổng số vận đơn của lượt | Integer |
| count_done | Tổng số vận đơn đã hoàn thành | Integer |
| count_remain | Tổng số vận đơn chưa hoàn thành (remain = total - done) | Integer |
| count_success | Tổng số vận đơn đã giao thành công | Integer |
| count_fail | Tổng số vận đơn đã giao thất bại | Integer |
| ymd | Mã ngày giao của lượt | Integer (YYYYMMDD) |
| status | Trạng thái lượt giao hàng (Xem danh sách bên dưới) | Integer |
| date_created | Ngày tạo lượt giao hàng | Integer Unix timestamp |
| date_modified | Ngày cập nhật thông tin lượt giao hàng | Integer Unix timestamp |
| vehicle | Thông tin phương tiện của shipper sẽ thực hiện lượt giao này | Vehicle |
Các giá trị của trạng thái vận đơn ‹status›
| Giá trị | Mô tả |
|---|---|
| 1 | NEW - Mới |
| 7 | PENDING - Chờ phản hồi |
| 9 | INPROGRESS - Đang giao hàng |
| 11 | COMPLETED - Hoàn thành |
| 13 | CANCELLED - Đã hủy |
Ví dụ một response json object:
{ "total": 1, "currentpage": 1, "limit": 50, "items": [ { "company_id": 1, "creator_id": 1, "id": 83, "code": "1308X12342", "note": "", "shipper_id": 1, "from_warehouse_id": 643, "to_warehouse_id": 0, "distance_geotravel_ratio": 1.4, "count_total": 0, "count_done": 0, "count_success": 0, "count_fail": 0, "count_remain": 0, "ymd": 20180813, "status": 1, "date_created": 1534127498, "date_modified": 0, "vehicle": { "company_id": 1, "creator_id": 1, "id": 19, "type": 7, "device_number": "1121-7542", "year": "2011", "make": "Honda", "model": "Camry", "owner_user_id": 15304, "date_created": 1532674604, "date_modified": 0, "estimate_method": 1, "estimate_speed": 0, "estimate_rest_duration": 0, "description": "", "fuel_status": 0, "status": 1 } } ] } Error response
Nếu response có lỗi thì có thể tham khảo bảng bên dưới để biết các lỗi có thể xuất hiện khi gửi request này:
| HTTP Status | Mã lỗi | Mô tả |
|---|---|---|
| 403 | error_not_permission | Không có quyền truy cập |