Tài liệu cho nhà phát triểnBắt đầu
Dữ liệu đã lưu và dự án
Xe, mẫu hàng và dự án dùng chung với ứng dụng.
Xe, mẫu hàng và dự án của tổ chức bạn chính là các bản ghi mà ứng dụng CargoDuo hiển thị. Thay đổi ở đây thì bên đó cũng thay đổi theo.
| Tài nguyên | ID | Endpoint |
|---|---|---|
| Xe | Xe thiết lập sẵn: slug (standard-trailer-13-6m), xe của bạn: veh_… | /v1/vehicles (xe thiết lập sẵn chỉ đọc) |
| Mẫu hàng | tpl_… | /v1/templates |
| Dự án | prj_…; slot pv_…, kiện hàng item_… | /v1/projects |
Đọc cần resources:read; tạo, sửa và xóa cần resources:write. Các lệnh gọi này miễn phí và được tính vào giới hạn tần suất như mọi lệnh gọi khác.
Dùng trong tác vụ
{
"vehicles": [
{
"vehicle_id": "veh_118",
"quantity": 2
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40,
"weight": 14
}
]
}Các trường gửi kèm ID sẽ ghi đè giá trị đã lưu. id mặc định là ID đã lưu.
Dự án
| Bước | Lệnh gọi |
|---|---|
| 1 | POST /v1/projects với tên, xe (vehicle_id, quantity) và kiện hàng |
| 2 | POST /v1/projects/{id}/pack: báo giá và chạy như POST /v1/pack |
| 3 | Sơ đồ được lưu vào dự án và mở được trong ứng dụng (app_url) |
Nếu có người sửa dự án trong lúc tác vụ đang chạy, sơ đồ chỉ được giữ trên tác vụ (cảnh báo project_not_saved).
Thành viên
Mỗi bản ghi có created_by và updated_by. Một lệnh gọi được tính là do thành viên đã tạo khóa thực hiện. Lọc danh sách bằng ?created_by=me hoặc ID thành viên (usr_…).
Liên quan
Liệt kê xeMọi xe bạn có thể chỉ định bằng vehicle_id: các xe thiết lập sẵn (container, sơ mi rơ moóc, xe tải, pallet thuộc các loại tổ chức được phép dùng), sau đó là xe riêng của tổ chức.Liệt kê mẫu hàngCác mẫu hàng của tổ chức (kiện hàng đã lưu), mới nhất trước.Xếp hàng cho dự ánXếp xe và kiện hàng của dự án y hệt POST /v1/pack: cùng giá, cùng cơ chế tạm giữ credit, giới hạn, Idempotency-Key, ?wait= và tác vụ.