VTvtex
Review

Get product review by review ID

Changed on

Retrieves information of a product review based on the review's ID.

Permissions

This endpoint does not require permissions.

get/reviews-and-ratings/api/review/{reviewId}

Request

  • Base URL
    https://storecomponents.myvtex.com
  • URL
    https://storecomponents.myvtex.com/reviews-and-ratings/api/review/{reviewId}
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Path parameters

reviewIdstring required
Example:1

Review ID.

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.

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.

Changes