Installation

Updated 11 July 2026

Watch Demo Strapi Market

Step-by-step instructions to install and configure the WebbyCommerce Plugin

1. Install the Plugin

Install the Package

npm install @webbycrown/webbycommerce

Optional: Seed Demo Ecommerce Data

If you want a ready-to-test store (products, categories, coupons, shipping, users, etc.), you can seed demo data using any of the methods below.

Demo use only: Do not use the demo users/passwords in production.

Method A: Seed from the Admin Panel

Go to Settings → WebbyCommerce → Configure and use the Seed Demo Data action (admin-only).

Method B: Seed via CLI (interactive)

From your Strapi project root, run:

npm run seed:ecommerce

When prompted, type y to confirm. (If Strapi is running, stop it first.)

Method C: Auto-seed on startup (environment variable)

Set this env var once, then start Strapi:

STRAPI_PLUGIN_ADVANCED_ECOMMERCE_SEED_DATA=true

What gets created

  • Product categories, tags, attributes & attribute values
  • Products + product variations
  • Coupons (e.g. WELCOME2026, SUMMER15, VIP30)
  • Shipping zones, methods, rates & rules
  • Demo users + addresses, wishlist/compare, cart items
  • Sample orders + payment transactions

2. Enable the Plugin

Add the plugin to your config/plugins.js file:

// config/plugins.js
module.exports = ({ env }) => ({
  webbycommerce: {
    enabled: true,
    resolve: require.resolve('@webbycrown/webbycommerce'),
  },
});

For Local Development: Use the local path instead:

resolve: './src/plugins/webbycommerce'

3. User Schema Extensions

The plugin automatically extends the user schema. Ensure your user content type includes these fields:

Required Fields
  • username (string, required, unique)
  • email (email, required)
  • phone_no (string, required, unique)
  • first_name (string, required)
  • last_name (string, required)
Optional Fields
  • display_name (string)
  • company_name (string)
OTP Fields
  • otp (integer)
  • isOtpVerified (boolean, default: false)

4. Initial Setup Steps

A. Enable Permissions

Navigate to Settings → Users & Permissions → Roles and select the Public role.

Under the WebbyCommerce section, enable the Enable permission.

B. Configure Plugin Settings

Go to Settings → WebbyCommerce in the admin panel and configure:

  • Allowed frontend domains
  • API route prefix
  • SMTP configuration
  • Authentication method
OTP Fields
  • otp (integer)
  • isOtpVerified (boolean, default: false)

5. Verify Installation

Start Strapi

npm run develop

Check that the plugin loads without errors in the console.

Test API Endpoint
Curl Command

http://localhost:1337/api/webbycommerce/health

Should return a success response.

Success! Your WebbyCommerce Plugin is now installed and ready to use. Continue to the Configuration page to set up your plugin settings.