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. readonlyAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Query Parameters
altIdstringrequired
Location Id or Agency Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
Available options
locationlimitnumber
The maximum number of items to be included in a single page of results
Default:
0Example:
20offsetnumber
The starting index of the page, indicating the position from which the results should be retrieved.
Default:
0Example:
0sortFieldstring
The field upon which the sort should be applied
Available options
createdAtratingExample:
ratingsortOrderstring
The order of sort which should be applied for the sortField
Available options
ascdescExample:
descratingnumber
Key to filter the ratings
Example:
4startDatestring
The start date for filtering reviews
Example:
2023-01-01T00:00:00ZendDatestring
The end date for filtering reviews
Example:
2023-12-31T23:59:59ZproductIdstring
Comma-separated list of product IDs
Example:
60d21b4667d0d8992e610c88,60d21b4667d0d8992e610c89,60d21b4667d0d8992e610c8astoreIdstring
Comma-separated list of store IDs
Example:
60d21b4667d0d8992e610c85,60d21b4667d0d8992e610c86,60d21b4667d0d8992e610c87Response
Successful response
dataarray[]required
Array of Collections
totalnumberrequired
The total count of the collections present, which is useful to calculate the pagination