ViserMart Documentation

Introduction

Welcome to the ViserMart - E-commerce Shopping Platform, your one-stop solution for launching and managing your online shopping business. Designed for entrepreneurs, our platform offers a user-friendly interface, powerful features, and complete customization to help you start selling quickly and efficiently.

Features Overview
Admin Panel Features
  • Dashboard: A dashboard designed to track sales, orders, payments, and other essential metrics.
  • Customer/User Management: View, manage, and communicate with registered customers/user via email, phone or firebase notification.
  • Category Management: Create, edit, and delete categories to organize products.
  • Brand Management: Create, edit, and delete brands to categorize products.
  • Product Management: Product management includes adding or updating products with comprehensive details such as name, slug, description, images, attributes, categories, brands, specifications, inventory, and more.
  • Variant Product Management: Managing product variations that differ by specific attributes such as size, color, material, or style.
  • Promotional Tools: Create and manage Coupons, and Offers to attract customers and boost sales.
  • Order Management: Manage orders, including order status, payment status, and more.
  • Payment Management: Manage payment methods, payment status, and more.
  • Frontend Management: Customize the store's appearance and settings, including frontend content, banners, menus, SEO, custom CSS, and product collections.
  • Notification Method Management: Streamline communication by managing notification settings across multiple channels. Configure email settings for transactional and promotional messages, set up SMS notifications for instant updates, and manage push notification preferences to engage users effectively. This ensures timely and personalized communication, enhancing user experience and engagement.
  • Support Ticket Management: Efficiently handle customer inquiries and issues through a centralized support ticket system.
  • Multilingual Support: Enhance accessibility and user experience by enabling multilingual support. Multilingual support ensures inclusivity and helps expand reach across global markets.
Frontend Features
  • Browse products by category, brand, or search functionality.
  • A user-friendly shopping experience with advanced filtering and sorting capabilities.
  • Wishlist, compare, and add to cart options available without requiring user login.
  • Order tracking functionality to monitor the status of purchases.
  • Responsive design optimized for seamless performance across all devices.
  • Detailed product pages with comprehensive descriptions, images, and specifications.
  • Secure and easy checkout process with multiple payment options.
  • Customer reviews and ratings for informed purchasing decisions.

The documentation will help to understand the total system and we have tried to summarize the total.

If needed, we will update this script continuously and come with new features and security patches. We will try to give the best user experience to all of our clients.

Thank you for purchasing ViserMart. If you have any questions or queries that are not answered in this document, please feel free to contact us via email. We will try to respond to you as soon as possible. Thank you so much.

Server Requirements

  • PHP Version 8.3
  • MySQL Version 8.0+ or MariaDB version 10.6+
  • BCMath PHP Extension
  • Ctype PHP Extension
  • cURL PHP Extension
  • DOM PHP Extension
  • Fileinfo PHP Extension
  • GD PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PCRE PHP Extension
  • PDO PHP Extension
  • pdo_mysql PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Filter PHP Extension
  • Hash PHP Extension
  • Session PHP Extension
  • Zip PHP Extension
  • allow_url_fopen()
  • file_get_contents()
image

Server FAQ

Do I need VPS or a Dedicated server to run this system?

No, You can run this system in a shared host as well and it will run smoothly. But if you have much traffic, you may need to upgrade your server/hosting. Our codes are highly optimized to ensure the best possible performance.

Which hosting provider should I choose for this? Do you have any suggestions?

You can choose any hosting provider that provides cPanel-based hosting. cPanel is not a must, but we recommend you to have cPanel-based hosting.

I don't have cPanel, What should I do?

Nothing to worry about, Our system will work with any control panel but cPanel is easy to manage, for that we recommend cPanel-based hosting. Also, Our free Support is limited to cPanel-based hosting only.

Do you provide hosting as well?

Yes, We do. We can provide a complete solution for your hosting. We can provide budget shared hosting, premium shared hosting, VPS, Dedicated servers, and Cluster from various geolocation. Please contact us for more details.

Installation Guide

Installation is very easy with our Easy Installer. You can install yourself simply in few steps without any coding knowledge. We develop our installation system to make the installation process flawless and easy.

Installation Steps:
  1. Upload File: Upload the whole file to the server you have downloaded from download after purchase.
  2. Unzip File: Extract/Unzip the file and move all files in the Files folder to the main folder(where you want to install it). Make sure you have moved the index.php and .htaccess as well.
  3. Browse Site: Now please browse http://your-site-url/install/index.php and follow the process. Your system should be ready to use.

If you are still unable to install the system, please contact us. we offer free installation in cPanel-based hosting.

Admin Login:

    Admin login URL is: http://your-site-url/admin
  • Username : [as_you_set_on_installation]
  • Password : [as_you_set_on_installation]
image

Activation

After installing the system you need to activate it. When you visit the system, you will be able to see the activation page. Just provide this information to activate and run your system. Your provided information will send to ViserLab server to verify and we never collect any sensitive or confidential data.

  • Purchase Code: To get purchase code Click Here.

  • Envato Username: Your Envato username with which you bought system.

  • Email: Provide your email for further communication.

The purchase code(license) is for one website or domain only. Please activate the license into the correct domain(URL) to avoid any unwanted issues in the future.

image

Folder Structure

After installation, There will be two folders and two files will be in your main folder.

  • assets
  • core
  • .htaccess
  • index.php

  • On the "assets" folder, We keep all kinds of assets like CSS, JS, Images. If you want To edit or change anything over CSS or js, please have a look at this folder.

  • On the "core" folder, We keep the core of Laravel and we maintain full MVC structure on this project.

Customer/User Management

The Customer Management feature allows admins to oversee and manage all users within the E-commerce platform. Admins have access to various tools to view, edit, and manage customer accounts effectively.

How Customers Will Be Added to the System

Customers can be added to the system either by signing up through the website.

Configure Registration Module

To Singing Up / Online Registration the User Registration, module must be enabled. Enable these modules by following steps:

  • Access System Configuration:
    • Navigate to the Settings menu.
    • Select System Configuration.
  • Enable User Registration:
    • Look for the Online User Registration modules in the list of available modules.
    • Ensure the modules are enabled by toggling the switch to ON.
    • Click the Submit button to save the changes.
