This page provides the events and associated payloads for the Ratings and Reviews microservice.
Page Contents
Events
SL.# | Name | Description | Publish Location | Routing Key | Durability | Payload Type |
---|---|---|---|---|---|---|
1 | Review Moderation | This event is triggered to moderate the newly submitted rating and review. | Topic: ecomm | reviews.moderation | TRUE | Notification |
2 | Review Aggregation | This event is triggered to update the rating summary when there is a new moderated rating and review. | Topic: ecomm | reviews.aggregation | TRUE | Catalog |
Payload Models
Below is the payloads for the Ratings and Reviews microservice events:
Notification
Property | Type | Description | Example |
---|---|---|---|
collectionId | long | Indicates the ID of the collection. | 123 |
ratingId | long | Indicates the ID of the rating and review. | 340 |
userId | String | Indicates the ID of the customer. | USER_A10 |
itemid | String | Indicates the ID of the item. | MOBILE_BRAND_23 |
itemname | String | Indicates the name of the item. | Mobile Phone |
itemdescription | String | Indicates the description of the item. | Supports 2G/3G/4G network, frontend and backend cameras, and 8GB RAM. |
properties | Map | Specifies a list of properties of the rating and review. | {"ratingcolor":red} |
review | String | Denotes the review contents given by the user. | Very excellent product with all the features for less cost. |
reviewTitle | String | Denotes the review title given by the user. | Excellent Product |
locale | String | Indicates the locale of the rating and review. | en_US |
imageUrls | List | Indicates a list of comma-separated image URLs. | https://www.skava.com/wp-content/uploads/2019/02/Product_Banner_v4.6.jpg |
status | RatingStatus | Specifies the status of the rating. The value can be:
| PENDING |
storeId | String | Refers to the ID of the store. | WEST_STORE |
businessId | long | Indicates the ID of the business. | 100 |
Catalog
Property | Type | Description | Example |
---|---|---|---|
collectionId | long | Indicates the ID of the collection. | COL45 |
itemid | String | Indicates the ID of the item. | PRODUCT124 |
ratingdistribution | Map | Indicates the rating distribution of the item. | {"1":10,"2":20} |
ratingfinal | Double | Specifies the average rating of the item. | 4.5 |
ratingsCount | int | Specifies the total number of reviews submitted by the customers on a specific item. | 198 |
Revision History
2020-03-03 | AN – Created the page for April 2020 release.