ReviewĐánh giá đơn hàng
Danh sách đánh giá đơn hàng
Lấy danh sách đánh giá đơn hàng của khách hàng đang đăng nhập
Endpoint
GET /site/orderreviews
Headers
| Key | Value | Bắt buộc | Mô tả |
|---|---|---|---|
SiteTenantId | {tenant_id} | Có | ID của công ty/tenant. |
SiteAuthorization | {jwt_token} | Có | Token định danh khách hàng. |
Workflow & Logic
API này lấy danh sách các đánh giá đơn hàng của khách hàng đang đăng nhập, phục vụ việc hiển thị lịch sử đánh giá.
Quy trình xử lý (Internal Processing)
-
Khởi tạo & Xác thực (Initialization & Authentication):
- Khởi tạo site context từ header
SiteTenantId. - Xác thực khách hàng từ JWT token trong header
SiteAuthorization. - Chỉ lấy các đánh giá có
visible = 1(hiển thị công khai) và thuộc về khách hàng đang đăng nhập.
- Khởi tạo site context từ header
-
Lọc dữ liệu (Filtering):
- Lọc theo đơn hàng: Nếu có
sale_order_id, chỉ lấy đánh giá của đơn hàng đó. - Lọc theo danh sách đơn hàng: Nếu có
sale_order_id_list, chỉ lấy đánh giá của các đơn hàng trong danh sách.
- Lọc theo đơn hàng: Nếu có
-
Sắp xếp & Phân trang (Sorting & Pagination):
- Sắp xếp theo trường được chỉ định (
sort_by), mặc định theoidgiảm dần (DESC). - Phân trang với
pagevàlimit, mặc địnhpage = 1vàlimit = 50(tối đa 50).
- Sắp xếp theo trường được chỉ định (
-
Đếm tổng số bản ghi (Counting):
- Đếm tổng số bản ghi phù hợp với điều kiện lọc (không áp dụng limit).
-
Làm giàu dữ liệu (Data Enrichment):
- Lấy danh sách
OrderReviewtheo điều kiện lọc, sắp xếp và phân trang. - Với mỗi review, xóa các trường nhạy cảm (
internal_note,moderator_id). - Mỗi review luôn có trường
order; nếuenrich_sale_order = 1,orderchứa thông tin đơn hàng đầy đủ, ngược lại là Order Object rỗng (giá trị mặc định).
- Lấy danh sách
-
Format & Trả về (Formatting & Response):
- Tổng hợp vào cấu trúc response với
total,currentpage,limit, vàitems[].
- Tổng hợp vào cấu trúc response với
Parameters
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
sale_order_id | integer | Lọc theo ID đơn hàng. | |
sale_order_id_list | string | Lọc theo danh sách ID đơn hàng, phân tách bằng dấu phẩy (tối đa 20 ID). | |
enrich_sale_order | integer | Bổ sung thông tin đơn hàng (1: Có, 0: Không, mặc định: 0). | |
page | integer | Trang hiện tại (Mặc định: 1). | |
limit | integer | Số lượng bản ghi mỗi trang (Mặc định và tối đa: 50). | |
sort_by | string | Trường sắp xếp (id, date_created, date_modified, date_moderated). Mặc định: id. | |
sort_type | string | Hướng sắp xếp (ASC, DESC). Mặc định: DESC. |
Response Schema
HTTP 200 - JSON Object
{
"total": 10,
"currentpage": 1,
"limit": 50,
"items": [
{
"id": 1,
"sale_order_id": 100,
"rating_delivery": 5,
"rating_packaging": 4,
"rating_service": 5,
"comment": "Giao hàng nhanh, đóng gói cẩn thận",
"status": 3,
"date_created": 1600000000
// ... Xem thêm Order Review Object Schema
}
]
}Xem Order Review Object Schema
HTTP 401 - Unauthorized
Nếu thiếu token, token không hợp lệ hoặc đã hết hạn (error_customer_login_required), hoặc token không thuộc shop của SiteTenantId (error_customer_company_mismatch).