Skip to content

Product review update

Request

Updates the product review. This endpoint is available only when the 'Rating' module is active.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
reviewIdintegerrequired

review ID

Example:1
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X PATCH \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/reviews/products/1 \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "description": "Snack was very good",
      "fullName": "John Doe",
      "authorized": false,
      "visible": false,
      "reaction": {
        "reactionFullName": "John Doe",
        "reactionEmail": "johndoe@email.tld",
        "reactionText": "Thank you for your review!"
      }
    }
  }'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "guid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "date": "2018-05-29T09:02:27+0200",
    "orderCode": "2011000002",
    "rating": 5,
    "productName": "Snack",
    "productGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
    "description": "Snack was very good",
    "fullName": "John Doe",
    "email": "johndoe@email.tld",
    "ipAddress": "213.46.237.24",
    "customerGuid": "443cad54-73bc-11e8-8216-002590dad85e",
    "authorized": true,
    "visible": false,
    "reaction": { … },
    "updated": "2018-05-29T09:02:27+0200"
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}