Skip to content

List of products reviews

Request

Returns list of product's reviews.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
dateFromstring

Filter reviews with creation date after date

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

Filter reviews with creation date before date

Example:dateTo=2019-09-05T00:00:00%2B0000
changeTimeFromstring

Filter reviews changed after this date (included)

Example:changeTimeFrom=2019-09-05T00:00:00%2B0000
productGuidstring

Product identifier to filter reviews by.

Example:productGuid=91670fd3-5b3d-11e7-819d-002590dc5efc
orderCodestring

Order identifier to filter reviews by.

Example:orderCode=2011000002
itemsPerPageinteger

Returned items per page. Default and max value is 20.

Example:itemsPerPage=15
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/products?dateFrom=2019-09-05T00%3A00%3A00%252B0000&dateTo=2019-09-05T00%3A00%3A00%252B0000&changeTimeFrom=2019-09-05T00%3A00%3A00%252B0000&productGuid=91670fd3-5b3d-11e7-819d-002590dc5efc&orderCode=2011000002&itemsPerPage=15&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"
  }
}