VTEX · Example Payload

Vtex Savereview Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Savereview Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "SaveReview",
  "method": "POST",
  "path": "/reviews-and-ratings/api/review",
  "summary": "VTex Create a review",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "productId": "65444",
        "rating": 5,
        "title": "Good Product",
        "text": "It is the best product that I have seen",
        "reviewerName": "Arturo",
        "approved": true
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "5323fdaa-c012-11ec-835d-0ebee58edbb3",
        "productId": "65444",
        "rating": 5,
        "title": "Good Product",
        "text": "It is the best product that I have seen",
        "reviewerName": "Arturo",
        "shopperId": "user@email.com",
        "reviewDateTime": "04/19/2022 18:55:58",
        "searchDate": "2022-04-19T18:55:58Z",
        "verifiedPurchaser": false,
        "sku": "2",
        "approved": false,
        "location": null,
        "locale": "en-US",
        "pastReviews": null
      }
    }
  ]
}