VTEX · Example Payload

Vtex Getreviewbyreviewid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getreviewbyreviewid 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": "GetReviewbyReviewId",
  "method": "GET",
  "path": "/reviews-and-ratings/api/review/{reviewId}",
  "summary": "VTex Get product review by review ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "5323fdaa-c012-11ec-835d-0ebee58edbb3",
        "productId": "1",
        "rating": 5,
        "title": "Great product",
        "text": "Great product.",
        "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
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "code": "NotFound",
        "message": "apiexamples.myvtex.com.br not found",
        "source": "Vtex.Kube.Router.WebApi",
        "requestId": "b49522afa7c94b76885450f652be7bfc"
      }
    }
  ]
}