Skip to content
You are reading the pinned copy of v1.0, which is also the latest release. Read the latest.

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.
  • 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, uuid, optional).
As seen on Open Source Alternatives The Merchant Engine badge