VTEX · Example Payload

Vtex Getalistofreviews Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getalistofreviews 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": "GetalistofReviews",
  "method": "GET",
  "path": "/reviews-and-ratings/api/reviews",
  "summary": "VTex Get list of reviews",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "data": [
          {
            "id": "1",
            "productId": "880035",
            "rating": 3,
            "title": "anon",
            "text": "anon",
            "reviewerName": "anon",
            "shopperId": "anon@email.com",
            "reviewDateTime": "06/02/2021 20:58:43",
            "searchDate": "2021-06-02T20:58:43Z",
            "verifiedPurchaser": false,
            "sku": null,
            "approved": true,
            "location": "",
            "locale": null,
            "pastReviews": null
          },
          {
            "id": "2",
            "productId": "880035",
            "rating": 5,
            "title": "logged in",
            "text": "it's cool",
            "reviewerName": "Brian",
            "shopperId": "brian@email.com.br",
            "reviewDateTime": "06/02/2021 21:00:00",
            "searchDate": "2021-06-02T21:00:00Z",
            "verifiedPurchaser": false,
            "sku": null,
            "approved": true,
            "location": "",
            "locale": null,
            "pastReviews": null
          },
          {
            "id": "c66d8bc0-787c-11ec-82ac-028dd4526e77",
            "productId": "880035",
            "rating": 3,
            "title": "Korean",
            "text": "ko-KR",
            "reviewerName": "ko-KR",
            "shopperId": "user@email.com",
            "reviewDateTime": "01/18/2022 16:36:33",
            "searchDate": "2022-01-18T16:36:33Z",
            "verifiedPurchaser": false,
            "sku": null,
            "approved": true,
            "location": null,
            "locale": "ko-KR",
            "pastReviews": null
          }
        ],
        "range": {
          "total": 26,
          "from": 0,
          "to": 3
        }
      }
    }
  ]
}