Reviews (admin API)
Admin routes of the reviews module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.
GET /v1/admin/reviews
Section titled “GET /v1/admin/reviews”List reviews (admin)
Parameters:
pagein query (number, min 1, optional).pageSizein query (number, min 1, max 100, optional).productIdin query (string, optional).ratingin query (number, min 1, max 5, optional).userIdin query (string, optional).
Responses:
200: Reviews retrieved.401: Unauthorized.403: Insufficient permissions.
DELETE /v1/admin/reviews/{id}
Section titled “DELETE /v1/admin/reviews/{id}”Delete review (admin)
Parameters:
idin path (string, required).
Responses:
204: Review deleted.401: Unauthorized.403: Insufficient permissions.404: Review not found.
PATCH /v1/admin/reviews/{id}
Section titled “PATCH /v1/admin/reviews/{id}”Update review (admin)
Parameters:
idin path (string, required).
Request body: AdminUpdateReviewDto.
Responses:
200: Review updated.400: Invalid input.401: Unauthorized.403: Insufficient permissions.404: Review not found.
PATCH /v1/admin/reviews/{id}/approve
Section titled “PATCH /v1/admin/reviews/{id}/approve”Approve review
Parameters:
idin path (string, required).
Responses:
200: Review approved.401: Unauthorized.403: Insufficient permissions.404: Review not found.
PATCH /v1/admin/reviews/{id}/reject
Section titled “PATCH /v1/admin/reviews/{id}/reject”Reject review
Parameters:
idin path (string, required).
Request body: ModerateReviewDto.
Responses:
200: Review rejected.400: Invalid input.401: Unauthorized.403: Insufficient permissions.404: Review not found.
Schemas
Section titled “Schemas”AdminUpdateReviewDto
Section titled “AdminUpdateReviewDto”rating(number, min 1, max 5, optional).title(string, max length 200, optional).body(string, max length 5000, optional).assetIds(array of string, optional).status(object, optional).reason(string, max length 1000, optional).
ModerateReviewDto
Section titled “ModerateReviewDto”reason(string, max length 1000, optional).