VTvtex
Review

Create multiple reviews

Changed on

Creates multiple reviews for more than one product in a single operation.

Permissions

This endpoint does not require permissions. For authentication, you must generate and use only the API key and the Application Token to work with this endpoint. Refer to the API authentication using application keys and Generating internal application keys guide for more information.

post/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

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

idstring

Review ID.

productIdstring required

Product ID.

ratingnumber required

Customer rating.

titlestring required

Review's title.

textstring required

Review's text.

reviewerNamestring required

Reviewer name.

approvedboolean required

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

Example request

[
  {
    "id": "1",
    "productId": "65444",
    "rating": 4,
    "title": "Great product",
    "text": "Great product!",
    "reviewerName": "Arturo",
    "approved": true
  }
]

Response

OK

string[] required

List of review IDs.

Changes