Get product or order evaluation list, supporting filtering and pagination by product, user, etc.
Points to note
- This interface uses the GET method
- Support filtering by product ID, user ID, order ID, etc.
- Supports custom sorting methods
- Support pagination, default 10 records per page
- Only return reviews that have been approved (status 1)
Request address
{ๅๅๅฐๅ}/api/review/list
Description:{ๅๅๅฐๅ}Replace it with your domain name, such ashttps://en.anqicms.com/api/review/list
Request Syntax
GET {ๅๅๅฐๅ}/api/review/list
Request Headers
This interface also involves common request headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Request parameters
| Field name | Type | Required | Description |
|---|---|---|---|
| id | int | No | Document ID, specify the product review to be retrieved |
| user_id | int | No | User ID, retrieve reviews for the specified user |
| order | string | No | Review sorting method, defaultid desc |
| page | int | No | Page number, default is 1 |
| limit | int | No | Number of items per page, default is 10 |
Response header
This interface only involves public response headers. For more information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field name | Type | Description |
|---|---|---|
| code | int | Error code |
| msg | string | Error description |
| data | object[] | Rating List Array |
data result item parameter
| Field name | Type | Description |
|---|---|---|
| id | int | Comment ID |
| order_id | string | Order ID |
| archive_id | int | Document ID |
| archive_sku_id | int | SKU ID |
| user_id | int | User ID |
| IP | string | User IP Address |
| Score | int | Rating (1-5 points) |
| content | string | Review Content |
| Images | string array | Rating Image List |
| user_name | string | Username |
| string | User Email | |
| created_time | int | publish timestamp |
| updated_time | int | update timestamp |
| status | int | Review status, 1 reviewed, 0 in review |
Usage Example
Request example
GET /api/review/list?archive_id=1&page=1&limit=10 HTTP/1.1
Host: www.anqicms.com
Response Example
{
"code": 0,
"msg": "่ทๅๆๅ",
"data": [
{
"id": 45,
"order_id": "20231101000001",
"archive_id": 1,
"archive_sku_id": 1,
"user_id": 123,
"ip": "192.168.1.100",
"score": 5,
"content": "ๅๅ่ดจ้ๅพๅฅฝ๏ผ้ๅธธๆปกๆ๏ผ",
"images": [
"https://en.anqicms.com/uploads/review/2023/11/image1.jpg",
"https://en.anqicms.com/uploads/review/2023/11/image2.jpg"
],
"user_name": "ๅผ ไธ",
"email": "[email protected]",
"created_time": 1698825600,
"updated_time": 1698825600,
"status": 1
},
{
"id": 44,
"order_id": "20231031000005",
"archive_id": 1,
"archive_sku_id": 2,
"user_id": 124,
"ip": "192.168.1.101",
"score": 4,
"content": "ๅๅไธ้๏ผ็ฉๆตไนๅพๅฟซใ",
"images": [],
"user_name": "ๆๅ",
"email": "[email protected]",
"created_time": 1698739200,
"updated_time": 1698739200,
"status": 1
}
]
}
error code
| Error code | Description |
|---|---|
| 0 | OK |
| -1 | Error, the reason is indicated in msg |
| 1001 | Not logged in |
| 1002 | Not authorized |
| 200 | API request OK |