ProductReviewsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createProductReview | POST /products/{product_id}/reviews | Submit a review for a product from a completed order. Customers can rate and review products they have ordered with ratings from 1-5 stars. Requires valid order reference to ensure only actual customers can review products. |
| getProductReviewSummary | GET /products/{product_id}/review-summary | Get comprehensive review summary for a product. Returns average rating, total review count, rating breakdown by stars, and recent reviews. Useful for displaying product quality overview without loading all individual reviews. |
| getProductReviews | GET /products/{product_id}/reviews | Retrieve paginated list of reviews for a product. Returns customer reviews with ratings, text, and reviewer information. Supports pagination to efficiently browse through all product reviews. |
createProductReview
CreateReviewResponse createProductReview(product_id, ProductReviewInput)
Submit a review for a product from a completed order. Customers can rate and review products they have ordered with ratings from 1-5 stars. Requires valid order reference to ensure only actual customers can review products.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| product_id | Long | The unique identifier of the product being reviewed | [default to null] |
| ProductReviewInput | ProductReviewInput | Review details including rating, text, and order reference |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getProductReviewSummary
ProductReviewSummaryResponse getProductReviewSummary(product_id, authorization)
Get comprehensive review summary for a product. Returns average rating, total review count, rating breakdown by stars, and recent reviews. Useful for displaying product quality overview without loading all individual reviews.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| product_id | Integer | The unique identifier of the product to get review summary for | [default to null] |
| authorization | String | Optional Bearer token for authenticated users | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getProductReviews
PaginatedResponse_ProductReviewResponse getProductReviews(product_id, page, per_page)
Retrieve paginated list of reviews for a product. Returns customer reviews with ratings, text, and reviewer information. Supports pagination to efficiently browse through all product reviews.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| product_id | Long | The unique identifier of the product whose reviews to retrieve | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of reviews per page (default: 10) | [optional] [default to null] |
Return type
PaginatedResponse_ProductReviewResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8