VTEX · Example Payload

Vtex Getproductrating Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getproductrating 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": "GetProductRating",
  "method": "GET",
  "path": "/reviews-and-ratings/api/rating/{productId}",
  "summary": "VTex Get product rating",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "average": 3.86,
        "totalCount": 7
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "example": {
        "code": "NotFound",
        "message": "apiexamples.myvtex.com not found",
        "source": "Vtex.Kube.Router.WebApi",
        "requestId": "b49522afa7c94b76885450f652be7bfc"
      }
    }
  ]
}