Singing Up / Online Registration
Any visitor to the website can become a registered customer by signing up online. The process involves the following steps:
  • Step 1: Fill Up Signup Form
    • Users need to provide their First Name, Last Name, Email Address, and Password
    • The system may enforce strong password rules if the Force Secure Password option is enabled in the System Configuration Settings.
    • Users must agree to the platform's policies by checking a checkbox if the Agree Policy option is enabled in the System Configuration Settings.
  • Step 2: Fill Up Profile Completion Form

    Users must provide additional details such as a unique username, country, mobile number, address, state, zip code, and city.

    Upon completing the profile, users will be redirected to their dashboard within the user panel.
Social Login Options

The platform supports social logins for Google, Facebook, and LinkedIn, simplifying user registration and login.

  1. Access Social Login Settings:
    • Navigate to Settings.
    • Select Social Login Settings.
  2. Configure Social Logins:
    • Click Configure to enter API credentials.
    • Click Help for setup instructions.
    • Click Enable/Disable to activate the social login option.
Managing Customers

In the Manage Customers menu, admins have access to various submenus that categorize customer accounts based on their status and verification levels. Each submenu contains a list of accounts displayed in a table view, making it easy to locate and manage specific customer.

Submenus Overview:
  • Profile Incomplete: Accounts where users have not yet completed their profile details.
  • Profile Completed: Accounts with fully completed profiles.
  • Active: Accounts that are currently active and in good standing.
  • Banned: Accounts that have been banned by an admin.
  • Email Unverified: Accounts where the email address has not been verified.
  • Mobile Unverified: Accounts where the mobile number has not been verified.
  • Email Verified: Accounts with verified email addresses.
  • Mobile Verified: Accounts with verified mobile numbers.
  • All Accounts: A comprehensive list of all accounts within the system.
  • Send Notification: Allows admins to send notifications to selected accounts.
Customer Actions

For each customer listed in these submenus, admins can perform the following actions:

  • View Details: Access comprehensive information about the customer, including payments. orders, and additional customer insights.
  • Login as Customer: Temporarily log in as the customer to troubleshoot issues or assist with customer management.
  • Login History: View the customer's login history and monitor account activity.
  • Send Notification: Send a direct notification to the customer.
  • View All Notifications: Review all notifications sent to the customer.
How to Update Customer's Information
  1. Access the Customer Details: Navigate to the View Details menu for the selected customer.
  2. Edit Information: Admins can update customer information including:
    • First Name
    • Last Name
    • Email Address
    • Mobile Number
    • City
    • State
    • Zip/Postal Code
    • Country
    • Address
    • Email Verification Status
    • Mobile Verification Status
  3. Save Changes: After editing the details, ensure to save the changes to update the user's information.
How to Ban/Unban a Customer
  1. Search for the Customer: Use the search option in the Customer List to find the customer.
  2. Ban Customer: Click the Ban Customer button to temporarily suspend the customers's account. The customer will be unable to access his Account Panel.
  3. Unban Customer: To reactivate the customer's account, click the Unban Customer button.
On This Article

Product Management

This document provides step-by-step guidance for managing products in your eCommerce application’s admin panel. It includes instructions on managing attributes, brands, categories, product types, and individual product details.

Manage Attributes

The Attribute Management feature in the admin panel allows you to create, organize, and manage product attributes that help define and categorize your products effectively. Attributes are essential for adding product variations, such as size, color, or material, and enhancing the filtering and search experience for customers on your eCommerce platform.

Add/Update Attributes
  • Navigate to the Attributes submenu in the Product Configuration menu.
  • Click Add New button to create a new attribute.
  • Provide the following details:
    • Name: The name of the attribute (e.g., Size, Color).
    • Type: Select from Text, Color, or Image.
Add/Update Attribute Values
  • Open the desired attribute values from the Attributes List by clicking on Values button.
  • Provide the following details in the form:
    • Input a name
    • For text attributes, input a value (e.g., XL, M).
    • For color attributes, choose a color using the picker.
    • For image attributes, upload an image or select from the media library.
  • To update an attribute value, click Edit next to the value.
Enable/Disable an Attribute
  • In the Attributes List, toggle the Enable/Disable button to make an attribute active or inactive.
Manage Brands

The Brand Management feature allows you to create and manage brands for your products, helping to organize and showcase them effectively. By managing brands, you can enhance your store's organization and improve customer trust by showcasing well-known or premium brands prominently.

Key functionalities include:
  • Add/Update Brands: Create new brands and upload logos to represent them.
  • Feature Brands: Highlight specific brands on the homepage for better visibility.
  • Delete/Restore Brands: Remove brands from the list or restore them when needed.
Manage Categories

The Category Management feature allows admins to create, organize, and manage product categories in a hierarchical structure, ensuring a streamlined shopping experience for customers.

Key functionalities include:
  • Root Category: Create top-level categories to group similar products
  • Child Category: Add child categories under a parent category for detailed classification.
  • Add/Edit Categories: Update category details such as name, slug (URL-friendly name), meta title, description, keywords, images, and icons to improve SEO and visual representation.
  • Feature Categories: Mark categories as featured to display them prominently on the homepage or in banners.
  • Delete/Restore Categories: Temporarily remove categories or restore them when required.
  • Drag-and-Drop Hierarchy: Organize categories in a tree structure for easy management of parent-child relationships.
How to Add a Root/Parent Category?

To create a root category, ensure no category is selected from the category tree. Fill out the form and submit it to add a root category. Alternatively, you can click on the Add Root Category button to initiate the process.

How to Add a Child Category?

To create a child category, first select the desired parent category from the category tree. Then, click on the Add Child button, complete the form, and submit it to add the child category under the selected parent.

Manage Product Types

The Product Type Management module enables admins to create and organize product types with detailed specifications, facilitating effective product definition and categorization. This feature supports adding attributes and grouping them under relevant sections for a structured presentation of technical details. Additionally, product types are implemented to streamline Product Comparison Management, allowing users to compare items based on predefined specifications. Admins can also create specification templates under each product type, ensuring consistency and efficiency when managing product data.

