VTEX · Schema

SaveReviewRequest

Request body.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
productId string Product ID.
rating integer Customer rating.
title string Review's title.
text string Review's text.
reviewerName string Reviewer name.
approved boolean Indicates if the review was approved (`true`) or not (`false`).
View JSON Schema on GitHub

JSON Schema

vtex-savereviewrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SaveReviewRequest",
  "title": "SaveReviewRequest",
  "required": [
    "productId",
    "rating",
    "title",
    "text",
    "reviewerName",
    "approved"
  ],
  "type": "object",
  "description": "Request body.",
  "properties": {
    "productId": {
      "description": "Product ID.",
      "type": "string",
      "example": "65444"
    },
    "rating": {
      "description": "Customer rating.",
      "type": "integer",
      "format": "int32",
      "example": 5
    },
    "title": {
      "description": "Review's title.",
      "type": "string",
      "example": "Good Product"
    },
    "text": {
      "description": "Review's text.",
      "type": "string",
      "example": "It is the best product that I have seen"
    },
    "reviewerName": {
      "description": "Reviewer name.",
      "type": "string",
      "example": "Arturo"
    },
    "approved": {
      "description": "Indicates if the review was approved (`true`) or not (`false`).",
      "type": "boolean",
      "example": true
    }
  }
}