v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-188265.3 KB
Review

Create a review

Creates a single review.

Permissions

This endpoint does not require permissions. For authentication, you must generate and use only your VtexidClientAutCookie to work with this endpoint. Refer to the Generating user tokens guide for more information.

post/reviews-and-ratings/api/review

Headers

Content-Typestring required

Describes the type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

productIdstring required

Product ID.

ratinginteger required

Customer rating.

titlestring required

Review's title.

textstring required

Review's text.

reviewerNamestring required

Reviewer name.

approvedboolean required

Indicates if the review was approved (true) or not (false).

Example request

{
  "productId": "65444",
  "rating": 5,
  "title": "Good Product",
  "text": "It is the best product that I have seen",
  "reviewerName": "Arturo",
  "approved": true
}

Response

OK

idstring

Review ID.

productIdstring

Product ID.

ratingnumber

Customer rating.

titlestring

Review's title.

textstring

Review's text.

reviewerNamestring

Reviewer name.

shopperIdstring

Shopper email.

reviewDateTimestring

Review's date and time.

searchDatestring

Review's search date.

verifiedPurchaserboolean

Indicates if the reviewer is a verified purchaser (true) or not (false).

skustring nullable

SKU ID.

approvedboolean

Indicates if the review was approved (true) or not (false).

locationstring nullable

Review's origin location.

localestring nullable

Review's locale.

pastReviewsstring nullable

Past reviews of the same product.