List Reviews
GET
/reviewsThis endpoint allows you to list product reviews, general product, and shipping ratings as well as Merchant store reviews.
:::info[Review Types]
- Product reviews are of type
rating
. - General product questions are of type
ask
. - Ratings about shipping are of type
shipping
. - Merchant store reviews are of type
testimonial
.
:::
Request
The Pagination page number
Indicates whether the review is published publicly and seen on the Merchant store front
Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
A unique identifier associated with a specific review. List of reviews can be found here.
Review Type
Review Rating value
Review Content
Review Order ID. List of orders can be found here
Indicates whether the review is published publicly and seen on the Merchant store front
String representation of the review original creation date and time
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"status": 200,
"success": true,
"data": [
{
"id": 1989531006,
"type": "ask",
"rating": 0,
"content": "does it work on MAC machines?",
"order_id": null,
"is_published": false,
"created_at": "2023-09-28 17:17:53",
"customer": {
"id": 1227534533,
"name": "Ahmed Ali",
"mobile": 566666666,
"email": "[email protected]",
"avatar": "https://cdn.assets.salla.network/admin/cp/assets/images/avatar_male.png",
"country": "السعودية",
"city": "الخبر"
}
},
{
"id": 1853140150,
"type": "rating",
"rating": 5,
"content": "I like this product",
"order_id": 123456789,
"is_published": true,
"created_at": "2023-09-28 17:20:24",
"customer": {
"id": 1227534533,
"name": "Mohammed Ali",
"mobile": 565555555,
"email": "[email protected]",
"avatar": "https://cdn.assets.salla.network/admin/cp/assets/images/avatar_male.png",
"country": "السعودية",
"city": "الرياض"
}
}
],
"pagination": {
"count": 2,
"total": 2,
"perPage": 15,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}