List Reviews
GET {{baseUrl}}/reviews?page=<integer>&is_published=<boolean>
This 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.
:::
reviews.read- Reviews Read Only
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The Pagination page number | |
is_published | string | Indicates whether the review is published publicly and seen on the Merchant store front |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":[{"id":"\u003cnumber\u003e","type":"shipping","rating":"\u003cnumber\u003e","content":"\u003cstring\u003e","order_id":"\u003cnumber\u003e","is_published":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","customer":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","mobile":"\u003cnumber\u003e","email":"\u003cstring\u003e","avatar":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e"}},{"id":"\u003cnumber\u003e","type":"shipping","rating":"\u003cnumber\u003e","content":"\u003cstring\u003e","order_id":"\u003cnumber\u003e","is_published":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","customer":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","mobile":"\u003cnumber\u003e","email":"\u003cstring\u003e","avatar":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e"}}],"pagination":{"count":"\u003cnumber\u003e","total":"\u003cnumber\u003e","perPage":"\u003cnumber\u003e","currentPage":"\u003cnumber\u003e","totalPages":"\u003cnumber\u003e","links":{"next":"\u003cstring\u003e","previous":"\u003cstring\u003e"}}}