Skip to content

List of project reviews

Request

Returns a list of the project reviews. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings. The endpoint supports Paging.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
dateFromstring

Filter reviews with creation date after date.

Example:dateFrom=2019-09-05T00:00:00%2B0100
dateTostring

Filter reviews with creation date before date.

Example:dateTo=2019-09-05T00:00:00%2B0100
visibleboolean

Filter reviews by visibility.

Example:visible=true
orderCodestring

Order identifier to filter reviews by.

Example:orderCode=2011000002
itemsPerPageinteger

Returned items per page. Default value is 100. Max value is 200.

Example:itemsPerPage=100
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/reviews/project?dateFrom=2019-09-05T00%3A00%3A00%252B0100&dateTo=2019-09-05T00%3A00%3A00%252B0100&visible=true&orderCode=2011000002&itemsPerPage=100&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "reviews": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}