Key functionalities include:
  • Product Type Configuration: Create or edit product types to categorize products based on their features.
  • Specification Groups: Organize attributes into groups for better clarity and logical organization.
  • Add Attributes: Define specific attributes for a product type. These attributes can be customized to fit the requirements of the product type.
  • Structured Display: The interface ensures that all attributes and groups are displayed hierarchically, providing an organized view for managing and presenting specifications.
Add/Update Products

The Manage Products module allows admins to add, update, and manage detailed product information effectively. This feature is designed to ensure flexibility and accuracy while creating or modifying product listings, helping businesses showcase their offerings in a professional and organized manner.

General
  • Name: Enter a title for the product.
  • Slug: A URL-friendly version of the product name.
  • Type: Select the product type is Variable or Simple.
  • Brand: Choose the product brand.
  • Attributes: Select the attributes for the product if it is a variable product. Select Attribute Values for the attributes selected.
  • Regular Price: Enter the regular price of the product.
  • Sale Price: Enter the sale price of the product.
  • Schedule: Click on the Schedule Link to schedule the product for sale.

Note: If the product is a variable product prices will be configured from the variants level from Variants configuration.

Media Contents
  • Main Image: Upload the primary image of the product, which will be displayed prominently in the product list and on the product details page.
  • Gallery Images: Add multiple images to showcase the product from various angles or highlight different features. These images will be displayed in the product details page gallery.
  • Video: Provide a YouTube embed link to include a product video. The video will be featured on the product details page, offering an engaging way to present the product to potential customers.
Description
  • Description: Provide a detailed overview of the product. This description will be displayed on the product details page, giving customers comprehensive information about the product. The field includes a rich text editor, allowing you to format the content for better organization and readability.
  • Summary: Write a concise summary of the product. This summary will appear both on the product details page and in the list view on the products page, offering customers a quick snapshot of the product's key features and benefits.
SEO Content
  • Meta Title: Provide a unique and descriptive title for the product. This title will appear in search engine results, helping attract potential customers and improve visibility.
  • Meta Description: Write a compelling and informative description of the product. This will be displayed in search engine results, encouraging users to click through to the product page.
  • Meta Keywords: Add relevant keywords that describe the product, separated by commas. These keywords help search engines understand the product's content and improve its discoverability.
Inventory
  • Product SKU: Provide a unique identifier for the product. This SKU will be used for efficient inventory management and order processing.
  • Track Inventory: Enable this option if you wish to monitor the product's inventory levels.
  • Show Stock Quantity: Turn on this setting to display the product's stock quantity on the product details page.
  • Stock Quantity: Enter the current stock quantity of the product.

Note: If the product is a variable product, inventory can also be managed at the variant level. However, if you choose not to manage inventory at the variant level, you can manage it from the product level. For example, if you enter 500 in the Stock Quantity field and have three variants, each variant will be considered to have the same stock quantity of 500. This means you have 500 units of each variant in stock, not 500 units distributed across all variants.

Variants

The Variants management provides a dedicated interface for managing product variations. This feature is particularly useful for products available in different configurations such as color, size, storage, or other attributes. The Variants Tab enables admins to efficiently handle multiple variations of the same product while maintaining individual attributes and settings for each variant.

Key Features of the Variants:
  • Variant Management: Easily manage multiple variations of the same product, each with its own attributes and settings.
  • Publish Control:
    • Each variant has an individual Published toggle switch.
    • This allows admins to enable or disable specific variants without affecting the rest of the product.
  • Stock Management:
    • Admins can enable the Manage Stock option for each variant.
    • Variants with stock management enabled display fields to track inventory through unique SKUs (Stock Keeping Units).
  • Price Settings:
    • Fields for Regular Price and Sale Price allow admins to set standard and discounted prices for each variant.
    • Admins can define Sale Start and Sale End Dates to automate promotional offers for specific variants.
  • Image Management:
    • Each variant can have its own Main Image and Gallery Images to visually distinguish it from other variants.
    • This allows users to see the specific look or configuration of a variant.
Specifications

This allows administrators to add product-specific specifications based on the Product Type selected. These specifications provide additional information about the product, helping customers make informed purchasing decisions.

Key Features:
  • Product Type Selection: The Product Type dropdown is a required field that lists all available product types created in the Product Type menu.
  • The specification groups and attributes are automatically loaded based on the selected product type.
  • Specifications are divided into Groups for better organization
Extra Description

This allows administrators to add extra descriptions groups with title and description to show additional information about the product in product details page.

Downloadable
  • Downloadable Product: Enable this option if the product is a downloadable product.
  • Delivery Type: Select the option when to upload the file Instant or After Sale. If the option is set to After Sale, the file will be uploaded after the order is placed. This feature allows admin to control the downloadable file if vary based on the order.
Product Status
  • Publish Product: You have to keep it enable to show the product on the store front.
  • Show in Products Page: This option is used to show the selected product in the products page. When users click on the products menu, they will see the products that are enabled by this option.
Product Categories

This allows administrators to assign the product to one or more categories. This helps customers find products based on categories.

You have to click on the Save Changes button to save the changes in Categories & Product Status selections.

Bulk Product Import

The Bulk Product Import feature allows you to efficiently add multiple products to your store in a single action using a structured CSV or Excel file. This guide provides detailed steps and file structure specifications to ensure a smooth and successful import process.

Bulk Import is ideal for onboarding large product catalogs, migrating from another system, or making mass updates. The import process involves:

  • Downloading the Template File
  • Filling in Product Data
  • Referencing Relational Data (e.g., brands, categories)
  • Uploading the File
  • Reviewing the Imported Products
