Payload Plugin

A starter plugin for Medusa providing foundational plugin structure and utilities

Overview

The @m-nasser-m/payload-plugin is a starter template for creating Medusa plugins. It provides a foundational structure and utilities to help developers kickstart their custom plugin development for Medusa v2.

System Requirements

Before installing the plugin, ensure your system meets the following requirements:

• Node.js: v22 or later
• Medusa server: v2.x

Installation

Install the plugin using your preferred package manager:

# Using npm
npm install @m-nasser-m/payload-plugin

Core Dependencies

This plugin includes the following core dependencies:

• axios (^1.8.0) - HTTP client for API requests
• qs (^6.14.0) - Query string parsing and serialization

Configuration

Add the plugin to your medusa-config.js file:

module.exports = {
  plugins: [
    {
      resolve: `@m-nasser-m/payload-plugin`,
      options: {
        // Add your configuration options here
      },
    },
  ],
}

Use Cases

This starter plugin is ideal for:

• Learning Plugin Development - Understanding the structure and patterns of Medusa plugins
• Rapid Prototyping - Quickly scaffolding new plugin projects
• Custom Integrations - Building custom functionality for your Medusa store