List Reviews - Salla Docs

This endpoint allows you to list product review, 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.

Scopes

reviews.read- Reviews Read Only

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

keyword

string

optional

The content of feedback

Example:

Nice shoes

type

enum<string>

optional

The type of feedback

Allowed values:

ratingaskshippingtestimonial

Example:

product

start_date

string

optional

Start date filter in 'YYYY-MM-DD' format.

Example:

2020-01-02

end_date

string

optional

End date filter in 'YYYY-MM-DD' format.

Example:

2024-10-02

products

array[string]

optional

List of product IDs to filter feedbacks.

Example:

["2345231543"]

blogs

array[string]

optional

List of blog IDs to filter feedbacks.

Example:

["2345231543"]

customers

array[string]

optional

List of customer IDs to filter feedbacks.

Example:

[2345231543]

boolean

optional

Indicates if a feedbacks that have reply.

Example:

true

stars

array[string]

optional

Star rating filter (e.g.)

Example:

["2"]

publish

boolean

optional

Indicates if a feedbacks published or not.

Example:

true

page

integer

optional

The Pagination page number

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

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

array[object (Reviews) {8}]

optional

number

required

A unique identifier associated with a specific review. List of reviews can be found here.

type

enum<string>

required

The type of the review.

Allowed values:

ratingaskshippingtestimonial

rating

number

required

Review rating value.

content

string

required

Review content.

order_id

number | null

required

Review order unique identifier. List of orders can be found here

is_published

boolean

required

Whether or not the review is published publicly.

created_at

string

required

String representation of the review original creation date and time.

customer

object

required

pagination

object (Pagination)

optional

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.

count

number

required

Number of returned results.

total

number

required

Number of all results.

perPage

number

required

Number of results per page.

<= 65

currentPage

number

required

Number of current page.

totalPages

number

required

Number of total pages.

links

object

required

Array of linkes to next and previous pages.

Example

{
    "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": []
    }
}