Coupon Add-on

About Add-on

The SpurtCommerce Coupon Add-on enables store administrators to create and manage discount coupons for promotional campaigns. This plugin provides a flexible way to attract customers with discounts and special offers, enhancing engagement and encouraging more frequent purchases.

Features:

Customizable Coupons: Create percentage or fixed-amount discounts, tailoring promotions to suit your store’s needs.
Coupon Expiration & Usage Limits: Set expiration dates and limit the number of times a coupon can be redeemed to control the promotion's duration and exclusivity.
Customer-Specific Coupons: Target specific customer groups by assigning coupons for loyal or new customers.
Detailed Coupon Tracking: Monitor coupon performance with analytics on redemption rates and sales impact.

Frontend Setup - Seller Panel:

Follow these steps to set up the front end for the Coupons addon in Spurtcommerce Seller Panel.

Step 1: Install the Addon:

Locate the Spurtcommerce addon package, typically named seller.addOns.zip.

Extract the zip file and copy the Coupons folder into the addOns folder in your project.

projectFolder -> addOns

After this step, the structure should look like:

projectFolder -> addOns ->marketing -> Coupons

Once completed, proceed to update the configuration.

Step 2: Update the Configuration

After installing the addon, update the add-ons.constant.ts file to include the necessary plugins:

// ----------------------Coupons--------------------------
import * as Coupons from './marketing/coupon/coupon.constant'
// components paths
export const CouponsComponents = Coupons.componentLists;
// route paths
export const CouponsRoutes = Coupons.routePath;

If you wish to uninstall or remove the Coupons addon, replace the component paths and route paths with an empty array.

// ----------------------Coupons--------------------------
import * as Coupons from './marketing/coupon/coupon.constant'
// components paths
export const CouponsComponents = [];
// route paths
export const CouponsRoutes =[];

Step 3: Run the Application:

To run the application with the integrated Coupons addon, use the following command:

$ npm run large-serve

After executing this command, the addon will be available on Spurtcommerce on the designated page.

Step 4: Build the Application

Finally, to prepare the application for deployment, run the build command:

$ npm run large-build

The latest build files will then be ready to deploy to the server.

Frontend Setup – Admin Panel:

Follow these steps to set up the front end for the Coupon addon in Spurtcommerce Admin Panel.

Step 1: Install the Addon:

Locate the Spurtcommerce addon package, typically named admin.addOns.zip.

Extract the zip file and copy the Coupon folder into the addOns folder in your project.

projectFolder -> addOns

After this step, the structure should look like:

projectFolder -> addOns ->Marketing->Coupon

Once completed, proceed to update the configuration.

Step 2: Update the Configuration

After installing the addon, update the add-ons.constant.ts file to include the necessary plugins:

// ---------------------Coupon Routes---------------------
import * as coupon from './Marketing/coupon/coupon-constant';

// components paths
export const couponComponents = coupon.componentLists;
// route paths
export const couponRoutes = coupon.routePath;

If you wish to uninstall or remove the Coupon addon, replace the component paths and route paths with an empty array.

// ---------------------Coupon Routes---------------------
import * as coupon from './Marketing/coupon/coupon-constant';

// components paths
export const couponComponents = [];
// route paths
export const couponRoutes = [];

Step 3: Run the Application:

To run the application with the integrated Coupon addon, use the following command:

$ npm run large-serve

After executing this command, the addon will be available on Spurtcommerce on the designated page.

Step 4: Build the Application

Finally, to prepare the application for deployment, run the build command:

$ npm run large-build

The latest build files will then be ready to deploy to the server.

Store Setup

Follow these steps to set up the Coupon module on the front-end Next.js web store.

Setup Overview:

Install the extension
Update configuration
Integrate the module
Run the application
Build the application

Step 1: Install the Extension

Locate the Spurtcommerce addon package, typically named addOns.zip.

Extract the zip file and copy the Coupon folder into the addOns folder in your project.

projectFolder -> addOns

After this step, the structure should look like:

projectFolder -> addOns -> Coupon

Once completed, proceed to update the configuration.

Step 2: Update the Configuration

After installing the extension, update the configuration in Spurtcommerce’s addonsconfig.js as follows:

Import the required line into addonsconfig.js.

             import CouponApply from './Coupon/CouponApply'

Add the CouponApply plugin to the specified object.

        export const AddonsComponent = {                                                                                                                                   CouponApply,

Step 3: Run the Application

Once you have integrated the Coupon module, run the application using:

$ npm run dev

This command will launch Spurtcommerce with the integrated Coupon module visible on the specified page.

Step 4: Build the Application

To prepare the application for deployment, execute the following command:

$ npm run build

$ yarn run build

The latest build files will then be ready for server deployment.

Coupon Add-On

Follow these below steps are installing Coupon addon

App setup

These are the steps that need to be followed to do the front end store setup.

· Installing an extension

· Update the configuration

· Module Detail

· Run the Application

· Make the build

Step 1 : Installing an extension

These are the steps that need to be executed for installation of the extension.

Locate the Spurtcommerce addon package, typically named addons.zip.

Extract the zip file and copy the Coupon folder into the addons folder in your project.

projectFolder->lib->module->add-ons

After this step, the structure should look like:

projectFolder->lib->module->add-ons->Coupon

Once completed, proceed to update the configuration.

Step 2 : Update the configuration

After extracting the add on zip file for changing the configurations in addons.dart, you have to follow the steps below:

Go to

projectFolder->lib->module->add-ons->addonsshared.dart

Then inside addonsShared array paste the following content

{"Coupon": SpurtApplycoupon(), "data": ""},

After placing the above files it will look like this,

List addonsShared = [

{"Coupon": SpurtApplycoupon(), "data": ""},

];

Then give the following imports

import 'package:spurtcommerce/module/add-ons/Coupons/Pages/coupons.dart';

There will be a popup for quick fix

Step 3 : Module details

After executing the above mentioned steps, we have to place these below lines in the module folder to show the Coupons to the user.

Coupons

Once you finished updating the configuration then in the projectFolder->lib->module->Tab->My-cart->pages->checkout.dart

Use this line for view the coupons

findMyClass("Coupon", "")

After insert the line restart your application

Step 4 : Run the application

After integrating the Coupons Module into Spurt Commerce, you can use the following commands to run the application in terminal.

$ flutter run

In Run menu select run without debugging

In case if throws any exception

$ flutter run –no-sound-null-safety

Once you execute the above command you can view the installed module in Spurt Commerce, within the page in which you have integrated

Step 5 : Make the build

In order to build, you need to run the following commands. In order to check the application, run the following commands and build the application.

$flutter build

If you want to split the abi then

$flutter build –split-per-abi

For bundle build

$flutter build appbundle

PreviousPromotion Widget NextQuotation Request Add-on

Last updated 1 month ago