Fields Overview
Field Name Description Is Required Example
Name The name of the product that will be displayed on the store Yes iPhone 15 Pro Max
Slug A unique, URL-friendly identifier for the product. Ensure to check the existing product slugs, as it must be unique.
Must be unique 		Yes iphone-15-pro-max
Brand ID The numerical ID representing the product brand
Must exist in the brands list 		No 1
Categories A list of category IDs associated with the product, separated by commas
These IDs must exist in the categories list 		No 1,2
Product Type Defines whether the product is simple or variable.
1 for Simple Product, 2 for Variable Product 		Yes 1
Product Attributes List of attribute IDs used for variations, applicable only for variable products Required if Product Type = 2 1,2
Attributes Values A mapping of attribute IDs to their respective values.
For example, "1:3,4|2:5,6" means that attribute ID 1 has values 3 and 4, and attribute ID 2 has values 5 and 6 		Required if Product Type = 2 1:3,4|2:5,6
Regular Price The standard selling price of the product before any discounts Yes 100
Sale Price The discounted price of the product, if applicable No 90
Sale Starts From The starting date and time when the sale price becomes active
Format: m/d/Y h:i A 		No 14/01/2025 10:00 AM
Sale Ends At The ending date and time when the sale price expires
Format: m/d/Y h:i A 		No 13/02/2025 11:59 PM
Track Inventory Indicates whether the stock of this product should be tracked
1 for Yes, 0 for No 		No 1
SKU A unique Stock Keeping Unit (SKU) for inventory management No IPH15PM123
In Stock The available stock quantity of the product. Leave it empty or set it to 0 if the stock is initially unavailable No 50
Alert Quantity The minimum stock level at which the admin will receive a low-stock alert No 5
Main Image ID The ID of the main product image in the media files
Must be exists in the media files 		No 101
Gallery Images A comma-separated list of media IDs for additional product images
Must be exists in the media files 		No 102,103,104
Video Link A YouTube embed link showcasing the product No https://www.youtube.com/embed/WOb4cj7izpE
Summary A brief overview of the product highlighting key features No Powerful smartphone with advanced features
Description A detailed description of the product, including specifications and features No Includes A17 chip, 48MP camera, titanium build
Meta Title The SEO-friendly title for the product page No Buy iPhone 15 Pro Max Online
Meta Description A short SEO description that appears in search results No Get the best price on iPhone 15 Pro Max
Meta Keywords A comma-separated list of SEO keywords relevant to the product No iPhone 15, Apple, smartphone
Is Published Defines whether the product is published or saved as a draft
1 for Published, 0 for Draft 		No 1
Show In Products Page Controls whether the product appears on the products page
1 for Yes, 0 for No 		No 1
Important Notes
  • ✅ You must manually generate variants for variable products after import.
  • 📥 For downloadable products, mark them manually and upload the downloadable files after import.
Bulk Product Export

The Bulk Product Export feature allows administrators to export product data into a CSV file for reporting, backups, catalog sharing, or migration purposes. This guide explains how to use the export tool, customize the output, and download your product list in just a few clicks.

Bulk Export helps you quickly extract product data by:

  • Selecting specific columns to include in the file
  • Filtering products by ID range
  • Exporting results in a ready-to-use .csv format
How to Export Products
  • Go to Product > Bulk Export
  • Select the columns you want to include in the export file
  • Optionally, enter a product ID range to filter the export
  • Click Export
  • The system will generate and download a .csv file automatically
ID Range Filtering

You can filter which products to export based on their IDs.

Field Description
Start ID The ID of the first product you want to export
End ID The ID of the last product you want to export
📝 Rules:
  • Leave both fields blank to export all products
  • Leave only the End ID blank to export from the Start ID onward
  • Enter both fields to export products in that specific ID range
Example:
Start ID: 100
End ID: 150

This will export products with IDs from 100 to 150.

Output Format

The export file is downloaded in CSV format, compatible with:

  • Excel
  • Google Sheets
  • LibreOffice
  • Any text editor or spreadsheet program
Each row in the file represents a product, and each column corresponds to the fields you selected.
Best Practices
  • Use the ID range to export a specific batch of products for editing or migration.
  • Always review your exported data before sharing externally.
  • Use column selection to limit the file size and exclude sensitive data.
Manage Reviews

The Review Management section allows administrators to effectively oversee customer reviews submitted for products.

Key Features
  • View Reviews: Admins can access a comprehensive list of reviews submitted by customers for individual products.
  • Delete Reviews: Reviews that are incomplete, irrelevant, or inappropriate can be deleted by the admin to maintain the platform's quality standards.
On This Article

Promotional Tools

The Promotional Tools section is designed to help admins create and manage marketing campaigns for their products. This section includes features to manage coupons and offers, enabling businesses to attract more customers, drive sales, and reward loyal buyers. Below are detailed instructions for each aspect of the Promotional Tools module.

Manage Coupons

Coupons are discount codes that customers can apply during checkout to receive discounts on their purchases. These are a great way to incentivize sales, reward loyal customers, or clear inventory.

How to Add Coupons
  1. Navigate to Promotion > Coupons from the admin panel.
  2. Click the Add New button.
  3. Fill in the fields in the coupon creation form:
    • General Information
      • Coupon Name (Optional): A descriptive name for internal identification.
      • Coupon Code: A unique code that customers will use to redeem the coupon.
      • Discount Type: Select whether the discount is a flat amount or a percentage.
      • Discount Amount: Specify the discount value in amount or percentage.
      • Expired At: Specify the expiration date of the coupon.
    • Usage Limit (Optional)
      • Limit Per Coupon: Set a limit for how many times the coupon can be used in total. Leave empty for unlimited uses.
      • Limit Per Customer: Set a limit for how many times a single customer can use the coupon. Leave empty for unlimited uses.
    • Usage Restrictions (Optional)
      • Minimum Spend: Set a minimum purchase amount required to apply the coupon.
      • Maximum Spend: Set a maximum purchase amount eligible for the coupon.
      • Categories: Restrict the coupon to specific product categories.
      • Products: Restrict the coupon to specific products.
      • Exclude Sale Items: Toggle to exclude products already on sale from the coupon.
  4. Save the coupon by clicking the Submit button.
How Coupons Work
  1. Customers apply the coupon by entering the coupon code at the cart.
  2. The system validates the coupon based on:
    • Validity period
    • Usage limits (per coupon and per customer).
    • Spend restrictions.
    • Eligible categories/products.
  3. If valid, the discount is applied to the cart total.
Manage Offers

Offers provide automatic discounts on products or categories without requiring customers to input a code. They are excellent for seamless promotions and improving product visibility.

