VTEX

Reviews and Ratings API

Reviews & Ratings is a [VTEX IO native solution](https://developers.vtex.com/vtex-developer-docs/docs/vtex-reviews-and-ratings) that allows shoppers to submit…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Reviews & Ratings is a VTEX IO native solution that allows shoppers to submit reviews and ratings for products, as well as see them while navigating the store.

Rating

Review

Endpoints 8

Rating

  • GETGet Product Rating/rating/:productIdRetrieves the rating of a specific product.

Review

  • POSTCreate a Review/reviewCreates a single review
  • GETGet Review by Review ID/review/:reviewIdRetrieves information of a product review by its ID.
  • DELETEDelete Review/review/:reviewIdDeletes an existing review.
  • PATCHUpdate a Review/review/:reviewIdUpdates the information of a review.
  • GETGet a list of Reviews/reviews?search_term=search_term&from=0&to=3&order_by=:asc&status=true&product_id=1Retrieves a list of reviews.
  • POSTCreate Multiple Reviews/reviewsCreates multiple reviews.
  • DELETEDelete Multiple Reviews/reviewsDeletes multiple reviews at once.

API details

Base URL
https://vtex.local
https://{accountName}.myvtex.com/reviews-and-ratings/api
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
8 operations on 4 pathsGET 3POST 2DELETE 2PATCH 1
Main resources
Review 7Rating 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Reviews and Ratings API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Reviews and Ratings API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Product Rating” (GET /rating/:productId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Reviews and Ratings API?

Reviews & Ratings is a [VTEX IO native solution](https://developers.vtex.com/vtex-developer-docs/docs/vtex-reviews-and-ratings) that allows shoppers to submit… It is listed under Other and has 8 endpoints.

Who publishes the Reviews and Ratings API?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Reviews and Ratings API?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.myvtex.com/reviews-and-ratings/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Reviews and Ratings API?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Reviews and Ratings API have?

8 operations on 4 paths (3 GET, 2 POST, 2 DELETE, 1 PATCH). The largest groups are Review, Rating.

Is forking the Reviews and Ratings API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.