Skip to main content
ReviewsVersion: v3

Fetch Product Reviews

GET/products/reviews

API to fetch the Product Reviews

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:products.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
limitnumber

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

Default:0
Example:20
offsetnumber

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

Default:0
Example:0
sortFieldstring

The field upon which the sort should be applied

Available optionscreatedAtrating
Example:rating
sortOrderstring

The order of sort which should be applied for the sortField

Available optionsascdesc
Example:desc
ratingnumber

Key to filter the ratings

Example:4
startDatestring

The start date for filtering reviews

Example:2023-01-01T00:00:00Z
endDatestring

The end date for filtering reviews

Example:2023-12-31T23:59:59Z
productIdstring

Comma-separated list of product IDs

Example:60d21b4667d0d8992e610c88,60d21b4667d0d8992e610c89,60d21b4667d0d8992e610c8a
storeIdstring

Comma-separated list of store IDs

Example:60d21b4667d0d8992e610c85,60d21b4667d0d8992e610c86,60d21b4667d0d8992e610c87

Response

Successful response

dataarray[]required

Array of Collections

totalnumberrequired

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