How to Add Offers
  1. Navigate to Promotion > Offers from the admin panel.
  2. Click the Add New button.
  3. Fill in the fields in the offer creation form:
    • General Information
      • Banner: (Optional) Upload an image to display in the offer section alongside the products.
      • Offer Name: (Optional) A descriptive title for the offer.
      • Discount Type: Choose between a flat discount amount or a percentage discount.
      • Amount: Specify the discount value in amount or percentage.
      • Starts From: Specify the date and time when the offer becomes active.
      • Ends At: Specify the date and time when the offer expires.
      • Show Banner: Enable this to display the banner in the offer section.
      • Show Countdown: Select the products to which the offer applies.
    • Products: Select the products to which the offer applies.
  4. Save the offer by clicking the Save button.
How Offers Work
  • Once an offer is created, it is automatically applied to the selected products.
  • Customers will see the discounted price on the product.
  • Important Notes:
    • Offers do not require coupon codes.
    • If a product's sale price is entered directly in the product form, it will apply as the default discount. However, if the product is included in an offer, the discount from the offer will take precedence and will be calculated based on the product's regular_price, not the sale price.
    • If a product is already part of another offer, the new offer will replace the old one.
On This Article

Payment Management

Coupons are discount codes that customers can apply during checkout to receive discounts on their purchases. These are a great way to incentivize sales, reward loyal customers, or clear inventory.

Automatic Gateways

The system integrates with over 30 automatic payment gateways, enabling seamless transactions for users.

How to Activate an Automatic Gateway

Administrators can activate these gateways by following the steps below:

  1. Access the Payment Gateways Settings:
    • Navigate to the Store Front Settings menu.
    • Search for "Gateways" and select Payment Gateways.
  2. Access the Payment Gateways List:
    • Ensure you are in the Automatic Gateway tab, which is selected by default. See the list of available gateways.
    • Review the list of available gateways.
    • Click on the Edit button of the gateway you wish to activate.
  3. Provide Gateway Credentials:
    • Enter the necessary credentials, such as API keys, merchant IDs, etc.
  4. Upload Gateway Logo
  5. Configure Currencies:
    • Add supported currencies by selecting from the provided list.
    • Configure each currency with the following options:
      • Name: Enter the Name (e.g., Stripe USD, Stripe EUR).
      • Range:Set the minimum and maximum transaction limits.
      • Charge: Configure the fixed fee and percentage-based charge. The charge will be calculated as Fixed Charge + Percent Charge.
      • Currency Symbol: Define the symbol for the currency (e.g., $, €, £).
      • Rate: Set the exchange rate relative to the site currency (configured in General Settings).
  6. Save the Configuration:
    • Once all required fields are completed, click Submit to activate the gateway.
Enable/Disable Automatic Gateways

Administrators have the ability to enable or disable automatic gateways as needed. This feature allows for greater control over which payment methods are available to customers.

  • In the list of gateways, each entry will have Enable/Disable button.
  • To disable a gateway, click the Disable button.
  • To re-enable a gateway, click the Enable button.
Manual Gateways
What is Manual Gateway?

Manual gateways allow customers to make payment through methods such as bank transfers, which are processed manually by the administrator.

How to Add a New Manual Gateway

Administrators can activate these gateways by following the steps below:

  1. Access the Manual Gateways Settings:
    • Navigate to the Store Front Settings menu.
    • Search for "Gateways" and select Payment Gateways.
  2. Access the Payment Gateways List:
    • Select the Manual Gateway tab, Automatic Gateway is selected by default.
    • Click on the Add New Button to add a new manual gateway.
  3. Provide Gateway Information:
    • Fill in the required fields::
      • Upload Logo: Upload a logo for the method
      • Gateway Name: Enter the Name (e.g., Bank Transfer).
      • Currency: Enter the Name (e.g., USD, EUR).
      • Range:Set the minimum and maximum transaction limits.
      • Charge: Configure the fixed fee and percentage-based charge. The charge will be calculated as Fixed Charge + Percent Charge.
      • Payment Instructions: Provide detailed instructions for the customer.
      • Dynamic Form: Create a form for customers to complete during the payment process.
  4. Save the Configuration:
    • Once the form is filled out, click Submit to add the manual gateway to the system.
Enable/Disable Manual Gateways

Administrators have the ability to enable or disable manual gateways as needed. This feature allows for greater control over which payment methods are available to customers.

  • In the list of gateways, each entry will have Enable/Disable button.
  • To disable a gateway, click the Disable button.
  • To re-enable a gateway, click the Enable button.

Manage Customers Payments

This option provides administrators with a comprehensive interface to manage user payments. This includes viewing and processing payments through various stages, such as pending, approved, successful, and rejected.

View Payments
  • Navigate to the Payments menu to view all user payments, both automatic and manual.
  • In the Payments menu, you will find several submenus that categorize payments based on their status:
    • Pending Payments: Payments awaiting approval.
    • Approved Payments: Payments that have been approved.
    • Successful Payments: Payments that have been successfully processed and completed.
    • Rejected Payments: Payments that have been rejected due to fraud or other reasons.
    • All Payments: A comprehensive list of all payments, regardless of status.
Viewing Payment Details
  • In any of the payment submenus, each payment entry will have a Details button.
  • Click on the Details button to access the detailed view of the payment.
Approve / Reject Pending Payments
  1. In the payment's detail view, if the payment is in a pending state, the administrator will have the option to Approve or Reject the payment.
    • Approve: Confirms the payment, moving it to the successful status
    • Reject: Denies the payment, moving it to the rejected status. This is typically done if the payment is deemed fraudulent or does not meet the required criteria.
  2. Once the action is taken, the payment's status will be updated accordingly, and the customer will be notified if notifications are configured in the system.

This process ensures that all payments are thoroughly reviewed and validated, maintaining the integrity and security of the financial transactions on the platform.

On This Article

Order Management

This module provides admins with tools to manage and track orders effectively through different statuses and submenus. Admins can update the status of orders, take necessary actions, and ensure smooth order processing.

Order Statuses

Each order passes through the following statuses:

  1. Pending: The order has been placed but is awaiting admin action.
  2. Processing: The order is being prepared or packed.
  3. Dispatched: The order has been shipped and is on its way to the customer.
  4. Delivered: The order has been successfully delivered to the customer
  5. Cancelled: The order has been cancelled by the admin.
  6. Returned: The order has been returned by the customer.
