VTEX · Schema

SaveMultipleReviewsRequest

Request body.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	Review ID.
productId	string	Product ID.
rating	number	Customer rating.
title	string	Review's title.
text	string	Review's text.
reviewerName	string	Reviewer name.
approved	boolean	Defines if the review was approved (`true`) or not (`false`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SaveMultipleReviewsRequest",
  "title": "SaveMultipleReviewsRequest",
  "required": [
    "productId",
    "rating",
    "title",
    "text",
    "reviewerName",
    "approved"
  ],
  "type": "object",
  "description": "Request body.",
  "properties": {
    "id": {
      "description": "Review ID.",
      "type": "string",
      "example": "1"
    },
    "productId": {
      "description": "Product ID.",
      "type": "string",
      "example": "65444"
    },
    "rating": {
      "description": "Customer rating.",
      "type": "number",
      "example": 4
    },
    "title": {
      "description": "Review's title.",
      "type": "string",
      "example": "Great product"
    },
    "text": {
      "description": "Review's text.",
      "type": "string",
      "example": "Great product!"
    },
    "reviewerName": {
      "description": "Reviewer name.",
      "type": "string",
      "example": "Arturo"
    },
    "approved": {
      "description": "Defines if the review was approved (`true`) or not (`false`).",
      "type": "boolean",
      "example": true
    }
  }
}