A Medusa plugin that adds product review functionality to your Medusa store. This plugin allows customers to leave reviews for products, helping other customers make informed purchasing decisions.
## Features
- Product review management
- Review submission and moderation
- Integration with Medusa admin dashboard
- Customizable review settings
- Review workflow management
- Review response system
- Review statistics and analytics
- Image attachments for reviews
- Rating system (1-5 stars)
- Review status management (pending, approved, flagged)
## Technical Overview
### Data Models
The plugin implements three main data models:
1. **Product Review**
- Basic review information (name, email, rating, content)
- Product and order associations
- Image attachments
- Review status (pending/approved/flagged)
- Order line item reference
2. **Product Review Response**
- Store owner responses to reviews
- Response content and metadata
3. **Product Review Stats**
- Aggregated statistics for products
- Review counts
- Average ratings
- Rating distribution (1-5 stars)
### Core Functionality
- **Review Management**
- Create, update, and delete reviews
- Moderate review status
- Attach images to reviews
- Respond to customer reviews
- **Statistics and Analytics**
- Automatic calculation of product review statistics
- Rating distribution tracking
- Average rating computation
- Review count tracking
- **Configuration Options**
- Default review status (pending/approved/flagged)
- Customizable review workflow
- Integration with Medusa's admin interface
### Database Features
- Optimized indexes for product and order lookups
- Efficient statistics calculation using SQL aggregation
- Support for review search functionality
- Relationship management between reviews and products
## Prerequisites
- Node.js >= 20
- Medusa v2.4.0 or higher
- PostgreSQL database
## Installation
1. Install the plugin:
```bash
npm install @devx-commerce/product-reviews
# or
yarn add @devx-commerce/product-reviews
```
2. Add the plugin to your `medusa-config.js`:
```javascript
const plugins = [
// ... other plugins
{
resolve: "@devx-commerce/product-reviews",
options: {
defaultReviewStatus: "approved", // or "pending" or "flagged"
},
},
];
```
## API Endpoints
### Admin API
#### Product Reviews
- `GET /admin/product-reviews` - List all product reviews
- Query parameters:
- `fields`: Fields to include in response
- `filters`: Filter criteria
- `limit`: Number of items per page
- `offset`: Page offset
#### Product Review Stats
- `GET /admin/product-review-stats` - List all product review statistics
- Query parameters:
- `fields`: Fields to include in response
- `filters`: Filter criteria
- `limit`: Number of items per page
- `offset`: Page offset
### Store API
#### Product Reviews
- `GET /store/product-reviews` - List all product reviews
- Query parameters:
- `fields`: Fields to include in response
- `filters`: Filter criteria
- `limit`: Number of items per page
- `offset`: Page offset
- `POST /store/product-reviews` - Create or update product reviews
- Request body:
```typescript
{
reviews: Array<{
id?: string;
name?: string;
email?: string;
rating: number;
content?: string;
order_line_item_id?: string;
product_id?: string;
order_id?: string;
images?: string[];
}>;
}
```
#### Product Review Stats
- `GET /store/product-review-stats` - List all product review statistics
- Query parameters:
- `fields`: Fields to include in response
- `filters`: Filter criteria
- `limit`: Number of items per page
- `offset`: Page offset
### Response Format
All list endpoints return data in the following format:
```typescript
{
data: T[], // Array of items
count: number, // Total count of items
offset: number, // Current page offset
limit: number // Items per page
}
```
## License
MIT
