Biểu phí vận chuyển (Shipping Profile)
Quản lý biểu phí vận chuyển của shop theo khu vực giao hàng
Shipping Profile là một biểu phí vận chuyển do shop tự định nghĩa, áp dụng cho một tập khu vực giao hàng. Mỗi profile có nhiều mức phí (rate). Phí ship cho đơn được tính bằng Tính phí vận chuyển.
Shipping Profile Object
| Trường (Field) | Kiểu (Type) | Mô tả (Description) |
|---|---|---|
id | int | ID profile |
company_id | int | ID công ty |
creator_id | int | ID người tạo |
name | string | Tên (duy nhất trong công ty) |
description | string | Mô tả |
region_mode | int | Phạm vi áp dụng: 1 (Mọi khu vực), 3 (Chỉ các khu vực trong danh sách), 5 (Mọi khu vực trừ danh sách) |
region_id_list | string | Danh sách khu vực (xem định dạng bên dưới) |
surcharge | array | Cấu hình phụ phí |
is_default | int | Profile mặc định (0/1) |
priority | float | Độ ưu tiên |
status | int | 1 (Bật), 3 (Tắt) |
date_created | int | Thời gian tạo (Unix timestamp) |
date_modified | int | Thời gian sửa đổi (Unix timestamp) |
Định dạng region_id_list: các nhóm cách nhau bởi dấu phẩy; mỗi nhóm là region_id hoặc region_id:sub_region_id:sub_region_id... để giới hạn trong một số quận/huyện của tỉnh đó. Ví dụ 1,2:3:4,5 = tỉnh 1, tỉnh 5 (toàn bộ) và tỉnh 2 (chỉ quận 3 và 4).
Danh sách
GET /v1/shippingprofiles
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
page | int | Không | Số trang (Mặc định: 1) |
limit | int | Không | Số bản ghi mỗi trang (Mặc định và tối đa: 50) |
name | string | Không | Lọc theo tên |
status | int | Không | Lọc theo trạng thái |
region_mode | int | Không | Lọc theo phạm vi áp dụng |
sort_by | string | Không | Mặc định: id |
sort_type | string | Không | Mặc định: DESC |
Response: { total, currentpage, limit, items: [Shipping Profile Object] }.
GET /v1/shippingprofiles/fulldata trả mảng toàn bộ profile đang bật (không phân trang).
Chi tiết
GET /v1/shippingprofiles/:id — trả một Shipping Profile Object.
Tạo mới / Cập nhật
POST /v1/shippingprofiles (HTTP 201) và PUT /v1/shippingprofiles/:id (HTTP 200)
Quyền:
setting.sale
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | int | Có | ID công ty |
creator_id | int | Có | ID người tạo/sửa |
name | string | Có | Tên (khi tạo: không trùng tên profile khác của công ty) |
region_mode | int | Có | 1, 3 hoặc 5 |
status | int | Có | 1 (Bật), 3 (Tắt) |
region_id_list | string | Không | Danh sách khu vực (bắt buộc về nghiệp vụ khi region_mode là 3/5) |
description | string | Không | Mô tả |
surcharge | array | Không | Phụ phí |
is_default | int | Không | 0/1 |
priority | float | Không | Độ ưu tiên |
Xóa
DELETE /v1/shippingprofiles/:id (HTTP 204)
Quyền:
setting.sale
Error Codes
| Mã lỗi | Mô tả |
|---|---|
error_name_required | Thiếu tên (HTTP 422) |
error_name_exists | Tên đã tồn tại (HTTP 422) |
error_region_mode_required | Thiếu region_mode (HTTP 422) |
error_region_mode_invalid | region_mode không hợp lệ (HTTP 422) |
error_status_invalid | status không hợp lệ (HTTP 422) |
error_surcharge_invalid_format | surcharge phải là mảng (HTTP 422) |
error_not_found | Profile không tồn tại hoặc không thuộc công ty của bạn (HTTP 404) |
error_role_not_available | Không có quyền setting.sale (HTTP 403) |