Skip to content
You are reading the unreleased documentation. No version is released yet, and these pages describe code that is not in a release.

Reviews (storefront API)

Storefront and customer routes of the reviews module. Send Accept-Language (or X-Locale from a browser) on every call; a customer route needs the session cookie.

Delete review

Parameters:

  • id in path (string, required).

Responses:

  • 204: Review deleted.
  • 401: Unauthorized.
  • 404: Review not found.

Update review

Parameters:

  • id in path (string, required).

Request body: UpdateReviewDto.

Responses:

  • 200: Review updated.
  • 400: Invalid input.
  • 401: Unauthorized.
  • 404: Review not found.

Mark review as helpful

Parameters:

  • id in path (string, required).

Responses:

  • 200: Marked helpful.
  • 201: no description.
  • 401: Unauthorized.
  • 404: Review not found.
  • rating (number, min 1, max 5, optional).
  • title (string, max length 200, optional).
  • body (string, max length 5000, optional).
  • assetIds (array of string, optional).