Product Reviews

@nakamotosbutt/medusa-product-reviews-enhanced

An enhanced plugin that adds comprehensive product review and moderation capabilities to your Medusa application, with advanced filtering, pagination, and admin UI integration.

Enhanced version with improved admin UI, filtering capabilities, and better integration with Medusa v2.

Features

See a demo in our Medusa Starter

• Product reviews with ratings (1-5 stars)
• Review statistics and analytics
• Review moderation workflow (Copy to clipboardapproved/Copy to clipboardpending/Copy to clipboardflagged)
• Admin response management
• SDK for Store and Admin operations
• Enhanced Admin UI with:
  • Advanced filtering (product, status, rating, date range, search)
  • Pagination with customizable page size
  • Direct page navigation
  • Bulk operations support
  • Dark theme integration with Medusa UI
• Improved API with:
  • Full-text search across reviews
  • Date range filtering
  • Rating-based filtering
  • Product-specific filtering

Prerequisites

• Medusa >=2.5.0 backend
• PostgreSQL

Installation and Configuration

1. Install the plugin:

1234
yarn add @lambdacurry/medusa-product-reviews

# or, if you're using yarn workspaces
yarn workspace my-app add @lambdacurry/medusa-product-reviews

1. Add to Copy to clipboardmedusa-config.ts:

12345678910
module.exports = defineConfig({
  plugins: [
    {
      resolve: '@lambdacurry/medusa-product-reviews',
      options: {
        defaultReviewStatus: 'pending', // OPTIONAL, default is 'approved'
      },
    },
  ],
});

1. Run migrations:

1
yarn medusa db:migrate

Using the Plugin SDK

The plugin provides a built-in SDK for both store and admin operations using Medusa's native HTTP client.

Store Operations

1234567891011121314151617
// List product reviews
const { reviews, count } = await sdk.store.productReviews.list(
  query: StoreListProductReviewsQuery,
  headers?: ClientHeaders
);

// Create/Update a review
const review = await sdk.store.productReviews.upsert(
  data: StoreUpsertProductReviewsDTO,
  headers?: ClientHeaders
);

// Get review statistics
const stats = await sdk.store.productReviews.listStats(
  query: StoreListProductReviewStatsQuery,
  headers?: ClientHeaders
);

Admin Operations

1234567891011121314151617181920
// List reviews
const { reviews, count } = await sdk.admin.productReviews.list(
  query: AdminListProductReviewsQuery
);

// Update review status
const review = await sdk.admin.productReviews.updateStatus(
  productReviewId: string,
  status: 'pending' | 'approved' | 'flagged'
);

// Manage review responses
const review = await sdk.admin.productReviews.createResponse(
  productReviewId: string,
  data: AdminCreateProductReviewResponseDTO
);

await sdk.admin.productReviews.updateResponse(
  productReviewId: string,
  data: AdminUpdateProductReviewResponseDTO

Review Workflow

1. Creation: Reviews are set to:
   • Copy to clipboardapproved status by default
   • Copy to clipboardpending status if Copy to clipboarddefaultReviewStatus: 'pending' is set in plugin options
2. Moderation: Admins can:
   • List and filter reviews
   • Update review status (approve/flag)
   • Manage responses (create/update/delete)

Available Endpoints

Admin Endpoints

• Copy to clipboardGET /admin/product-reviews - List all reviews
• Copy to clipboardPOST /admin/product-reviews/:id/response - Add a response
• Copy to clipboardPUT /admin/product-reviews/:id/response - Update response
• Copy to clipboardDELETE /admin/product-reviews/:id/response - Delete response
• Copy to clipboardPUT /admin/product-reviews/:id/status - Update status

Store Endpoints

• Copy to clipboardGET /store/product-reviews - List reviews
• Copy to clipboardPOST /store/product-reviews - Create/Update review
• Copy to clipboardGET /store/product-review-stats - Get statistics

Local Development

IMPORTANT: A running PostgreSQL instance is required. The plugin expects Copy to clipboardDB_USERNAME and Copy to clipboardDB_PASSWORD environment variables to be set. If not provided, both default to "postgres".

Available scripts:

1234567891011
# Build the plugin
yarn build

# Development mode with hot-reload
yarn dev

# Publish to local registry for testing
yarn dev:publish

# Generate database migrations
yarn db:generate

Installing the plugin in your Medusa project for local development

After publishing the plugin locally by running yarn dev:publish, go to the root of your Medusa project and run the following commands:

123456
cd path/to/your/medusa-application

yarn medusa plugin:add @lambdacurry/medusa-product-reviews

# If you are yarn with a monorepo, you may also need to run
yarn install

Compatibility

This plugin is compatible with versions Copy to clipboard>= 2.5.0 of Copy to clipboard@medusajs/medusa.

License

MIT License