medusa-plugin-complaints
v0.2.0
Published
Complaint logger plugin for Medusa v2
Maintainers
Readme
medusa-plugin-complaints
Complaint management plugin for Medusa v2. Track, tag, and manage customer complaints with activity logging and product-level statistics.
If you are not familiar with Medusa, you can learn more on the project web site.
Features
- Full complaint CRUD with open/closed status workflow
- Tagging system for categorizing complaints
- Activity tracking
- Widgets on Order, Customer, and Product detail pages
- Product-level complaint rate statistics with scheduled recalculation
Background
Some regulated industries require companies to formally log complaints. This plugin allows you to do that within your Medusa admin dashboard. Complaints can be initiated from order pages with customer and order prefilled. Complaint activity (closing complaints, adding notes) is recorded by Medusa user id. Optionally allows creating tags and assigning tags to complaints to facilitate data analysis. Complaint statistics by product are generated daily via a scheduled job.
Installation
Inside your medusa backend root folder:
yarn add medusa-plugin-complaintsReplace "yarn add" with the correct command for your package manager if you are using (for example) npm, pnpm, or bun.
Configuration
Enable in your medusa-config.ts file. Example:
module.exports = defineConfig({
//... other config
plugins: [
{
resolve: 'medusa-plugin-complaints',
options: {}
}
// ... other plugins
]
})To ensure complaints cannot be queried in GET requests to the storefront API, add 'complaint' to your restricted fields in medusa-config.ts.
module.exports = defineConfig({
projectConfig: {
// ... other settings
http: {
// ... other settings
restrictedFields: {
store: ['complaint']
}
}
}
})Usage
- Create and manage complaints from the Complaints section in the Medusa admin sidebar.
- Define complaint tags in Settings > Complaint Tags.
- Widgets on Order, Customer, and Product pages show related complaints at a glance.
- Product complaint statistics are recalculated daily via a scheduled job.
