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.

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 Params

KeyDatatypeRequiredDescription
pagestringThe Pagination page number
is_publishedstringIndicates whether the review is published publicly and seen on the Merchant store front

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;status&quot;:&quot;\u003cnumber\u003e&quot;,&quot;success&quot;:&quot;\u003cboolean\u003e&quot;,&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;type&quot;:&quot;shipping&quot;,&quot;rating&quot;:&quot;\u003cnumber\u003e&quot;,&quot;content&quot;:&quot;\u003cstring\u003e&quot;,&quot;order_id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;is_published&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;customer&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobile&quot;:&quot;\u003cnumber\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatar&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;type&quot;:&quot;rating&quot;,&quot;rating&quot;:&quot;\u003cnumber\u003e&quot;,&quot;content&quot;:&quot;\u003cstring\u003e&quot;,&quot;order_id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;is_published&quot;:&quot;\u003cboolean\u003e&quot;,&quot;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;customer&quot;:{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;mobile&quot;:&quot;\u003cnumber\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatar&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;}}],&quot;pagination&quot;:{&quot;count&quot;:&quot;\u003cnumber\u003e&quot;,&quot;total&quot;:&quot;\u003cnumber\u003e&quot;,&quot;perPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currentPage&quot;:&quot;\u003cnumber\u003e&quot;,&quot;totalPages&quot;:&quot;\u003cnumber\u003e&quot;,&quot;links&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}}