Order Workflow
  1. Pending Orders:
    • Once a customer places an order (via online payment or COD) it appears in the Pending Orders submenu or the All Orders list.
    • Admin Actions:
      • Mark as Processing: Move the order to the processing stage ift it's ready to be prepared or packed.
      • Cancel the Order: If the order cannot be fulfilled, mark it as canceled. It will move to the Canceled Orders submenu.
  2. Processing Orders:
    • Orders marked as processing are displayed in the Processing Orders submenu.
    • Admin Actions:
      • Mark as Dispatched: Once the order is ready for shipment, move it to the dispatched stage.
      • Cancel the Order: If the order needs to be stopped during processing, cancel it. It will move to the Canceled Orders submenu.
  3. Dispatched Orders
    • Orders that are shipped appear in the Dispatched Orders submenu.
    • Admin Actions:
      • Mark as Delivered: Once the order is confirmed as delivered, move it to the delivered stage. It will appear in the Delivered Orders submenu and mark the order as completed.
      • Mark as Returned: If the customer returns the order after dispatch, mark it as returned. It will move to the Returned Orders submenu and mark the order as completed.
  4. Delivered Orders
    • Orders successfully delivered appear in the Delivered Orders submenu.
    • No further action is needed for these orders, as they are marked as completed.
  5. Returned Orders
    • Orders returned by customers are listed in the Returned Orders submenu.
    • No further action is needed for these orders, as they are marked as completed.
  6. Canceled Orders
    • Orders canceled at any stage are listed in the Canceled Orders submenu.
    • These orders are no longer active and cannot be moved back to a different status.
Admin Actions at Each Stage
Order Status Next Available Actions Resulting Status
Pending Cancel the order Canceled
Mark as processing Processing
Processing Cancel the order Canceled
Mark as dispatched Dispatched
Dispatched Mark as delivered Delivered (Completed)
Mark as returned Returned (Completed)
On This Article

Support Ticket

The Support Ticket module allows customers and guests to create and manage support tickets, ensuring efficient handling of customer inquiries and issues. This documentation outlines the steps for customers to open tickets, how guest submissions are handled, and how administrators can manage and respond to support tickets.

Customer Support Ticket Management
  • Opening a Support Ticket
    • Customers can open a support ticket from the Support Ticket menu in their user panel.
    • Upon clicking the Open New Ticket button, customers will be presented with a form to provide the necessary details such as the subject, priority, and message.
    • Once submitted, the ticket will be recorded in the system, and customers can track its status from the Support Ticket menu.
  • Viewing and Managing Support Tickets
    • Customers can view the status of their open tickets from the Support Ticket menu in their user panel.
    • Each ticket entry will display its current status (e.g., Open, Closed) and the option to view detailed conversations.
    • Customers can also reply to the ticket if they need to provide additional information or close the ticket if the issue has been resolved.
Guest Support Ticket Management
  • Submitting Contact Form
    • Guests (non-registered customers) can submit a support ticket through the website's Contact Form.
    • Upon submission, the contact form entry is automatically converted into a support ticket in the system.
    • A confirmation email with a link to view the ticket is sent to the guest’s provided email address.
  • Accessing the Ticket
    • Guests can access their support tickets by clicking on the link sent to their email after they submit the contact form.
    • The link will direct them to a page where they can view the status of their ticket and any responses from the support team.
Admin Support Ticket Management
  • Accessing Support Tickets
    • Admins can access all support tickets from the Support Ticket menu in the admin panel.
    • The support tickets are organized in a table format, displaying key information such as ticket ID, subject, user/guest name, and status, priority etc.
  • Responding to Support Tickets
    • Admins can click on any ticket to view the details and the conversation history.
    • They can reply to the ticket directly within the admin panel, providing solutions or requesting additional information from the user or guest.
    • Once an issue is resolved, admins can close the ticket, marking it as completed.
On This Article

Settings

This document provides an overview of the various settings available in the platform, including General Settings & System Configuration management. These settings allow administrators to customize and control different aspects of the platform’s functionality, appearance, and behavior.

General settings

The General Settings page allows admins to configure fundamental aspects of the platform that affect its overall operation and user experience. The settings can be accessed from Settings > General Settings.

Fields in General Settings:
  • Site Title: The name of the shop, displayed in the browser tab and various places on the platform.
  • Preloader Title: The text displayed on the preloader screen
  • Currency: The default currency used throughout the platform (e.g., USD, EUR, GBP).
  • Currency Symbol: The symbol associated with the currency (e.g., $, €, £).
  • Timezone: The default timezone for the platform, ensuring that all time-related functions are accurate.
  • Site Base Color: The primary color used in the platform’s design theme.
  • Records to Display Per Page: The number of records shown per page in lists and tables.
  • Currency Showing Format: The format in which currency values are displayed (e.g., Currency Text & Symbol Both, Currency Text Only, Currency Symbol Only).
System Configuration

The System Configuration page allows admins to enable or disable various modules and features across the platform. It can be accessed from Settings > System Configuration.

Key Toggles and Options:
  • Force SSL: Enforces the use of HTTPS across the platform for enhanced security.
  • OTP Via Email: Enables the sending of OTPs through email for user verification.
  • OTP Via SMS: Enables the sending of OTPs through SMS for user verification.
  • Auto Logout Idle Users: Automatically logs out users who have been idle for a specified period.
  • Other Toggles: The System Configuration includes a variety of other toggles for different features and modules (many of these have been discussed in previous parts of this documentation). Each toggle can be enabled or disabled according to the platform’s needs.
On This Article

Notification Settings

The Notification Settings feature allows admins to configure and manage notification preferences for the platform. This feature ensures that all communication methods (email, SMS, and push notifications) are properly set up and customized to meet the needs of the users and the platform.

Email Notification
Global Email Template

The Global Email Template section is used to design the default email templates. These templates serve as the base layout for all email notifications.

  • Access Global Email Template
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • The Global Template and Email Template is selected by default.
  • Review Global Short Codes:
    • A list of available short codes is provided on the Global Email Template page.
    • Short codes are placeholders used in email templates. They can be copied and used in the email body and subject to dynamically insert information such as user names, account details, etc.
  • Fill up the form:
    • Email Sent From - Name: Enter the name that will appear as the sender in the email.
    • Email Sent From - Email: Enter the email address that will appear as the sender.
    • Email Body: Enter the default body content for the email template. This content is the design and layout of the email, which will be populated with specific messages from the notification templates.
