canonical: https://jentic.com/apis/vtex.local/reviews-and-ratings-api

# Vtex Reviews and Ratings API

[Reviews & Ratings](https://developers.vtex.com/vtex-developer-docs/docs/vtex-reviews-and-ratings) is a VTEX IO app that allows shoppers to submit reviews and ratings for products, and view them while navigating the store. With the Reviews and Ratings API you can manage the reviews and ratings associated with the products in your store. Index Rating - `GET` [Get product rating](https://developers. The API exposes 8 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get product rating, get product review by review id. Covers 8 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Get product rating
- Update a review
- Delete review
- Create multiple reviews
- Monitor Reviews and Ratings API operational status and events

## Use cases

### E-Commerce Operations

Use the Reviews and Ratings API to perform e commerce operations programmatically. The API provides 8 endpoints covering core functionality including get product rating, get product review by review id, update a review.

Example prompt: Call GET `/reviews-and-ratings/api/rating/{productId}` to get product rating

### Automated Rating Management

Automate rating operations by combining multiple Reviews and Ratings API endpoints. Agents can get product review by review id and then update a review in a single workflow.

Example prompt: Call GET `/reviews-and-ratings/api/review/{reviewId}` to get product review by review id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Reviews and Ratings API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get product rating', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/reviews-and-ratings/api/rating/{productId}` | Get product rating |
| GET | `/reviews-and-ratings/api/review/{reviewId}` | Get product review by review ID |
| PATCH | `/reviews-and-ratings/api/review/{reviewId}` | Update a review |
| DELETE | `/reviews-and-ratings/api/review/{reviewId}` | Delete review |
| POST | `/reviews-and-ratings/api/reviews` | Create multiple reviews |
| GET | `/reviews-and-ratings/api/reviews` | Get list of reviews |
| DELETE | `/reviews-and-ratings/api/reviews` | Delete multiple reviews |
| POST | `/reviews-and-ratings/api/review` | Create a review |

## Key resources

- **Rating** — Operations related to Rating
- **Review** — Operations related to Review

## Why Jentic

- **Setup:** Wiring the VTEX Reviews and Ratings API by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and resolving the {accountName}.myvtex.com host on every call. Through Jentic you install once, import the Reviews and Ratings API from the API Directory, store the App Key and App Token once, and your agent calls it.
- **Permission scoping:** The Reviews and Ratings API puts the review id and product id in the URL path (`/reviews-and-ratings/api/review/{reviewId}` and `/rating/{productId}`), so a rule can pin your agent to one review or one product's rating. You choose the operations it may call, so destructive ones like deleting a review are not included unless you add them.
- **Credential handling:** Your VTEX App Key and App Token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a product rating' or 'submit a product review', and Jentic returns the matching Reviews and Ratings API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Reviews and Ratings API use?

The Reviews and Ratings API uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get product rating with the Reviews and Ratings API?

Yes. Use the GET `/reviews-and-ratings/api/rating/{productId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Reviews and Ratings API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get product rating through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get product rating'. Jentic returns the matching Reviews and Ratings API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Reviews and Ratings API have?

The Reviews and Ratings API exposes 8 endpoints covering rating, review operations.

### Can I limit what my agent is allowed to do with the Reviews and Ratings API?

Yes. Because you run Jentic One yourself, your own rules decide which of the API's operations the agent can call, so you can grant read-only access to GET `/reviews-and-ratings/api/rating/{productId}` and GET `/reviews-and-ratings/api/review/{reviewId}` while withholding destructive calls like DELETE `/reviews-and-ratings/api/review/{reviewId}` unless you explicitly add them. Since the review ID and product ID sit in the URL path, you can pin the agent to a single review or a single product's rating. Your VTEX App Key and App Token are held encrypted by your own instance and injected only for the operations you allow.