Rating System

• 5-Star Rating: Customers can rate products from 1 to 5 stars
• Text Reviews: Optional detailed feedback and comments (up to 500 characters)
• Verified Purchase Badges: Highlight reviews from customers who actually purchased the product
• Variant Support: Rate specific product variants separately
• Edit & Delete: Users can manage their own reviews

Review Management

• AJAX Submission: Smooth review submission without page reload
• Advanced Filtering: Filter reviews by rating level (1-5 stars) or verified purchases
• Multiple Sorting: Sort by date (newest/oldest) or rating (highest/lowest)
• Pagination: Browse through reviews with dynamic AJAX pagination
• Anti-Spam Protection: Rate limiting to prevent abuse (20 requests per minute)

Statistics & Display

• Average Rating: Automatic calculation of product rating average
• Rating Distribution: Visual breakdown of ratings (1-5 stars)
• Review Count: Total number of reviews per product
• Latest Feedback: Display most recent customer feedback
• Rating Summary: Comprehensive statistics on product page

Security & Permissions

• User-Specific: Users can only edit/delete their own reviews
• Record-Level Security: Proper access control for all operations
• Public Read Access: Anyone can view ratings and reviews
• Portal Integration: Authenticated users can submit reviews

Technical Features

• Responsive Design: Mobile-optimized interface
• Multi-Language Support: Fully translatable (English/Spanish included)
• AJAX Operations: Dynamic loading and updates
• Automatic Statistics: Real-time rating calculation
• Integration: Seamless integration with product templates

Prerequisites

• Odoo 17.0 or later
• website_sale module installed
• Database backup recommended

Installation Steps

1. Download the Module

   Download the module package to your Odoo addons directory.

2. Update Apps List

   Go to Apps → Update Apps List

3. Install Module

   Search for "E-Commerce Product Ratings" and click Install

4. Verify Installation

   Check that the rating widget appears on product pages

For Customers

Submitting a Review:

1. Navigate to a product page
2. Log in to your account (required)
3. Scroll to the "Customer Reviews" section
4. Click on stars to select your rating (1-5)
5. Optionally add text feedback
6. Click "Submit Review"

For Products with Variants:

1. Select the specific variant you want to review
2. Rate and submit as above
3. You can review multiple variants of the same product

Managing Your Reviews:

• Click "Edit" to modify your review
• Click "Delete" to remove your review
• Only your own reviews show edit/delete buttons

For Administrators

Viewing All Ratings:

1. Go to Website → Catalog → Product Ratings
2. View all customer reviews
3. Filter and sort as needed

Product Statistics:

1. Open any product in backend
2. Go to "Ratings" tab
3. View rating count, average, and all reviews

Rating Submission

Endpoint: /shop/product/rate

Method: POST

Authentication: Required (logged-in users only)

Parameters:

• product_id (int, required): Product template ID
• rating (int, required): Rating value (1-5)
• feedback (string, optional): Review text (max 500 chars)
• variant_id (int, optional): Specific variant ID

Response:

{
  "status": "success",
  "message": "Thank you for your feedback!",
  "data": {
    "rating_avg": 4.5,
    "rating_count": 10,
    "rating_id": 123
  }
}

Review Loading (AJAX)

Endpoint: /shop/reviews/load

Method: JSON-RPC

Authentication: Public

Parameters:

• product_id (int, required): Product ID
• page (int, optional): Page number (default: 1)
• per_page (int, optional): Reviews per page (default: 5)
• sort_by (string, optional): Sort method
• filter_by (string, optional): Filter method

Response:

{
  "success": true,
  "data": {
    "reviews": [...],
    "pagination": {
      "current_page": 1,
      "total_pages": 5,
      "total_reviews": 25
    }
  }
}

Review Deletion

Endpoint: /shop/product/rating/delete

Method: POST

Authentication: Required (user must own the review)

Parameters:

• rating_id (int, required): Rating ID to delete

Response:

{
  "status": "success",
  "message": "Review deleted successfully!",
  "data": {
    "product_id": 123,
    "rating_avg": 4.3,
    "rating_count": 9
  }
}

Review Editing

Endpoint: /shop/product/rating/edit

Method: POST

Authentication: Required (user must own the review)

Parameters:

• rating_id (int, required): Rating ID to edit
• rating (int, optional): New rating value
• feedback (string, optional): New feedback text

Response:

{
  "status": "success",
  "message": "Review updated successfully!",
  "data": {
    "rating_id": 456,
    "updated_rating": 5,
    "updated_feedback": "Great product!"
  }
}

ecommerce_product_ratings.product_rating

Fields:

• product_template_id (Many2one): Product being rated
• product_variant_id (Many2one): Specific variant (optional)
• user_id (Many2one): User who submitted the rating
• rating (Integer): Rating value (1-5)
• feedback (Text): Review text
• verified_purchase (Boolean): Whether user purchased the product
• create_date (Datetime): When the review was submitted
• variant_display_name (Char): Computed variant name

Constraints:

• Unique constraint: One review per user per product/variant combination

product.template (Extended)

New Fields:

• rating_ids (One2many): All ratings for this product
• rating_count (Integer): Total number of ratings
• rating_avg (Float): Average rating value
• rating_last_feedback (Text): Most recent review text
• rating_last_value (Float): Most recent rating value

Common Issues

Reviews Not Appearing:

• Ensure user is logged in
• Check that product is published
• Verify module is installed correctly

Cannot Submit Review:

• User must be logged in
• User cannot review same product/variant twice
• Check rate limiting (20 requests/minute)

Statistics Not Updating:

• Statistics update automatically on review create/edit/delete
• Try refreshing the product page
• Check server logs for errors

Version 1.0.0

• Initial release
• 5-star rating system
• Text reviews with 500 character limit
• Verified purchase badges
• Variant-specific ratings
• Edit and delete functionality
• Advanced filtering and sorting
• AJAX pagination
• Anti-spam protection
• Multi-language support (EN/ES)
• Responsive design
• Complete API documentation