Email Setting

This section allows you to configure how emails are sent from the platform.

  • Access Email Setting
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select Email Setting from the options. The Global Template is selected by default.
  • Configuration Options
    • PHP Mail: Select this option if you wish to use PHP's built-in mail function for sending emails.
    • SMTP: Select this option to use SMTP for sending emails. Provide the necessary SMTP server details.
    • SendGrid API: Choose this option if you are using SendGrid for sending emails.
    • Mailjet API: Select this option if you are using Mailjet for email delivery.
  • Required Fields
    • Depending on the chosen configuration option, fill in the required fields such as SMTP server address, API keys, etc.
    • Click Submit to save your settings.
Control Email Notification
  • Access Email Setting
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select Email Setting from the options. The Global Template is selected by default.
  • Configuration Options
    • PHP Mail: Select this option if you wish to use PHP's built-in mail function for sending emails.
    • SMTP: Select this option to use SMTP for sending emails. Provide the necessary SMTP server details.
    • SendGrid API: Choose this option if you are using SendGrid for sending emails.
    • Mailjet API: Select this option if you are using Mailjet for email delivery.
  • Required Fields
    • Depending on the chosen configuration option, fill in the required fields such as SMTP server address, API keys, etc.
    • Click Submit to save your settings.
SMS Notification
Global SMS Template

The Global SMS Template section is used to design the default SMS templates. These templates serve as the base layout for all SMS notifications.

  • Access Global SMS Template
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select SMS Template from the options. Email Template is selected by default.
  • Review Global Short Codes:
    • A list of available short codes is provided on the Global SMS Template page.
    • Short codes are placeholders used in SMS templates. They can be copied and used in the sms body to dynamically insert information such as user names, account details, etc.
  • Fill up the form:
    • SMS Sent From: Enter the sender name that will appear in the SMS.
    • SMS Body: Enter the default body content for the SMS template. This content is the design and layout of the SMS, which will be populated with specific messages from the notification templates.
SMS Setting

This section allows you to configure how SMS are sent from the platform.

  • Access SMS Setting
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select SMS Setting from the options. The Global Template is selected by default.
  • Configuration Options
    • Clickatell: Select this option if you are using Clickatell for sending SMS. Provide the necessary Clickatell credentials.
    • Infobip: Choose this option if you use Infobip. Enter the required Infobip credentials.
    • Message Bird: Select this option if you use Message Bird for SMS delivery. Provide the Message Bird API key.
    • Nexmo: Choose Nexmo for sending SMS and enter the required API key.
    • SMS Broadcast: Select this option if you use SMS Broadcast. Enter the necessary credentials.
    • Twilio: Choose Twilio and enter the Twilio Account SID and Auth Token.
    • Text Magic: Select Text Magic and provide the API key.
    • Custom API: Use this option if you have a custom SMS API. Enter the necessary API details.
  • Required Fields
    • Depending on the selected SMS provider, fill in the required fields such as API keys, credentials, etc.
    • Click Submit to save your settings.
Push Notification
Global Push Notification Template

The Global Push Notification Template section is used to design the default push notification templates. These templates serve as the base layout for all push notifications.

  • Access Global Push Notification Template
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select SPush Notification Template from the options. Email Template is selected by default.
  • Review Global Short Codes:
    • A list of available short codes is provided on the Global Push Notification Template page.
    • Short codes are placeholders used in Push Notification templates. They can be copied and used in the Push Notification body to dynamically insert information such as user names, account details, etc.
  • Fill up the form:
    • Notification Title: Enter the default title for push notifications.
    • Push Notification Body: Enter the default body content for push notifications. This content is the design and layout of the push notification, which will be populated with specific messages from the notification templates.
Push Notification Setting

This section allows you to configure push notifications.

  • Access Push Notification Setting
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select Push Notification Setting from the options. The Global Template is selected by default.
  • Configuration Options
    • Upload JSON File from Firebase
      • Click the help button for instructions on how to obtain the JSON file from Firebase.
      • Upload the JSON file containing the Firebase configuration.
    • Form Fields
      • Fill in fields required for push notifications configuration.
      • Click Submit to save your settings.
Notification Templates

The Notification Templates section allows admins to customize various notification templates.

  • Access Notification Templates
    • Navigate to the Settings menu in the admin panel.
    • Select Notification Settings from the options.
    • Select Notification Templates from the options. The Global Template is selected by default.
    • A list of all available notification templates is displayed, including templates for notifications.
  • Editing and Customizing Templates
    • Each notification template has three buttons: Email, SMS, and Push. Admins can click these buttons to edit the respective template for that notification type.
    • After clicking a button, the admin is taken to a form where they can edit the content, subject (for email), and other relevant fields.
    • These templates are initially provided as dummy templates and should be customized by the admin to suit the platform's specific needs.
  • Using Short Codes
    • Short codes are placeholders that can be used in notification templates. They help dynamically populate template fields with specific user data.
  • Saving Changes
    • After making changes to a template, click the Save button to apply and store the modifications.
On This Article

Store Front Settings

The Store Front Setting allows admins to manage every aspect of the platform's frontend, including content, sections, pages, SEO settings, templates, and more. This ensures the platform's frontend remains dynamic, up-to-date, and aligned with branding and legal requirements.

Logo & Favicon Management

The Logo and Favicon feature allows admins to upload and manage the platform’s logo and favicon, ensuring consistent branding across the site. This can be accessed from Settings > Logo and Favicon.

Uploading and Managing Logos and Favicon:
  • Logo for White Background: Upload the logo to be displayed on sections of the platform with a white background.
  • Logo for Dark Background: Upload the logo to be displayed on sections of the platform with a dark background.
  • Favicon: Upload the favicon, the small icon displayed in the browser tab, associated with the platform.
Frontend Content

