Skip to content

Reviews settings

Request

Returns the reviews settings configured in the administration Rating Settings page, covering both product reviews and store rating. This endpoint is available only when the 'Rating' module is active. The endpoint is read-only.

Security
shoptetAccessToken or shoptetPrivateApiToken
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/reviews/settings \
  -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": {
    "showDiscussion": true,
    "authorizationType": "required",
    "onlyRegisteredUsers": false,
    "commentAndFullNameRequired": false,
    "sendConfirmationEmail": false,
    "showVerificationInfo": false,
    "reviewsPerPage": 20,
    "storeRatingEnabled": true,
    "storeRatingCommentsRequired": false,
    "storeRatingShowVerificationInfo": false,
    "verificationIconAllowed": false
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}