VTvtex
Review

Get list of reviews

Changed on

Retrieves a list of reviews related to a product.

Permissions

This endpoint does not require permissions.

get/reviews-and-ratings/api/reviews

Request

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

Query parameters

search_termstring
Example:search_term

Returns Reviews that contain the search term in productId, sku, shopperId, or reviewerName.

fromstring
Example:0

Zero base starting record number, 0 is the default value.

tostring
Example:3

Zero base ending record number, 3 is the default value.

order_bystring
Example:SearchDate:asc

Field name to order records. The field name must have the first letter uppercase. Allowed field names: ProductId, ShopperId, Approved, ReviewDateTime, SearchDate, Rating, Locale. Optionally add :asc or :desc.

statusboolean
Example:true

Status of the review, approved (true) or not (false).

product_idstring
Example:1

Filter the reviews by product 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

Changes

  • 9d648339bf09Revision changes
    • info

      the query request parameter from became optional

    • info

      the query request parameter order_by became optional

    • info

      the query request parameter product_id became optional

    • info

      the query request parameter search_term became optional

    • info

      the query request parameter status became optional

    • info

      the query request parameter to became optional

  • 7a18272398d1Revision changes
    • info

      endpoint added