Admins can update the content of various sections and pages directly from the Manage Frontend menu.

  • Update Content for Sections and Pages:
    • Navigate to Store Front Settings > Manage Frontend.
    • Select the section.
    • Modify the content as you want.
    • Save your changes to apply them to the frontend.
Manage Pages

Admins have the ability to rearrange sections, and manage existing pages to ensure optimal content flow and organization.

  • Add Sections to Pages:
    • While in the Manage Pages menu, choose the page where you want to add sections.
    • Click on the Edit button.
    • Drag sections from the left side and drop them to the left side and click on "Update Now" button
    • You can re arrange sections by drag and drop feature
SEO Configuration

Admins can configure global SEO settings to optimize the platform's visibility on search engines.

  • Set Global SEO Contents:
    • Navigate to Settings > Manage Frontend.
    • Set the SEO Image, Meta Keywords, Meta Description, Social Title, and Social Description.
    • Save the settings to enhance the platform's SEO performance.
  • Set Global SEO Contents:
    • Navigate to Store Front Settings > SEO Configuration.
    • Enter SEO Image, Meta Keywords, Meta Description, Social Title, Social Description
Policy Pages Management

Admins can manage important policy pages, such as Terms and Conditions and Privacy Policy, ensuring they are up-to-date and compliant.

  • Add or Edit Policy Pages:
    • Navigate to Settings > Manage Policy Pages.
    • To add a new policy page, click Add New button.
    • Provide the page title and content in the rich text editor (NIC Editor).
    • Save the page to publish it.
  • SEO Settings for Policy Pages:
    • While adding or editing a policy page, admins can also configure SEO settings to optimize visibility.
    • Save the SEO settings along with the page content.
  • Remove Policy Pages:
    • From the Manage Pages menu, select the policy page you wish to remove and delete it.
Maintenance Mode

Admins can enable maintenance mode to perform updates or changes without disrupting the user experience.

  • Enable Maintenance Mode:
    • Navigate to Settings > Maintenance Mode.
    • Toggle the Status switch to enable maintenance mode.
    • Write the content that will be displayed on the maintenance page.
    • Submit to activate maintenance mode.
Custom CSS

Admins have the ability to customize the frontend design by adding custom CSS.

  • Enable Maintenance Mode:
    • Navigate to Settings > Custom CSS.
    • Write or paste the CSS code to customize the frontend design.
    • Enter the GDPR cookie policy content.
    • Submit to save changes to apply the custom styles.
Sitemap XML

Admins can create and manage the sitemap XML to help search engines crawl the website more efficiently.

  • Enable Maintenance Mode:
    • Navigate to Settings > Sitemap XML.
    • Write or paste the sitemap XML file.
    • Submit to ensure search engines can properly index the website.
Robots.txt Management

Admins can manage the robots.txt file to control how search engines access and index the website's content.

  • Write Robots.txt::
    • Navigate to Settings > Robots txt.
    • Write the rules for search engine crawlers.
    • Submit to Save the file to apply the changes.
On This Article

Extensions

The Extension feature allows admins to manage and configure various integrated extensions within the platform. This feature provides an easy way to enhance the platform's functionality by enabling, configuring, or disabling available extensions.

Accessing the Extension Manager

To access the Extension Manager, follow these steps:

  • Navigate to the Settings menu.
  • Select Extension from the available options.

This will open the Extension Manager page, where all integrated extensions are listed.

Available Extensions

The platform comes with four integrated extensions:

  • Custom Captcha: A customizable CAPTCHA system that helps prevent spam and automated bot activity on the platform.
  • Google Analytics: A web analytics service offered by Google that tracks and reports website traffic, providing valuable insights into user behavior.
  • Google reCAPTCHA 2: A free service that protects your website from spam and abuse by using advanced risk analysis techniques to differentiate between humans and bots.
  • Tawk.to: A free live chat app that lets you monitor and chat with visitors on your website, providing real-time customer support.
Managing Extensions

Each extension listed in the Extension Manager can be managed through the following options:

  • Configure Button: Each extension has a Configure button. Click this button to access the configuration settings for the selected extension.
  • Enabling/Disabling Extensions: Each extension comes with an Enable/Disable button. Admins can activate or deactivate the extension as needed.
On This Article

Language Manager

The Language Manager feature allows administrators to add, manage, and implement multiple languages within the platform, enabling a multilingual user experience. This feature is essential for platforms that cater to a diverse user base with varying language preferences.

Accessing Language Manager

To access the Language, follow these steps:

  • Navigate to the Store Front Settings menu in the admin panel.
  • Select Language
How to Add a New Language

To add a new language:

  • Click the Add New button from the top of Languages list.
  • A form will appear where you need to fill in the following details:
    • Flag: Upload a flag.
    • Language Name: Enter the name of the language.
    • Language Code: Enter the code of the language(e.g. en, bn, hi)
    • Default Language: Set if you want to make this language as the default language.
How to get Keywords from system

To get system keywords:

  • Click the Fetch Keywords button from the top of Languages list.
  • A pop-up will appear where you can see all keywords from the system. It will take some time.
    • Flag: Upload a flag.
    • Language Name: Enter the name of the language.
    • Language Code: Enter the code of the language(e.g. en, bn, hi)
    • Default Language: Set if you want to make this language as the default language.
How to Translate

Access the Keywords for Translation:

  • Access the Keywords for Translation:
    • Navigate to Store Front Settings > Language in the admin panel.
    • Find the language you want to translate and click on the Keywords button associated with that language.
  • Import or Add Keywords:
    • Import Keywords from Another Language: You can import keywords from system or an existing language by selecting the import option. This will add all keywords from the source language to the selected language, allowing you to translate them individually.
    • Manually Add Keywords: Alternatively, you can add keywords manually by clicking the Add Keyword button.
      • Key Field: Enter the keyword in English (this is the key that the system recognizes).
      • Value Field: Enter the translation of the keyword in the selected language.
  • Translate the Imported or Added Keywords:
    • After importing keywords from another language or the system, a list of keywords will be displayed.
    • Click on each keyword to edit its translation.
    • Provide the translated value in the corresponding language for each keyword.
    • Click Submit to store the translations.

By following these steps, you ensure that all keywords are accurately translated and that users experience the platform in their preferred language.

On This Article

Copyright © Viserlab 2024