`.
- Links are clickable.
### **View Messages in Admin Panel**
- Messages appear as **sticky banners** at the top of the admin panel.
- Only **active** messages matching the user's role are displayed.
#### Notice Message
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-70-1.png)
#### Warning Message
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-71-1.png)
#### Success Message
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-72-1.png)
#### Error Message
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-73-1.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-admin-message-manager.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Advanced Admin Login Security
### Installation and User Guide for Magento 2 Advanced Admin Login Security Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Download Extension*
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Security Base*](#bkmrk-configuration-settin)
- *General Settings*
3. *[Configuration Settings for Advanced Login Security](#bkmrk-configuration-settin-1)*
4. [*Scommerce Admin Login Security*](#bkmrk-scommerce-admin-logi)
- *Admin Login Attempts*
- *Blacklist*
- *Whitelist*
### Installation [](#bkmrk-)
- **Download Extension:** Once you have placed the order from our site then go to the Account section, click on My Downloadable Products, and download the extension package.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-06t185804-978.png)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run the below commands on the Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Security Base [](#bkmrk--11)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Security Base**
#### General Settings [](#bkmrk--17)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-06t185846-982.png)
### Configuration Settings for Admin Login Security [](#bkmrk--5)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Admin Login Security**
#### General Settings [](#bkmrk--6)
- **Enabled Admin Login Security –** Select "Yes" or "No" to enable or disable the module.
- **Failed Attempts Limit :-** Set the attempt limit for admin login. Once exceeded the account will be locked out or blacklisted as per further configuration. Make sure this limit is less than default Magento configuration.
- **Apply Action On Exceed Limit:-** Choose the penalty for exceeding the failed attempt limit, between "Lockout" or "Blacklist. **Lockout** - When the number of failed attempts exceeds, the IP will remain blacklisted until the 'Valid till' time limit. The 'Valid till' limit can be defined by the configuration 'Locked out period (in hours)'
**Blacklist** - This action will be applied when the 'Failed Attempts Limit' is exceeded and the IP will be blacklisted until it is manually removed.
- **Locked out period (in hours):-** Set the "Valid Till" limit for the Lockout feature. The accounts will be locked out for period entered in this configuration.
- **Block Email Enabled:-** Enable Emails when any lockout or blacklist occurs. The email is sent to the Store Owner as well as the blacklisted/locked-out user.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-06t185921-450.png)
- **IP Block Email Template:-** Select the email template to be used to send the email when a lockout/blacklist occurs.
- **Block And Lock Event Email Sender:-** Select the sender email from your Default Magento configuration in case of lockout or blacklist.
- **Recipient Block Email:-** Add the email (store owner) which will get emails about each and every lockout/blacklist. Whenever a lockout/blacklist happens the email will be sent to this address as well as the user.
- **Enabled Clear Login Attempts Logs Cron Job:-** Set "Yes" or "No" to enable or disable clear logs cron job.
- **Clear Login Attempts Logs Cron Schedule:-** Set the cron job to define how often you want to clear Login Attempts logs
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-06t185958-131.png)
- **Clear Login Attempts Logs Older Than X Days:-** Set the number of days based on which the Login attempts Logs will be cleared based which are older than the set days. For eg:- if set 2, any login attempts logs older than 2 days will be cleared.
- **Enabled Clear Lockouts Cron Job:-** Set "Yes" or "No" to enable or disable clear of not active lockouts by cron job
- **Clear Lockouts Cron Schedule:-** Set the cron job to define schedule how often you want to clear logs
- **Allowed Countries:-** Block users from one or multiple countries. If no country is selected, all countries are allowed.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-06t190050-422.png)
- **Enabled Whitelist:-** Set "Yes" or "No" to enable or disable whitelisting for an IP. If enabled, the user won't be allowed to log in until the IP is whitelisted.
- **Whitelist Email Enabled:-** Set "Yes" or "No" to enable or disable whitelist Email. If this is enabled, the user will be sent an email with a link that allows them to either approve or deny the login.
**Approve** - By approving, the IP will be added to the whitelist.
**Deny** - The IP will be added to the blacklist if denied.
- **Whitelist request lifetime:-** Set the request lifetime to define how long whitelist request will be valid in hours By default 1 hour.
- **IP Whitelist Email Template:-** Select the email template for the login approval email that is sent to the user, based on the approval the user is whitelisted or blacklisted.
- **Whitelist Event Email Sender:-** Select the sender email to be used to send out the User approval/whitelist email to the user.
- **Recipient Email:-** Add the email (store owner) which will get emails about User approval/Whitelist emails. Whenever a user-approval/whitelist happens the email will be sent to this address as well as the user so store owner can also approve or deny the user from the email.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-06t190159-078.png)
### Scommerce Admin Login Security [](#bkmrk--11)
Go to **Admin > System > Scommerce Admin Login Security>**
#### Admin Login Attempts [](#bkmrk--17)
The Admin Login Attempts grid keeps a record of every login attempt made to the admin panel with various key details such as:-
- ID
- IP Address
- Success
- Admin Username
- Created At
The grid is completely filterable with various columns such as ID, IP Address, Admin Username, Created At etc.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-74-1.png)
#### Blacklist [](#bkmrk--17)
The blacklist records grid contains information about all the blacklist users with several details such as ID, IP Address, Admin Username, Valid till, Created At, and Action. This grid is completely filterable. Each of the record can be deleted or edited from the Action column.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-75-1.png)
Go to **Action>Edit** and you can change various details for each of the records such as IP Address, Username, and Valid till date.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-76-1.png)
#### Whitelist [](#bkmrk--17)
The Whitelist records grid contains information about all the blacklist users with several details such as ID, IP Address, Admin Username, Created At, and Action. This grid is completely filterable. Each of the records can be deleted or edited from the Action column.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-77-1.png)
Go to **Action>Edit** and you can change various details for each of the records such as IP Address, and Username.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-78-1.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-admin-login-security.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Admin Security Checklist
### Installation and User Guide for Magento 2 Security Checklist Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Download Extension*
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Security Base*](#bkmrk-configuration-settin)
- *General Settings*
3. [*Configuration Settings for Security Checklist*](#bkmrk-configuration-settin-1)
- *General Settings*
4. [*Security Checklist Report*](#bkmrk-security-checklist-r)
- *Security Checklist Report*
### Installation [](#bkmrk-)
- **Download Extension:** Once you have placed the order from our site then go to the Account section, click on My Downloadable Products, and download the extension package.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t170625-411.png)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run the below commands on the Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Security Base [](#bkmrk--5)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Security Base**
#### General Settings [](#bkmrk--6)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t170845-230.png)
### Configuration Settings for Security Checklist [](#bkmrk--3)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Security Checklist**
#### General Settings [](#bkmrk--4)
- **Enabled Security Checklist –** This setting will be used to enable or disable admin security checklist
- **Enable Database prefix check :-** This setting will be used to enable or disable check for DB prefix. Database prefix added in file, to make it work you also need to make changes in database.
- **Enable FE Captcha check:-** This setting will be used to enable or disable checks for Frontend Captcha. Go to **Stores > Configuration > Security > Google reCAPTCHA** Storefront in order to verify it.
- **Enable BE Captcha check:-** This setting will be used to enable or disable checks for Backend Captcha. Go to Stores > **Configuration > Security > Google reCAPTCHA** Admin Panel and **Stores > Configuration > Admin > CAPTCHA** Storefront in order to verify it.
- **Enable Magento version check-** This setting will be used to enable or disable check for Magento Version and latest security patches.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t170929-075.png)
- **Enable Admin Users check-:-** This setting will be used to enable or disable check for Admin Users Security. Especially usernames, password lifetime policy and login activity. **Go to Stores > Configuration > Advanced > Admin > Security** Or **Go to System > Permission > All users to manage admin users**
- **Admin Usernames Stop List:-** You can add list of usernames that shouldn't be used for admin accounts. Comma separated.
- **Enabled Admin Path Check:-** This setting will be used to enable or disable check for Admin Path Security. Admin Path is configured in file or go to **Advanced > Admin > Admin Base URL > Use Custom Admin Path** to change it
- **Admin Path Stop List:-** You can add list of paths that shouldn't be used for admin. Comma separated.
- **Enable Content Script Check:-** This setting will be used to enable or disable check for scripts added in your content or configuration
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t171114-153.png)
- **Enabled Checklist Check Cron Job:-** If enabled the security checklist also checks whether admin 2FA is enabled or not.
- **Enabled Checklist Check Cron Job:-** This setting will be used to enable or disable checklist cron job
- **Checklist Cron Schedule:-** This will allow you to define schedule how often you want to clear Login Attempts logs cron.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t171333-441.png)
### Security Checklist Report [](#bkmrk--5)
Go to **Admin > System > Scommerce Security> Security Checklist**
#### Security Checklist Report [](#bkmrk--6)
The Security checklist grid has several distinctions for various checks: Warning, Error and Success
- **Admin password Protection:** - For Admin password protection, if a password change is not forced, the user will see an error. If the lifetime is more than 90 days, the user will see a warning. If a password change is forced and the lifetime is less than 90 days, then the user will see success.
- **Magento version check**: - For a Magento version check, if the version is outdated, the user will see an error. Otherwise, the user will see success.
- **Database Prefix check**: - For the Database prefix check, if the table prefix is not set in the configuration file, the user will see an error. Otherwise, the user will see success.
- **Frontend ReCaptcha Protection** - For Frontend ReCaptchaProtection, if all frontend forms are protected with recaptcha, the user will see a success. When some forms are protected, the user will see a warning. If none of the forms are protected, the user will see an error.
- **Admin Captcha Protection**:- For Admin Captcha protection, if all backend forms are protected with Captcha, the user will see a success. When some forms are protected, the user will see a warning. If none of the forms are protected, the user will see an error.
- **Admin path protection**: - For Admin path protection, if the user's admin path doesn't contain words from the stop list, doesn't contain numbers or capital letters, and is at least 15 characters long, the user will see a success. If any of the criteria mentioned are not fulfilled, the user will see a warning.
- **Admin usernames check**:- For Admin usernames check, if the username contains words from the stop list or if the username contains numbers, the user will see a warning. Otherwise, success.
- **Admin users activity check**: - For Admin admin user activity check, if the account is unused, the user will see a warning. Otherwise, success.
- **Check for static scripts inserted from Config and CMS Pages**: - For Static scripts in Configuarion, CMS Blocks, and CMS Pages, if a text field has a static script, the user will see a warning. Otherwise, success.
- **Check for static scripts inserted from Product Attributes**: - For Static scripts inserted by any product attributes the user will see a warning with the name of the attribute otherwise, success.
- **Check for Admin 2FA**: - It also checks whether admin 2FA is enabled or not.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-86-1.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-87-1.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-88-1.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-security-checklist.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Security Suite
### Installation and User Guide for Magento 2 Security Suite Extension
**Table of Contents**
1. [*Installation*](#bkmrk-installation)
- *Download Extension*
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Security Base*](#bkmrk-configuration-settin)
- *General Settings*
3. [*Configuration Settings for Security Checklist*](#bkmrk-configuration-settin-1)
- *General Settings*
4. [*Configuration Settings for Admin Activity Logger* ](#bkmrk-configuration-settin-2)
- *General Settings*
- *Modules Activity Logger*
- *Admin Activity Logger*
- *Admin Activity Grid*
- *Admin Logger Detailed View for Admin Activities*
- *Admin Logger Detailed View for Item Info*
- *Login Activity Grid*
- *Active Sessions Grid*
5. *[Configuration Settings for Advanced Login Security](#bkmrk-configuration-settin-3)*
6. [*Scommerce Admin Login Security*](#bkmrk-scommerce-admin-logi)
- *Admin Login Attempts*
- *Blacklist*
- *Whitelist*
7. [*Security Checklist Report*](#bkmrk-security-checklist-r)
- *Security Checklist Report*
### Installation [](#bkmrk-)
- **Download Extension:** Once you have placed the order from our site then go to the Account section, click on My Downloadable Products, and download the extension package.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/W47image-98.png)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run the below commands on the Magento 2 root directory.
```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via Composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Security Base [](#bkmrk--14)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Security Base**
#### General Settings [](#bkmrk--15)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/dOMimage-99.png)
### Configuration Settings for Security Checklist [](#bkmrk--8)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Security Checklist**
#### General Settings [](#bkmrk--9)
- **Enabled Security Checklist –** This setting will be used to enable or disable admin security checklist
- **Enable Database prefix check :-** This setting will be used to enable or disable check for DB prefix. Database prefix added to make it work you also need to make changes in database.
- **Enable FE Captcha check:-** This setting will be used to enable or disable checks for Frontend Captcha. Go to **Stores > Configuration > Security > Google reCAPTCHA** Storefront in order to verify it.
- **Enable BE Captcha check:-** This setting will be used to enable or disable checks for Backend Captcha. Go to Stores > **Configuration > Security > Google reCAPTCHA** Admin Panel and **Stores > Configuration > Admin > CAPTCHA** Storefront in order to verify it.
- **Enable Magento version check-** This setting will be used to enable or disable check for Magento Version and latest security patches.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/8Tmimage-100.png)
- **Enable Admin Users check-:-** This setting will be used to enable or disable check for Admin Users Security. Especially usernames, password lifetime policy and login activity. **Go to Stores > Configuration > Advanced > Admin > Security** Or **Go to System > Permission > All users to manage admin users**
- **Admin Usernames Stop List:-** You can add list of usernames that shouldn't be used for admin accounts. Comma separated.
- **Enabled Admin Path Check:-** This setting will be used to enable or disable check for Admin Path Security. Admin Path is configured and go to **Advanced > Admin > Admin Base URL > Use Custom Admin Path** to change it
- **Admin Path Stop List:-** You can add list of paths that shouldn't be used for admin. Comma separated.
- **Enable Content Script Check:-** This setting will be used to enable or disable check for scripts added in your content or configuration
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t190900-579.png)
- **Enabled Checklist Check Cron Job:-** This setting will be used to enable or disable checklist cron job
- **Checklist Cron Schedule:-** This will allow you to define schedule how often you want to clear Login Attempts logs cron.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t191003-386.png)
### Configuration Settings for Admin Activity Logger [](#bkmrk--8)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Admin Activity Logger**
#### General Settings [](#bkmrk--9)
- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- **License Key -** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at
- **Admin Users Login Activity Enabled -** Enable / Disable activity. It will log login activity of the admin users.
- **Page visit History Enabled -** Enable / Disable page history visiting log.
- **Clear Admin Activity Logs After -** Enter value. Clear all admin activity logs will be cleared after X days.
- **Enabled Profiler -** Enable / Disable time profiler. Duration of the operations will be logged.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/7XTimage-68.jpg)
#### Modules Activity Logger [](#bkmrk--7)
- **Order -** Select "Yes" to enable. It will log order related activities.
- **Product -** Select "Yes" to enable. It will log product related activities.
- **Category -** Select "Yes" to enable. It will log category related activities.
- **Customer -** Select "Yes" to enable. It will log customer related activities.
- **Email Template -** Select "Yes" to enable.
- **Page -** Select "Yes" or "No" to Enable / Disable.
- **Block -** Select "Yes" or "No" to Enable / Disable.
- **Widget -** Select "Yes" or "No" to Enable / Disable.
- **Theme -** Select "Yes or "No" to Enable / Disable.
- **System Configuration -** Select "Yes" or "No" to Enable / Disable.
- **Product Attributes -** Select "Yes" or "No" to Enable / Disable.
- **Admin User -** Select "Yes" to enable. It will log all users activities.
- **SEO -** Select "Yes" or "No" to Enable / Disable.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-09t191308-372.png)
- **Admin Activity Logger -** You can view admin activity logger from, **Admin > System > Scommerce Admin Activity Logger > Admin Activity / Login Activity.**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/mjzimage-46-1.png)**
- **Admin Activity Grid -** In the back-end under Admin Activity Logger grid you can view all the admin activities details from **Admin > System > Admin Activity Logger**. This grid will have, Admin Username, Name, Activity Type, Store View, Module, Full Action, IP, Item, Revert and Action columns.
- **Date: -** The exact date and time of the activity performed.
- **Admin Username: -** user name of the admin.
- **Name: -** The name of the admin.
- **Activity Type: -** Type of activity performed
- **Store view: -** Name of the store view
- **Module: -** The name of the module used in the activity.
- **Full Action: -** It contains the URL path of the activity performed.
- **IP Address: -** The IP address of the user.
- **Item: -** Activity related item such as a product or system configuration changes.
- **Revert: -** If the action is not complete then the REVERT column will have the notification.
- **Action: -** It contains view where you can see the key details of the activity such as general and item info.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/grCimage-69.jpg)
#### Admin Activity Logger
- **Admin Logger Detailed View for Admin Activities -** To get more details about each particular action simply click on the 'View' link from **Admin > System > Admin Activity Logger > Select Log > Click on 'View' > General, to view all the detailed data.**
- You can view all the general details of the user's activity in the general tab.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/R9gimage-70.jpg)
- **Admin Logger Detailed View for Item Info -** You can view the item details from **Admin > System > Admin Activity Logger > Select Log > Click on 'View' > Items info.**
- This section contains all granular information. For instance if you place an order from the admin panel then all the details of the order such as price, store, etc. Are visible in this section.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/m8Iimage-71.jpg)
- **Login Activity Grid -** You can view login activities from **Admin > System > Scommerce Admin Activity Logger > Active Sessions**. It logs details of each and every single activity along with what value being changed by who and when. This section contains following information: -
- **Date: -** The precise date and time of the log.
- **Type: -** whether logged in or logged out.
- **Username: -** Username of the person is stored here.
- **Name: -** Name of the user
- **Ip Address: -** You can see the IP address here.
- **User Agent: -** The browser and device details of the user are shown here.
- **Status: -** If the login fails then the status will show FAILED and if the login or logout is successful then it shows SUCCESS
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/946image-72.jpg)
- **Active Sessions Grid-** You can view Active Sessions from **Admin > System > Login Activity > Login Acti**. It logs details of every active admin session on the store. The active session is listed with various useful details. Also, it gives the admin the option to terminate any active admin session through the "Terminate" button under the action column. Once terminated that admin will be logged out of the account automatically. Furthermore, the grid is completely filterable using various columns. This section contains the following information: -
- **Id: -** A Unique ID for each active session.
- **Admin Username: -** Username of the admin of that particular active session.
- **IP: -** IP address of the admin of that session.
- **Last Action: -** Last action performed by the admin of this session.
- **User Agent: -** Various platform, device, and browser information of the admin of this session.
- **Action: -** Contains the option to terminate this particular session.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/MrRimage-47-1.png)
### Configuration Settings for Admin Login Security [](#bkmrk--8)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Admin Login Security**
#### General Settings [](#bkmrk--9)
- **Enabled Admin Login Security –** Select "Yes" or "No" to enable or disable the module.
- **Failed Attempts Limit :-** Set the attempt limit for admin login. Once exceeded the account will be locked out or blacklisted as per further configuration. Make sure this limit is less than default Magento configuration.
- **Apply Action On Exceed Limit:-** Choose the penalty for exceeding the failed attempt limit, between "Lockout" or "Blacklist. **Lockout** - When the number of failed attempts exceeds, the IP will remain blacklisted until the 'Valid till' time limit. The 'Valid till' limit can be defined by the configuration 'Locked out period (in hours)'
**Blacklist** - This action will be applied when the 'Failed Attempts Limit' is exceeded and the IP will be blacklisted until it is manually removed.
- **Locked out period (in hours):-** Set the "Valid Till" limit for the Lockout feature. The accounts will be locked out for period entered in this configuration.
- **Block Email Enabled:-** Enable Emails when any lockout or blacklist occurs. The email is sent to the Store Owner as well as the blacklisted/locked-out user.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t142356-133.png)
- **IP Block Email Template:-** Select the email template to be used to send the email when a lockout/blacklist occurs.
- **Block And Lock Event Email Sender:-** Select the sender email from your Default Magento configuration in case of lockout or blacklist.
- **Recipient Block Email:-** Add the email (store owner) which will get emails about each and every lockout/blacklist. Whenever a lockout/blacklist happens the email will be sent to this address as well as the user.
- **Enabled Clear Login Attempts Logs Cron Job:-** Set "Yes" or "No" to enable or disable clear logs cron job.
- **Clear Login Attempts Logs Cron Schedule:-** Set the cron job to define how often you want to clear Login Attempts logs
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t142448-372.png)
- **Clear Login Attempts Logs Older Than X Days:-** Set the number of days based on which the Login attempts Logs will be cleared based which are older than the set days. For eg:- if set 2, any login attempts logs older than 2 days will be cleared.
- **Enabled Clear Lockouts Cron Job:-** Set "Yes" or "No" to enable or disable clear of not active lockouts by cron job
- **Clear Lockouts Cron Schedule:-** Set the cron job to define schedule how often you want to clear logs
- **Allowed Countries:-** Block users from one or multiple countries. If no country is selected, all countries are allowed.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t142852-674.png)
- **Enabled Whitelist:-** Set "Yes" or "No" to enable or disable whitelisting for an IP. If enabled, the user won't be allowed to log in until the IP is whitelisted.
- **Whitelist Email Enabled:-** Set "Yes" or "No" to enable or disable whitelist Email. If this is enabled, the user will be sent an email with a link that allows them to either approve or deny the login.
**Approve** - By approving, the IP will be added to the whitelist.
**Deny** - The IP will be added to the blacklist if denied.
- **Whitelist request lifetime:-** Set the request lifetime to define how long whitelist request will be valid in hours By default 1 hour.
- **IP Whitelist Email Template:-** Select the email template for the login approval email that is sent to the user, based on the approval the user is whitelisted or blacklisted.
- **Whitelist Event Email Sender:-** Select the sender email to be used to send out the User approval/whitelist email to the user.
- **Recipient Email:-** Add the email (store owner) which will get emails about User approval/Whitelist emails. Whenever a user-approval/whitelist happens the email will be sent to this address as well as the user so store owner can also approve or deny the user from the email.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t142943-998.png)
### Scommerce Admin Login Security [](#bkmrk--14)
Go to **Admin > System > Scommerce Admin Login Security>**
#### Admin Login Attempts [](#bkmrk--15)
The Admin Login Attempts grid keeps a record of every login attempt made to the admin panel with various key details such as:-
- ID
- IP Address
- Success
- Admin Username
- Created At
The grid is completely filterable with various columns such as ID, IP Address, Admin Username, Created At, etc.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/Bsximage-48-1.png)
#### Blacklist [](#bkmrk--15)
The blacklist records grid contains information about all the blacklist users with several details such as ID, IP Address, Admin Username, Valid till, Created At, and Action. This grid is completely filterable. Each of the record can be deleted or edited from the Action column.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/LnGimage-49-1.png)
Go to **Action>Edit** and you can change various details for each of the records such as IP Address, Username, and Valid till date.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/jQximage-50-1.png)
#### Whitelist [](#bkmrk--15)
The Whitelist records grid contains information about all the blacklist users with several details such as ID, IP Address, Admin Username, Created At, and Action. This grid is completely filterable. Each of the records can be deleted or edited from the Action column.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/oIAimage-51-1.png)
Go to **Action>Edit** and you can change various details for each of the records such as IP Address, and Username.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image.png)
### Security Checklist Report [](#bkmrk--14)
Go to **Admin > System > Scommerce Security> Security Checklist**
#### Security Checklist Report [](#bkmrk--15)
The Security checklist grid has several distinctions for various checks: Warning, Error, and Success
- **Admin password Protection:** - For Admin password protection, if a password change is not forced, the user will see an error. If the lifetime is more than 90 days, the user will see a warning. If a password change is forced and the lifetime is less than 90 days, then the user will see success.
- **Magento version check**: - For a Magento version check, if the version is outdated, the user will see an error. Otherwise, the user will see success.
- **Database Prefix check**: - For the Database prefix check, if the table prefix is not set in the configuration file, the user will see an error. Otherwise, the user will see success.
- **Frontend ReCaptcha Protection** - For Frontend ReCaptchaProtection, if all frontend forms are protected with Recaptcha, the user will see success. When some forms are protected, the user will see a warning. If none of the forms are protected, the user will see an error.
- **Admin Captcha Protection**:- For Admin Captcha protection, if all backend forms are protected with Captcha, the user will see a success. When some forms are protected, the user will see a warning. If none of the forms are protected, the user will see an error.
- **Admin path protection**: - For Admin path protection, if the user's admin path doesn't contain words from the stop list, doesn't contain numbers or capital letters, and is at least 15 characters long, the user will see a success. If any of the criteria mentioned are not fulfilled, the user will see a warning.
- **Admin usernames check**:- For Admin usernames check if the username contains words from the stop list or if the username contains numbers, the user will see a warning. Otherwise, success.
- **Admin users activity check**: - For Admin admin user activity check if the account is unused, the user will see a warning. Otherwise, success.
- **Check for static scripts inserted from Config and CMS Pages**: - For Static scripts in Configuration, CMS Blocks, and CMS Pages, if a text field has a static script, the user will see a warning. Otherwise, success.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/QdOimage-54-1.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-security-suite.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Advanced Reporting Extension
### Installation and User Guide for Magento 2 Advanced Reporting Extension
### Table of Contents
1. [*Installation* ](#bkmrk-installation)
- *Upload Package*
- *Install Extension*
2. [*Configuration Settings for Advanced Reporting* ](#bkmrk-configuration-settin)
- *General Settings*
3. [*Reports of Advanced Reporting* ](#bkmrk-reports-of-advanced-)
- *Sales Detailed Report*
- *Sales Item Detailed Report*
- *Sales Summary Report*
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory. ```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Advanced Reporting
Go to **Admin > Stores > Configuration > Scommerce Configuration > Advanced Reporting**
#### General Settings
- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- **License Key -** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t132522-508.jpg)
### Reports of Advanced Reporting
#### Go to Admin > Scommerce Configuration > Reports > Advanced Reporting
#### Sales Detailed Report
You can see the sales detailed report at, **Admin > Reports > Advanced Reports > Sales Detailed Report.**
#### The grid will have following columns:
- Increment Id - Order number
- Store - Store name
- Status - Status of the order, pending/processing/complete/closed
- Order Date
- Customer Name
- Billing Country
- Billing Postcode
- Billing Currency
- Base Currency
- Payment Method
- Total Shipping Price (Excl. VAT)- Base Currency
- Total Shipping Price (Incl. VAT) - Base Currency
- Total Shipping Price (Excl. VAT) - Billing Currency
- Total Shipping Price (Incl. VAT) - Billing Currency
- Total Discount - Base Currency
- Total Discount - Billing Currency
- Total Shipping VAT - Base Currency
- Total Shipping VAT - Billing Currency
- Total VAT - Base Currency
- Total VAT - Billing Currency
- Grand Total (Excl. VAT) - Billing Currency
- Grand Total (Incl. VAT) - Billing Currency
- Grand Total (Excl. VAT) - Base Currency
- Grand Total (Incl. VAT) - Base Currency
- Total Cost
- Gross Profit Margin (%) = ((Grand Total (Excl. Vat) - (Total Cost + Total Shipping Price (Excl. VAT) + Total Discount (Excl. VAT))) / Grand Total (Excl. Vat)) \* 100
- Gross Profit Margin (value) = (Grand Total (Excl. Vat) - (Total Cost + Total Shipping Price (Incl. VAT) + Total Discount (Incl. VAT))))
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-67-2.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/7U2image-68-1.png)
#### **Sales Item Detailed Report**
It shows you the item based report with Item Price, Item Cost, Item Discount and Gross Profit Margin (%, value) and with the arranged data, you can immediately change the strategies for the better sales. You can see the report at **Admin > Reports > Advanced Reports > Sales Item Detailed Report.**
#### The grid will have following columns:
- Increment Id - Order number
- Store - Store name
- Status - Status of the order, pending/processing/complete/closed
- Order date
- Customer Name
- Billing Country
- Billing Postcode
- Billing Currency
- Base Currency
- Payment Method
- Sku
- Item Name
- Item Qty
- Item Price (Excl. Vat) - Billing Currency
- Item Price (Incl. Vat) - Billing Currency
- Item Price (Excl. Vat) - Base Currency
- Item Price (Incl. Vat) - Base Currency
- Item Discount - Billing Currency
- Item Discount - Base Currency
- Item Total Cost - Base Currency
- Item VAT - Billing Currency
- Item VAT - Base Currency
- Item Total (Excl. Vat) - Billing Currency
- Item Total (Incl. Vat) - Billing Currency
- Item Total (Excl. Vat) - Base Currency
- Item Total (Incl. Vat) - Base Currency
- Gross Profit Margin (%) = )=((Item Price Excl. Vat) - (Item Cost + Item Discount (Incl. Vat))) \* Item Qty / Item Price (Excl. Vat)\*Item Qty) \* 100
- Gross Profit Margin (value) = (Item Price (Excl. Vat) - (Item Cost + Item Discount (Incl. Vat))) \* Item Qty
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/KKMimage-69-1.png)
#### **Sales Summary Report**
You can see the summary report at **Admin > Reports>Advanced Reports > Sales Summary Report.** Based on date selection you can see the overall order based report with Grand Total and Gross Profit Margin (%, value).
#### The grid will have following columns:
- Period - It will be Day/Month/Year as a period based on "From" and "To" date selection.
- Store - Store name
- Number of orders - Total number of orders based on filter and date selection
- Ordered Items - Total number of ordered items during the selected period
- Total VAT - Total VAT of all orders
- Total Shipping Price (Incl. VAT) - Billing Currency
- Total Shipping Price (Excl. VAT) - Billing Currency
- Total Shipping Price (Incl. VAT) - Base Currency
- Total Shipping Price (Excl. VAT) - Base Currency
- Total Discount - Billing Currency
- Total Discount - Base Currency
- Total Cost
- Grand Total Ordered (Excl. VAT) - Billing Currency
- Grand Total Ordered (Incl. VAT) - Billing Currency
- Grand Total Ordered (Excl. VAT) - Base Currency
- Grand Total Ordered (Incl. VAT) - Base Currency
- Grand Total Invoiced (Excl. VAT) - Billing Currency
- Grand Total Invoiced (Incl. VAT) - Billing Currency
- Grand Total Invoiced (Incl. VAT) - Base Currency
- Grand Total Refunded (Excl. VAT) - Billing Currency
- Grand Total Refunded (Incl. VAT) - Billing Currency
- Grand Total Refunded (Excl. VAT) - Base Currency
- Grand Total Refunded (Incl. VAT) - Base Currency
- Gross Profit Margin (%) = (((Grand Total (Invoiced (Incl. VAT)) - Grand Total (Refunded (Incl. VAT))) - (Total Cost + Total Shipping Price (Incl. VAT) + Total Discount (Incl. VAT))) / (Grand Total (Invoiced (Incl. VAT))) \* 100
- Gross Profit Margin (value) = (((Grand Total (Invoiced (Incl. VAT)) - Grand Total (Refunded (Incl. VAT))) - (Total Cost + Total Shipping Price (Incl. VAT) + Total Discount (Incl. VAT)))
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/hNEimage-70-1.png)
If you have a question related to this extension please check out our [**FAQ Section** ](https://www.scommerce-mage.com/magento-2-advanced-reporting.html#customfaq)first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Product Packs & Bulk Quantity Sync
### Installation and User Guide for Magento 2 Product Packs & Bulk Quantity Sync
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Download Extension*
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Bundle Items*](#bkmrk-configuration-settin)
- *General Settings*
3. [*Workflow*](#bkmrk-workflow)
4. [*Setting Up Bundle Items Association*](#bkmrk-setting-up-bundle-it)
- *Associating Bundle Items & Defining Quantities*
- *Updating or Removing Bundle Associations*
5. [*Inventory Automation*](#bkmrk-inventory-automation)
- *On Purchase*
- *On Refund*
- *Out-of-Stock Handling*
6. *[What Customers See](#bkmrk-what-customers-see)*
7. [*Bulk Import & Export*](#bkmrk-bulk-import-%26-export)
- *Bulk Import*
- *Bulk Export*
### Installation [](#bkmrk-)
- **Download Extension:** Once you have placed the order from our site then go to Account section and click on My Downloadable Products and download the extension package.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-07/image-84-1.png)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Magento 2 Product Packs & Bulk Quantity Sync[](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Bundle Items**
#### General Settings [](#bkmrk--2)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-07/image-2025-07-31t164813-407.png)
### Workflow [](#bkmrk--3)
The **Magento 2 Bundle Items Inventory** extension allows store administrators to associate any number of component products with simple items in their catalogue—each with a precise quantity. This setup enables inventory deduction and restoration for both main and associated (bundle) items during purchases and refunds, streamlining complex product management and keeping total inventory accurate.
### **Setting Up Bundle Item Associations** [](#bkmrk--7)
#### **Associating Bundle Items & Defining Quantities**
1. **Navigate to Products:**
`Catalog > Products` in your Magento Admin.
2. **Edit a Simple Product:**
Open the product you want to add bundle items to (e.g., "Deluxe Gift Set").
3. **Find the 'Bundle Items' Tab:**
(This extension will add a new tab or section named **Bundle Items**)
4. **Add Bundle Items:**
- Click **'Add Bundle Item'**.
- Use the search/picker to select products you'd like to include (e.g., "Gift Box", "Greeting Card", "Ribbon").
- Enter the number of each item required per unit (e.g., 1 ribbon per gift set, 2 cards per set).
5. **Save** the main product to commit changes.
**Example:**
If "Family Baking Kit" requires 1 rolling pin, 2 spatulas, and 3 mixing bowls per kit, add each as a bundle item and specify quantities accordingly.
#### **Updating or Removing Bundle Associations**
- **To change quantities:** Edit the relevant field next to each bundle item.
- **To remove an item:** Use the remove/delete option within the grid.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-07/image-2025-07-31t164933-254.png)
### **Inventory Automation** [](#bkmrk--7)
#### **On Purchase**
When an order containing the main product is placed:
- The main product stock decreases by the quantity purchased.
- Each bundle item's stock decreases based on the quantity defined per main product **×** number of mains sold.
**Example:**
Purchasing 4 "Spa Kits" (each requires 2 candles and 1 bottle of oil):
- Main product: 4 deducted
- Candles: 8 deducted (4 × 2)
- Oil bottles: 4 deducted (4 × 1)
#### **On Refund**
When an order for the main product is refunded:
- The main product stock increases by the quantity refunded.
- Each bundle item's stock increases based on the refund quantity and their association.
**Example:**
Refund 2 "Family Baking Kits":
- Main product: +2
- Rolling pins: +2
- Spatulas: +4 (2 × 2)
- Mixing bowls: +6 (2 × 3)
#### **Out-of-Stock Handling**
By default, the main product can be purchased even if bundle items are out of stock.
(*Future versions will allow configuration to prevent purchase if bundle items are unavailable.*)
### **What Customers See** [](#bkmrk--7)
On the main product's page, your customers will see all associated bundle items and the quantities per unit (e.g. "Includes: 2 Candles, 1 Essential Oil Bottle per kit").
### **Bulk Import & Export** [](#bkmrk--7)
#### **Bulk Import**
1. **Prepare a CSV File:** Each row should include:
- Main Product SKU
- Bundle Item SKU
- Quantity per main product
2. **Go to:**
`System > Data Transfer > Import`
3. **Choose Entity Type:**
"Bundle Item Associations"
4. **Upload and Import:**
- The system validates:
- All SKUs exist
- Quantities are whole numbers
- No duplicate relationships are present
- Errors will appear with guidance to fix.
### **Sample CSV Format**
| main\_product\_sku | bundle\_item\_sku | quantity\_per\_unit |
|---|
| spa-kit | candle | 2 |
| spa-kit | oil-bottle | 1 |
| baking-kit | spatula | 2 |
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-07/image-2025-07-31t165218-847.png)
#### **Bulk Export**
1. **Go to:**
`System > Data Transfer > Export`
2. **Choose "Bundle Item Associations" as entity.**
3. **Download the CSV:**
The export will show:
- Each main SKU
- Associated bundle SKUs
- Quantities for each link
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-07/image.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-bundle-items-inventory.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Affiliate Program
### Installation and User Guide for Magento 2 Affiliate Program
****Table of Contents****
1. [**Installation**](#bkmrk-installation)
- **Download Extension**
- **Installation via app/code**
- **Installation via Composer**
2. **Configuration Settings for Affiliate**
- **General Settings**
3. **Workflow**
4. **Setting Up Bundle Items Association**
- **Associating Bundle Items & Defining Quantities**
- **Updating or Removing Bundle Associations**
5. **Inventory Automation**
- **On Purchase**
- **On Refund**
- **Out-of-Stock Handling**
6. **What Customers See**
7. **Bulk Import & Export**
- **Bulk Import**
- **Bulk Export**
### Installation
- ****Download Extension:**** Once you have placed the order from our site then go to Account section and click on My Downloadable Products and download the extension package.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-07/image-84-1.png)
- ****Installation via app/code:**** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- ****Installation via Composer:**** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Affiliate Program
Go to ****Admin > Stores > Configuration > Scommerce Configuration > Security Base****
#### General Settings
- ****Enabled –**** Select "Yes" or "No" to enable or disable the module.
- ****License Key –**** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- ****Select Commission Rates**** ****–**** Select commission rate type Fixed/Tier
- ****Fixed**** ****–**** In case commission tier is "Fixed" then enter the commission percentage.
- ****Tier**** ****–**** Define different tiers and their commission percentage
- Min value of purchase
- Max value of purchase
- Commission (Percentage)
- Action:- Delete
- ****Terms and conditions**** ****–**** Set "Yes" to display Terms and Conditions on the affiliate program page on the frontend.
- ****Terms and conditions enabled by default –**** Set "Yes" to enable Terms and Conditions by default
- ****Checkbox text –**** Enter the text for Terms and Conditions Checkbox
- ****Terms and Conditions Title –**** Enter the title for Terms and Conditions
- ****Terms and Conditions Page –**** Select the page to be used to display Terms and Conditions
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/sett1.png)
#### Payout Settings
- ****Methods –**** Select payment methods to be used for making payouts for affiliates
- ****Default Method –**** Select the payment method/payout method to make payout automatically via cron
- ****Threshold –**** Enter the minimum amount required to make payouts.
- ****Schedule –**** Select Manual/weekly/monthly, when "Manual" is selected payouts need to be done manually by admin and in case "weekly/monthly" is selected payout will be made automatically using CRON in 7 or 30 days.
- ****Email From –**** Enter the email address to send payout notification
- ****Email Template –**** Select the email template used to notify affiliates when a payout has been processed.
- ****Order Status –**** Select order statuses to qualify for payout.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/sett2.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/sett3.png)
#### Share Settings
- ****Enable share in socials –**** Enable or disable social media links to share the affiliate link.
- ****Socials –**** Select different social media channels to appear on frontend, by clicking on these users can share their affiliate link on these platforms
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/sett4.png)
### Workflow
The extension empowers Magento 2 stores with a robust affiliate program, enabling customers to promote your products in exchange for commissions and allowing admins to efficiently monitor, pay, and manage program performance.
### For Customers: Join and Use the Affiliate Program
#### Affiliate Registration
- Go to ****My Account > Affiliate Program**** after logging in.
- Review the affiliate program description and ****Terms and Conditions****.
- Accept the Terms by checking the box; the box text and content depend on admin configuration.
- Click ****"Join Program"****. Once enrolled, you’ll see your unique referral link.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/front1.png)
#### Referral Links
- Your referral link is displayed prominently.
- Use ****Copy**** to quickly copy it to your clipboard.
- Use ****Share**** to distribute via Facebook, Twitter, Reddit, or Instagram with one click.
- You can now share this link anywhere. Anyone using your link is tracked for commission.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/front2.png)
#### Affiliate Dashboard
- In ****My Account > Affiliate History****, view:
- ****Increment ID****
- ****Order Amount****
- ****Expected Payout****
- ****Payout Status****
- ****Order Date****
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/reffrered-orders.png)
### For Admins: Managing the Affiliate Program
#### Affiliate Dashboard
- Navigate to ****Marketing > Affiliates**** in the admin panel.
- The dashboard grid lists for each affiliate:
- Customer ID, Name, Email
- Total Orders, Sales Amount, Commissions (pending/paid)
- ****Action:****
- Make Payout
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/eIFaff-table.png)
### Referred Orders Overview (Admin)
- Examine which orders were generated by each affiliate from the dashboard.
- View and validate predicted commissions, manage disputes or issues.
#### Payout Management
- View a list of affiliates eligible for payouts:
- Payouts are only due for orders with approved statuses (e.g., Complete, Shipped).
- Set ****minimum payout threshold**** and ****payout schedule**** (weekly, monthly, manual).
- ****Payout Processing:****
- Select payout method (Bank Transfer or PayPal).
- Mark payouts as “Paid”–affiliate’s balance resets to 0.
- All payouts and payment history are tracked for each affiliate.
- Affiliates receive email notification templates you configure.
- ****Refunds and Cancelations:****
- If an order is refunded or canceled after commission has been paid, commission is deducted or reversed automatically.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/mak-payout.png)
#### Multi-tier Commission Structure
- Enable/Disable tiered commission system from ****Affiliate Settings****.
- Configure slabs and rates, e.g.:
- £1–£999.99: 10% commission
- £1,000–£1,999.99: 15% commission
- £2,000+: 20% commission
---
### Order & Affiliate Tracking
#### How Order Attribution Works
- When a prospect clicks your referral link:
- A browser cookie stores your affiliate ID for 30 days.
- Any purchase in that period is attributed to you.
- After 30 days or if no link is used, no commission is awarded.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/K3uimage.png)
#### Cookie Lifecycle
- ****Creation:**** On link click.
- ****Active period:**** 30 days from last click.
- ****Expiry:**** After 30 days.
If you have a question related to this extension please check out our [FAQ Section](https://www.scommerce-mage.com/magento-2-affiliate-program.html#customfaq) first. If you can't find the answer you are looking for then please contact [****support@scommerce-mage.com****](mailto:support@scommerce-mage.com)****.****
# Magento 2 Distance Based Shipping
### Installation and User Guide for Magento 2 Distance Based Shipping Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Distance Based Shipping*](#bkmrk-configuration-settin)
- *Order Tags Logs*
- *Order Tags Grid*
- *General Settings*
3. [*Shipping Cost*](#bkmrk-shipping-cost)
4. [*Pick Store / Website Address from*](#bkmrk-pick-store-website-address-from)
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Distance Based Shipping
Go to **Admin > Stores > Configuration > Sales> Delivery Methods > Distance Based Shipping**
#### General Settings
- **Enabled Shipping Method –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **Title -** Please enter the Title of Distance based Shipping.
- **Method Name -** Please enter the Method name of Distance based Shipping.
- **Shipping Cost -** The range is defined as: greater than or equal to "Distance From" and less than "Distance To".
- **Ship to Applicable Countries -** Select the applicable shipping destination(s).
- **Show Method if Not Applicable -** Select “Yes” or “No” to display the method when it is not applicable
- **Displayed Error Message -** Please enter the error message to be displayed
- **Sort Order -** Please enter the Sort order
- **Google Maps Api key -** Use a secure API key provided by Google to authenticate distance calculation requests via the Distance Matrix API.
- **Distance Unit -** Select whether to compare distances in miles or kilometers.
- **Pick Store / Website Address From -** **Select the method for sourcing the store address:**
- **Website Source**: Uses the address defined in the MSI configuration. *(Visible only when MSI is enabled.)*
- **General → Store Information**: Pulls the address from the store’s configuration settings.
- **Enter Address Manually**: Allows the admin to input latitude and longitude directly.
- **Enabled Debug -** Select “Yes” to enable debug mode, or “No” to disable it.
- **Filter Methods by Distance -** Select “Yes” to enable distance-based filtering, or “No” to disable it
- **Distance Threshold -** Please add the Distance Threshold.
- **Shipping Methods -** Select the shipping methods to hide when the store-to-customer distance exceeds the defined threshold.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/iDHimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/EIBimage.png)
#### Shipping Cost
Go to **Admin> Stores > Sales > Delivery Methods > Distance Based Shipping**
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/Jyfimage.png)
### **Shipping Method Configuration**
- **Enable this Method (Yes / No)**
- Turns this specific shipping method on or off within the distance-based filter.
- When set to **Yes**, the related configuration fields below become active.
- **Shipping Title**
- The user-friendly name shown to customers during checkout (e.g., "Standard Delivery").
- Helps customers differentiate between multiple shipping options.
- **Shipping Method Name**
- An internal name used for programmatic reference, logging, and in the admin panel.
- Not typically visible to customers.
- **Shipping Cost**
- The cost applied to this shipping method.
- Its calculation depends on the **Type** field (see below):
- Can be a fixed value (e.g., `5.99`).
- Or a percentage of the cart's subtotal (e.g., `5` for 5%).
- **Distance From**
- The **minimum** distance (in miles or kilometers) from the store for this method to be available.
- Defines the start of the valid range.
- **Distance To**
- The **maximum** distance (in miles or kilometers) from the store for this method to be available.
- Defines the end of the valid range.
- **Type**
- Determines how the **Shipping Cost** is calculated.
- **Fixed:** Applies the cost as a flat fee.
- **Percentage:** Calculates the cost as a percentage of the order's subtotal.
- **Show Method if Not Applicable (Yes / No)**
- **Yes:** The method will be displayed even if the customer is outside the distance range, but will show an error message.
- **No:** The method will be completely hidden if the customer is outside the distance range.
- **Displayed Error Message**
- The custom message shown to customers when "Show Method if Not Applicable" is set to **Yes** and they are outside the valid distance range.
- Example: "This shipping method is not available for your location."
- **Ship to Applicable Countries**
- Defines the geographical availability of the method:
- **All Allowed Countries:** Available to all countries your store ships to.
- **Specific Countries:** Limits the method to a selected list of countries.
- **Ship to Specific Countries**
- A multi-select list to choose which countries this shipping method is available to.
- This field only appears if "Ship to Applicable Countries" is set to **Specific Countries**.
- **Sort Order**
- A number that determines the order in which this method appears in the checkout list compared to other methods.
- Lower numbers (e.g., 0, 1) are displayed first.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/ugcimage.png)
When a customer enters an address on the checkout page, the system calculates delivery cost based on the distance from the origin address and the distance ranges configured are as follows: -
- **Zone 1: 0–10 km**: Delivery cost is 2
- **Zone 2: 11–20 km**: Delivery cost is 10
- **Zone 3: 21–90 km**: Delivery cost is 10
Refer to the screenshot below to validate the shipping methods based on calculated distance fall under the above configured distance ranges: -
### **Frontend images based on above configured distance ranges:**
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/ZvPimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/kOAimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/z0Uimage.png)
#### Pick Store / Website Address from
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/oGTimage.png)
**Website Source -** To add a website source, navigate to: **Admin > Stores > Configuration > Sources** From there, you can enter the required source details.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/Jfdimage.png)
**General - Store Information** – Displays the store address as configured in the **Store Settings** section. This information is automatically pulled from the predefined store configuration. To configure, navigate to **Admin > Stores > General > Store Information** and enter the store address. This address will be used as the source (origin) for distance-based calculations.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/ugcimage.png)
**Enter Address Manually –** Enables administrators to input geographic coordinates—**latitude** and **longitude**—directly, bypassing automated location detection or map-based selection.
To configure this manually, navigate to: **Admin > Stores > Sales > Delivery Methods > Distance-Based Shipping** From there, enter the desired latitude and longitude values. These coordinates allow Google Maps to accurately detect and associate the location for distance-based calculations.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/oIBimage.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-order-tagger.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 VAT Switcher
### Installation and User Guide for Magento 2 VAT Switcher Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for VAT Switcher*](#bkmrk-configuration-settin)
- *General Settings*
3. [*Show Price without VAT*](#bkmrk-order-tags-grid)
4. [*Show Price with VAT*](#bkmrk-show-price-with-vat)
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for VAT Switcher
Go to **Admin > Stores > Configuration > Scommerce Configuration > VAT Switcher**
#### General Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **Customer Groups -** Select a customer group from the available options. The VAT Switcher is accessible only to users who belong to customer groups with explicitly granted access.
- **Include VAT by Default -** This setting determines whether product prices are shown inclusive or exclusive of VAT by default. If set to **"Yes"**, prices will be displayed with VAT included
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-09/NKkimage.png)
#### Show Price without VAT
The **VAT switcher** is prominently displayed on all product listing and product detail pages. It is positioned within the header.
When a user selects **“Show prices without VAT”**, all product prices are dynamically updated to exclude applicable VAT.
**VAT rates** are calculated based on the customer’s **shipping address** or the store’s **default tax zone**. Displayed prices accurately reflect tax inclusion or exclusion in accordance with **Magento’s tax configuration settings**.
From the backend, **administrators** can fully manage VAT switcher behavior, including:
- Enabling or disabling the VAT switcher
- Setting the default display mode (inclusive or exclusive) per store view
- Defining which customer groups have access to the switcher
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-09/KGTimage.png)
#### Show Price with VAT
When a user selects **“Show prices with VAT”**, all product prices are recalculated to include the applicable VAT.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-09/HYRimage.png)
#### Customer Groups
You can set a customer group by going to Admin > Customers, then choosing a customer and picking a group in the 'Group' field. The available groups include: *Not Logged In*, *General*, *Wholesale*, and *Retailer*.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-09/VoQimage.png)
Customer groups that are not selected in the configuration settings will not have access to the VAT switcher option on the front end.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-09/image-2025-09-08t201313-050.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-vat-switcher.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Custom Currency Manager
### Installation and User Guide for Magento 2 Custom Currency Manager Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Custom Currency Manager*](#bkmrk-configuration-settin)
- *General Settings*
3. [*Custom Currency Manager*](#bkmrk-custom-currency-mana)
4. *[Error Message When Adding Duplicate currency in Configuration settings](#bkmrk-error-message-when-a)*
5. *[Error for Deleting Currency for Configuration settings](#bkmrk-error-for-deleting-c)*
6. *[Frontend Screenshots](#bkmrk-frontend-screenhots)*
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Custom Currency Manager
Go to **Admin > Stores > Configuration > Scommerce Configuration > Custom Currency Manager**
#### General Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **Custom Currencies -** Please add the defined list of custom currencies.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/kK6image.png)
#### **Custom Currency Manager**
As a customer using the Custom Currency Manager extension, you can create and configure various custom currencies such as BTC, ZWG, and others to suit your store's needs.
To add a Custom Currency like **BTC** add from **Configuration, path - Admin > Stores > Configuration > Custom Currency Manager**
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/TD3image.png)
Once you configure custom currencies by adding the currency code, symbol, plural name, and precision in the configuration, the newly added currency appears in the "Allowed Currencies" dropdown under Magento’s default currency setup section.
To configure your store’s currency settings, go to **Admin Panel > Stores > Configuration > General > Currency Setup**, where you can choose the base currency, default display currency, and allowed currencies. Please refer to the screenshots below for visual guidance on setting up custom currencies.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/DCIimage.png)
To configure currency rates for your store:
1. Go to **Admin Panel > Stores > Configuration > Currency Rates**.
2. From this section, you can manually set exchange rates or import them from supported services.
3. Make sure to save your changes to apply the updated rates across your storefront.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/image-2025-10-15t193428-520.png)
##### **Error Message When Adding Duplicate Currency in Configuration Settings**
Since GBP already exists in the default Magento, you cannot add it again. Attempting to do so will trigger a warning message.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/yIzimage.png)
##### **Error for Deleting Currency for configuration settings**
The '**Test**' currency has been selected in the Allowed Currency list for the UK site, Default Configuration, and Default Store View.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/G0mimage.png)
#### **Frontend Screenhots**
**Currency Options available on the frontend - Default store view.**
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/gadimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/eJUimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/mJwimage.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-custom-currency-manager.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Sample Product
### Installation and User Guide for Magento 2 Sample Product extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Sample Product*](#bkmrk-configuration-settin)
- *General Settings*
- *Sample Product Settings*
3. [*Configure a Sample Product* ](#bkmrk-configure-a-sample-p)
- *Free Sample*
- *Sample with Cost Associated*
4. [*Sample products are not Eligible for Coupon Discounts* ](#bkmrk-sample-products-are-)
- *Coupon Code Validation for Free Sample Product*
- *Coupon Code Validation for Sample with Cost Associated product*
5. [*Email Received for a Sample Product* ](#bkmrk-configure-a-sample-p)
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Sample Product
Go to **Admin > Stores > Configuration > Scommerce Configuration > Sample Product**
#### General Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-52.png)
#### Sample Product Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **Default Free Sample Text –** Please add the Default Free Sample Text
- **Default Sample with Cost Associated Text –** Please add the Default Sample with Cost Associated Text
- **Default Sample Price with Cost Associated -** Please add the Default simple price with cost associated
- **Default Max Qty to order samples -** Please add the Default max qty to order samples
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/image.png)
### **Configure a Sample product**
- #### **Free Sample**
Log in to the Admin Panel and navigate to **Catalog → Products**. Select the product you want to edit and click **Edit**. Scroll down to the **Sample Product** section and choose **Free Sample** from the **Sample Type** dropdown.
**1. When the fields are empty**
If all fields are left blank, the system will use the default configuration values.
On the frontend product page:
- The default quantity of **3** is applied, allowing the item to be added to the cart.
- The label **Free Sample** is displayed (e.g., for product *24‑WB07*).
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/Cnoimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/t4oimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/3s1image.png)
**2. When the fields have values set**
If any fields in the **Sample Product** section contain values, those product‑level values override the defaults and are used on the frontend.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/iapimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/xOVimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/uZSimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/tFcimage.png)
- #### **Sample with Cost Associated**
Log in to the Admin Panel and go to **Catalog → Products**. Open the product you want to update by clicking **Edit**. Scroll down to the **Sample Product** section.
From the **Sample Type** dropdown, select **Sample with Cost Associated**.
- If you leave all fields empty, the system will automatically use the default price, title, and quantity from the configuration settings.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/PQCimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/t4oimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/8Czimage.png)
- If you enter values in these fields, the system will use the product‑level values set in the **Sample Products** section instead.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/wEiimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/3arimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/AoBimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/8tfimage.png)
### **Sample Products are not Eligible for Coupon Discounts**
- #### **Coupon Code Validation for Free Sample Product**
Log in to the Admin Panel and go to **Marketing → Cart Price Rules**. Create a new coupon code, for example **“testcode”**. When you apply this coupon on the frontend for the sample products, it should display a validation error, even if the code itself is valid, because coupon codes are **not meant to work for sample products**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/QlEimage.png)**
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/Oehimage.png)
- #### **Coupon Code Validation for Sample with Cost Associated product**
We’ve created a coupon code called **“testcode”** in the Admin Panel. This code works normally for regular products, but it **won’t apply to the Sample product (e.g. 24‑WB07)**. When a customer tries to use the coupon code for the sample products, the system will show a validation message saying the code isn’t valid.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/QlEimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/nzbimage-1.png)
### **Email Received for a Sample Product**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/microsoftteams-image-1.png)**
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-sample-products.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Barcode Scanner
### Installation and User Guide for Magento 2 Barcode Scanner extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Barcode Scanner*](#bkmrk-configuration-settin)
- *General Settings*
- *Sample Product Settings*
3. *[Configure a Sample Product](#bkmrk-configure-a-sample-p)*
4. *[Configure a Simple Product](#bkmrk-configure-a-simple-product)*
5. *[Coupon code doesn't work for a Sample product](#bkmrk-coupon-code-doesn%27t-)*
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```
php php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer
### Configuration Settings for Sample Product
Go to **Admin > Stores > Configuration > Scommerce Configuration > Sample Product**
#### General Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-52.png)
#### Barcode Scanner Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/Ivcimage.png)
- **Barcode Attribute –** Please select the Barcode attribute from the options.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/khtimage.png)
- **Order Statuses to pick –** Please select the Order Statuses from the options.
- **Change Status on Pick -** Select Yes or No to Change the status on pick.
- **Pick Order Status -** If you select Yes, then choose the Pick Order Status from the options.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/uaFimage.png)
- **Order Statuses to pack –** Please select the Order Statuses from the options.
- **Change Status on Pack -** Select Yes or No to Change the status on pack.
- **Allow Partially Picked Items -** Select Yes or No to Allow Partially Picked Items.
- **Pack Order Status -** Please select the Pack Order Status from the options.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/Rc8image.png)
- **Progressbar Color –** Please select the Color code for Progressbar
- **Progressbar Text Color –** Please select the Color code for Progressbar Text Color
- **Progress Status Color –** Please select the Color code for Progress Status Color
- **Complete Status Color –** Please select the Color code for Picking and Packing Complete Status
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-01/PUwimage.png)
### **Add a Barcode Scanner to a Product**
Log in to the Admin Panel, navigate to **Admin >Catalog > Products**, and select the product you want to edit. Click *Edit*, then scroll down to the Barcode field. Enter the value **12345678**, save the changes, and create an order for the product to which you added the Barcode (24-MB01).
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/image.png)
### **Scan Orders**
Go to **Admin > Sales > Scan Orders**. Enter the order number in the Scan Order field. The system will then display the status as Pending under Order Status, Pick Status, and Pack Status.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/o8Eimage.png)
Then go to **Admin > Sales > Orders**. Create the invoice and ship the order. Once completed, the order status will display as Complete in Scan Orders.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/iJQimage.png)
Next, enter the Barcode value **12345678** in the Scan Items field for Pick and again in the Scan Items field for Pack. Once completed, the status will update to Complete
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/h7oimage.png)
You can check the Barcode Scan Logs by navigating to **Admin > Sales > Orders > Edit > Barcode Scan Logs**. All order statuses will be shown as Success.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/Jq6image.png)
### **Configuring “Change Status on Pick” and Barcode Scanner Workflow**
When you set **“Change Status on Pick”** to Yes and configure the Picked from Pick Order Status under **Admin > Stores > Configuration > Barcode Scanner**, then place an order and click on **Scan Items for Pick**, you can enter the barcode scanner value in front of the item. The status should then update to Picked and Complete. Please refer to the screenshot below for reference.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/ERsimage.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-02/9teimage.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-sample-products.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Content Protection
### Installation and User Guide for Magento 2 Content Protection Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Content Protection*](#bkmrk-configuration-settin)
3. *[Protecting a CMS Page](#bkmrk-order-tags-grid)*
4. *[Protecting a Product Page](#bkmrk-order-tags-logs)*
5. [*Protecting a Category Page*](#bkmrk-protecting-a-categor)
6. [*Frontend - The Gate Page* ](#bkmrk-installation)
- *Gate Page Layout*
- *Entering the Password*
- *Session Unlock Behaviour*
7. [*Disabling Protection* ](#bkmrk-installation)
8. [*Technical notes for Developers* ](#bkmrk-technical-notes-for-)
- *Module Structure*
- *Database Changes*
- *Plugin Interception*
- *Admin UI Component Injection*
- *Customising the Gate Page*
- *Hyva Theme Compatibility*
- *Full-page Cache Compatibility*
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento module:enable Scommerce_ContentProtect
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
(https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Content Protection
Go to **Admin > Stores > Configuration > Scommerce Configuration > Content Protection**
#### General Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/FO1image.png)
#### Password Configuration
Go to **Admin > Stores > Configuration > Scommerce Configuration > Content Protect > Password Configuration**
- **Global Access Password –** Enter the password that visitors must provide to unlock access to any password-protected page. The password is stored using Magento's native encryption and will never appear in plain text in the database or configuration files.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-04/8Pnimage.png)
**Note:** If the Global Access Password field is left empty, the gate page will be displayed but no password will unlock it. Always ensure a password is set before enabling protection on any page.
#### Protecting a CMS Page
Go to **Admin > Content > Pages**
Open any existing CMS page or create a new one. Scroll down to find the Page Protection fieldset. Set the Password Protected toggle to Yes and save the page. The page is now gated any visitor attempting to access it without an unlocked session will be redirected to the password gate page.
- **Password Protected –** Select "Yes" to enable password protection on this CMS page. Select "No" (default) to leave the page publicly accessible.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-04/QY7image.png)
#### Protecting a Product Page
Go to **Admin > Catalog > Products**
Open any existing product or create a new one. Scroll down to find the Page Protection fieldset. Set the Password Protected toggle to Yes and save the product. Visitors attempting to access the product page without an unlocked session will be redirected to the gate page.
- **Password Protected –** Select "Yes" to enable password protection on this product page. Select "No" (default) to leave the product page publicly accessible.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-04/B1ximage.png)
**Note:** The Password Protected attribute is scoped to store view level. This means you can enable protection on a product for one store view (e.g. your trade store) while leaving it accessible on another (e.g. your retail store). Make sure you are in the correct store view scope when editing the attribute.
#### Protecting a Category Page
Go to **Admin > Catalog > Categories**
Select any category from the category tree on the left. Scroll down to find the Page Protection fieldset in the category edit form. Set the Password Protected toggle to Yes and save the category. Visitors attempting to access the category page without an unlocked session will be redirected to the gate page.
- **Password Protected –** Select "Yes" to enable password protection on this category page. Select "No" (default) to leave the category publicly accessible.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-04/kNximage.png)
**Note:** Protecting a category gates the category listing page only. Individual product pages within the category are not automatically protected — you must enable protection on each product separately if required. The attribute is scoped to store view level.
### Frontend - The Gate Page
When a visitor attempts to access any password-protected page without an active session unlock, they are automatically redirected to the ContentProtect gate page. The gate page URL is:
```
/contentprotect/page/gate?return=
```
**Restricted Page (About Us)**
```
https://demo4.scommerce-mage.co.uk/contentprotect/page/gate/return/L2Ntcy9wYWdlL3ZpZXcvcGFnZV9pZC81/
```
**Restricted Category Page (Women)**
```
https://demo4.scommerce-mage.co.uk/contentprotect/page/gate/return/L2NhdGFsb2cvY2F0ZWdvcnkvdmlldy9pZC8yMA%3D%3D/
```
**Restricated Product Page (SKU: MH01)**
```
https://demo4.scommerce-mage.co.uk/contentprotect/page/gate/return/L2NhdGFsb2cvcHJvZHVjdC92aWV3L2lkLzYy/
```
#### Gate Page Layout
The gate page uses your store's active theme layout (1-column, full width) and contains two sections:
- **Restricted Area (info block) –** Displayed at the top of the page. Contains a message informing the visitor that the content is restricted. The message text can be customised by editing view/frontend/templates/gate.phtml.
- **Enter Password to Continue (form block) –** Displayed below the info block. Contains a password input field, an Unlock button, and a Required Fields note.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-04/lRcimage.png)
#### Entering the Password
The visitor enters the global password configured in Stores Configuration Scommerce Configuration Content Protect and clicks the Unlock button.
- **Correct password –** The visitor is redirected directly to the page they originally requested not to the homepage. The return URL is preserved throughout the process.
- **Incorrect password –** The gate page is redisplayed with an error message: "Incorrect password. Please try again." The return URL parameter is retained so a correct entry on the next attempt still redirects to the original page.
- **Empty password submission –** Client-side validation prevents the form from being submitted with an empty password field.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2026-04/Ewiimage.png)
#### Session Unlock Behaviour
Once the correct password is entered, an unlock flag is set in the visitor's Magento customer session. This flag applies to the entire session the visitor can then access any passwordprotected page (CMS, product, or category) on the store without being prompted again.
- **Session duration –** The unlock flag persists for the duration of the browser session. Closing the browser or session expiry will require the visitor to enter the password again on their next visit.
- **Guest and logged-in visitors –** The session unlock works for both guest visitors and authenticated customer account holders.
- **Multiple protected pages –** A single password entry unlocks all protected pages across all page types (CMS, product, category) for that session.
### Disabling Protection
Protection can be disabled at two levels:
- **Per page –** Open the CMS page, product, or category in the admin and set the Password Protected toggle to No. Save the record. The page immediately becomes publicly accessible no cache flush required.
- **Globally (entire module) –** Go to Stores Configuration Scommerce Configuration Content Protect and set Enabled to No. This immediately disables all gate redirects across every page on the store, regardless of individual page toggle states. Your per-page settings are preserved in the database and will be restored if you re-enable the module.
**Tip:** If you need to quickly make all protected pages public — for example, on public launch day after a pre-launch review — setting Enabled to No in the global configuration is the fastest method. No individual page changes are needed.
### Technical notes for Developers
#### Module Structure
- **Vendor / Module name –** Scommerce\_ContentProtect
- **Module path –** app/code/Scommerce/ContentProtect/
- **Frontend route –** /contentprotect/page/gate and /contentprotect/page/unlock
- **Session key –** content\_protect\_unlocked (stored in Magento customer session)
#### Database Changes
The module applies the following database changes via Magento's patch system on setup:upgrade:
- **cms\_page table –** Adds is\_password\_protected column (SMALLINT, default 0) via SchemaPatchInterface DDL-safe, runs outside of a transaction.
- **catalog\_product\_entity (EAV) –** Adds is\_password\_protected attribute (int, store view scope, default 0) via DataPatchInterface.
- **catalog\_category\_entity (EAV) –** Adds is\_password\_protected attribute (int, store view scope, default 0) via DataPatchInterface.
#### Plugin Interception
Content Protect uses Magento's around plugin system to intercept the execute() method on three controllers:
- **Magento\\Cms\\Controller\\Page\\View –** Handles CMS page protection loads the page by identifier or ID and checks the is\_password\_protected flag.
- **Magento\\Catalog\\Controller\\Product\\View –** Handles product page protection loads the product by ID via ProductRepositoryInterface.
- **Magento\\Catalog\\Controller\\Category\\View –** Handles category page protection loads the category by ID via CategoryRepositoryInterface.
All three plugins are registered in etc/frontend/di.xml and apply on the frontend area only. No core files are modified.
#### Admin UI Component Injection
The Page Protection fieldset and Password Protected toggle are injected into the three admin forms via Magento's UI component merge system:
- **view/adminhtml/ui\_component/cms\_page\_form.xml –** Injects the fieldset into the CMS page edit form
- **view/adminhtml/ui\_component/product\_form.xml –** Injects the fieldset into the product edit form.
- **view/adminhtml/ui\_component/category\_form.xml –** Injects the fieldset into the category edit form.
#### Customising the Gate Page
The gate page template is located at:
```
app/code/Scommerce/ContentProtect/view/frontend/templates/gate.phtml
```
Edit this file to customise the info message text, the password form labels, or the page layout. To customise styles, edit:
```
app/code/Scommerce/ContentProtect/view/frontend/web/css/content-protect.css
```
**Note:** If you customise the template or CSS, copy the files to your active theme's directory structure rather than editing the module files directly. This ensures your customisations are not overwritten by future module updates.
#### Hyva Theme Compatibility
The backend logic plugins, session handling, configuration, and redirect is fully themeagnostic and works with any Magento 2 theme including Hyva. The gate page template (gate.phtml) uses standard Magento HTML and the module's own CSS file. For Hyva, we recommend copying gate.phtml to your Hyva theme and adapting the markup to use Tailwind utility classes to match your storefront styling. The CSS file can then be omitted as Tailwind will handle all styling.
#### Full-page Cache Compatability
ContentProtect intercepts requests at the controller plugin level, which fires before Magento's full-page cache (Varnish or built-in FPC) would serve a cached response. Protected pages that redirect to the gate page are not cached. Once a visitor's session is unlocked, the page proceeds to render normally and may be served from FPC on subsequent requests within that session.
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-order-tagger.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**