Skip to content

List of all project reviews

Request

Using this endpoint, you can get list of all project reviews in the same format as the List of project reviews endpoint returns them. This endpoint is available only when the 'Rating' module is active. Also, the project must have store ratings enabled in the administration settings.

Response will be in jsonlines format with each project review taking one line of output file.

One project review in response has the same format as one item of the List of project reviews response. See Project review snapshot schema for more details.

Result file is compressed using GZIP.

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

Responses

Accepted

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