Version: v3

Fetch Product Reviews

GET /products/reviews

API to fetch the Product Reviews

Request

Version stringrequired

API Version

Available optionsv3

altId stringrequired

Location Id or Agency Id

altType stringrequired

Available optionslocation

limit number

The maximum number of items to be included in a single page of results

Default value:0

offset number

The starting index of the page, indicating the position from which the results should be retrieved.

Default value:0

sortField string

The field upon which the sort should be applied

Available optionscreatedAtrating

sortOrder string

The order of sort which should be applied for the sortField

Available optionsascdesc

rating number

Key to filter the ratings

startDate string

The start date for filtering reviews

endDate string

The end date for filtering reviews

productId string

Comma-separated list of product IDs

storeId string

Comma-separated list of store IDs

application/json

Successful response

Schema

dataarray[]required

Array of Collections

totalnumberrequired

The total count of the collections present, which is useful to calculate the pagination

{
  "data": [
    null
  ],
  "total": 0
}