Light Mode

List Reviews

GET/reviews

Last modified: 2 months ago

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

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Query Params

page

integer

optional

The Pagination page number

is_published

boolean

optional

Indicates whether the review is published publicly and seen on the Merchant store front

Request samples

Responses

Success(200)

Unauthorized(401)

HTTP Code: 200

Content Type : JSONapplication/json

status

number

optional

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.

success

boolean

optional

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.

data

$ref(#/definitions/1389362)[]

optional

#/definitions/1389362

optional

pagination

#/definitions/1307303

optional

{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1989531006,
      "type": "ask",
      "rating": 0,
      "content": "does it work on MAC machines?",
      "order_id": 673212345,
      "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": []
  }
}

Last modified: 2 months ago