Review Data Types
On this page, you will find the definitions of the objects used for managing product feedback and reviews. webround.com distinguishes between the full object returned by the system (ReviewItem) and the minimum data required for submission or modification (ReviewSubmitData).
ReviewItem
Represents a complete review within the system, including user and product metadata.
| Property | Type | Description |
|---|---|---|
| id | string (UUID) | Unique identifier for the review. |
| storeId | string (UUID) | ID of the store it belongs to. |
| productId | string (UUID) | ID of the associated root product. |
| variantId | string (UUID) | ID of the specific variant being reviewed. |
| customerId | string (UUID) | ID of the user who wrote the review. |
| customerName | string | User's display name. |
| rating | number | Score assigned (e.g., from 1 to 5). |
| title | string | Brief title of the review. |
| comment | string | Full feedback text. |
| verifiedPurchase | boolean | Flag indicating if the purchase was verified by the system. |
| productVariantName | string | Name of the variant at the time of the review. |
| coverUrl | string | null |
| createdAt | Date | string |
| updatedAt | Date | string |
ReviewSubmitData
This object represents the payload required by the createReview and updateReview methods to submit or update feedback.
| Property | Type | Description |
|---|---|---|
| rating | number | Numerical rating (required). |
| title | string | Feedback title. |
| comment | string | Descriptive text of the review. |
Rating Validation
Ensure that the rating value sent via ReviewSubmitData is consistent with the backend configuration: an integer from 1 to 5.