Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Installation via app/code
Installation via Composer
General Settings
General Settings
Category Canonical Tag
Product Canonical Tag
CMS Canonical Tag
Others Pages Canonical Tags
No Index No Follow
Product set up for Canonical URL
Category set up for Canonical URL
CMS set up for Canonical URL
Category Canonical Tag
Product Canonical Tag
CMS Canonical Tag
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin> Stores> Configuration> Scommerce Configuration> SEOBase
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration >Scommerce Configuration > Canonical Tags
Enable - Select “Yes” or “No” to enable or disable the module.
Category Canonical Enable – Set it to yes, if you want canonical tag on category pages.
Exclude Current Category in Admin –Set it to “Yes”, if you don’t want the same category to appear in the drop-down selection while choosing canonical category for a category.
Append Text with Every Category URL Path –Set it to yes, if you want to append text with overridden canonical URL as well. This setting is useful when you have pagination/filtered navigation/sorting on your site.
Product Canonical Enable – Set it to yes, if you want canonical tag on product pages.
CMS Canonical Enable – Set it to yes, if you want canonical tag on cms pages.
Other Page Canonical Enabled - Set it to yes, if you want canonical tag on other page.
Custom Canonical Tag Links – Add custom canonical tag links.
No Index No Follow Enabled – Set it to yes, if you want to add no index, no follow in the head section.
Action names – Add action names here to add no index, no follow in the head section for specific page. New route name needs to be added in next line.
Route names –Add route name here to add no index, no follow in the head section for list of pages.
Go to Admin > Catalog > Products > Select Product (for which you want to set Canonical URL) > Search Engine Optimization Tab
Primary Category – Select primary category to be included in the canonical URL tag.
Override Canonical URL – Enter text here to be used as canonical tag URL.
Robot Settings – Select the robot settings from dropdown.
Go to Admin > Catalog> Category > select category (for which you want to set canonical URL) > Search Engine Optimization Tab
Canonical URL – Select primary category to be included in canonical URL tag.
Override Canonical Tag – Enter text here to be used as canonical tag URL.
Robot Settings – Select the robot settings from dropdown.
Go to Admin > Content > Pages > Choose page (for which you want to set canonical URL) > Search Engine Optimization Tab
Override Canonical URL – Enter text here to be used as canonical tag URL.
Robot Settings – Select the robot settings from dropdown.
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Category Canonical Tag - You can enable canonical tag on the category page from Admin> Stores > Configuration > Scommerce Configuration > Canonical Tags > Category Canonical Enable - Select "Yes".
Product Canonical Tag - To add canonical tag on the product page, go to Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags > Product Canonical Enable - Select "Yes"
CMS Canonical Tag - You can add canonical tag on any page from Admin> Stores > Configuration >Scommerce Configuration > Canonical Tags >CMS Canonical Enable - Select "Yes".
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 .
Other Pages Canonical Tags- You can add canonical tag on the CMS pages from Admin> Stores > Configuration >Scommerce Configuration > Canonical Tags > Other Page Canonical Enabled "Yes" and under Custom Canonical Tag Links click on add and add the full route name of the page for eg:- when visiting the checkout page your URL will look something like Here “contact” is your full route name. Lastly, enter the Canonical tag link that you want to send with the URL.
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Minify HTML
Javascript Settings
CSS Settings
General Settings
Lazy Loading on the Homepage
Home Page Excluded from Lazy Loading
Lazy Loading on the Category Page
Lazy Loading on the Search Page
Lazy Loading on the Cart Page
General Settings
Compress/Optimize Product Image
Compress/Optimize Category Image.
Compress/Optimize CMS Image
General Settings
Cron Settings
Regenerate
Category Page
Product Page
CMS Page
Cache Hit for the category page after the execution of category page command
Cache Miss for the Category Page
Home Page Mobile
Home Page Desktop
Category Page Mobile
Category Page Desktop
Product Page Mobile
Product Page Desktop
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Speed Optimiser
Enabled - Select “Yes” or “No” to enable or disable the module.
Enabled - Select “Yes” or “No” to enable or disable the module. If set to “Yes” then the module will remove all the unnecessary comments, line breaks, tabs and spaces from your HTML to reduce its size.
Defer Iframes – Select “Yes” or “No”. If set to “Yes” then attribute defer will be added to the iframe.
Select “Yes” to enable the Defer Iframes
Merge Javascript Files – Select “Yes” or “No”. If set to “Yes” then it will merge all JS files into one to reduce the number of queries.
Enable Javascript Bundling – Select “Yes” or “No”. If set to “Yes” then it will combine all JS files into few bundles and download them for each page. This will save time by reducing the number of server requests.
Javascript Files Minification – Please select “Yes” or “No”. If set to “Yes” then the module will remove all the unnecessary comments, line breaks, tabs and spaces from your Java Script to reduce its size.
Merge CSS Files – Select “Yes/No”. If set to “Yes” then it will merge all CSS files into one to reduce the number of queries.
Defer Fonts Loading – Select “Yes/No”. If set to “Yes” then browser will load the page with system fonts and replace them with your fonts when they are loaded. It makes store pages load faster.
Fonts Display Swap – Select “Yes/No”. If set to “Yes” then font-display will be replaced with swap. Helps avoid Luma-Icons issue.
CSS Files Minification – Select “Yes” or “No”. If set to “Yes” then the module will remove all the unnecessary comments, line breaks, tabs and spaces from your CSS to reduce its size.
Go to Admin > Stores > Configuration > Scommerce Configuration > Lazy Loading
Enabled - Select “Yes” or “No” to enable or disable the module.
Preload Images – Select “Yes” to preload the images.
Loading Icon – Show a preview image before the real image loads.
Skip Images Count by page category – Enter a valid image count to skip the images from lazy load. Based on the count this option will decide how many images to load without lazy loading.
Ignore Images that Contain – Provide a part of an image tag content into the field to exclude the image from the lazy load.
Exclude Pages – Select the page(s) from multi-select options to exclude from the lazy load.
Lazy Loading on the Homepage – Enable the module to implement lazy loading on the homepage, here is the configuration path Admin > Stores > Configuration > Lazy Loading- Enable "Yes". In the below screen grab you can see the product "Radiant Tee" with lazy loading.
Home Page Excluded from Lazy Loading – There is an option " Exclude Pages" available in the backend, from where you can select the page to exclude from the lazy loading.
Lazy Loading on the Category Page – Enable the module to implement the lazy loading on the category page Admin > Stores > Configuration > Lazy Loading - Enable "Yes".
Lazy Loading on the Search Page – There is an option available in the configuration settings at Admin > Stores > Configuration > Lazy Loading- Enable and by selecting "Yes" or "No" you can enable or disable the lazy loading on the search page.
Lazy Loading on the Cart Page – You can implement lazy loading on the cart page by by enabling the module from the back-end configuration Admin > Stores > Configuration > Lazy Loading- Enable "Yes".
Go to Admin > Stores > Configuration > Scommerce Configuration > Image Optimizer
Enabled - Select “Yes” or “No” to enable or disable the module.
Compress Images while uploading - Select available options to enable compression for new images uploaded via Magento admin. We recommend this to be enabled because all the new things will be compressed straight away.
Number of images to processed – Define how many number of images you want to process when the cron job runs. Please note this number should be reasonable especially when you have multiple stores and many additional product images.
Minimum image size required after optimisation -
Include folders – Please select list of folders you want to include for compressing the image.
Compress Cached Product Images (Yes/No) – Select “Yes” to compress cached product images generated by Magento. We could recommend to leave this setting turned off especially when you clear your cached images frequently and you have more than 5 additional images on the product page.
API Key – Please enter API Key (if provider is kraken.io).
API Secret Key – This will be required for certain providers like kraken.io
Exclude folders – Please enter the list of folders you want to exclude from media directory (comma separated) for example foldername1, foldername2, /foldername /subfolder1, foldername/subfolder2
Backup Images (Yes/No) – Select “Yes” to enable this feature to backup original images before compressing original file.
Debugging (Yes/No) – Select “Yes” to enable debugging. This will write logs in var – log – imageoptimize.log
Image Optimiser Schedule – Please define the Cron frequency to optimize images.
Compress/Optimize Product Image - You can compress product images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "Product ".
Compress/Optimize Category Image - You can compress category images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "Category ".
Compress/Optimize CMS Image - You can compress CMS images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "CMS ".
Go to Admin > Stores > Configuration > Scommerce Configuration > Cache Warmer
Enabled - Select “Yes” or “No” to enable or disable the module
Regenerate cache after page update - Please select "Yes" or "No" to regenerate cache for updated page.
Select Page - Please select the page(s) from the multi-select option. This will regenerate the cache selected page(s) on page update.
Can Regenerate Cache Manually - Please select " Yes" or "No". If set to "Yes" then you can regenerate cache manually from cache warmer grid.
Generate Log - Select "Yes" to generate the log.
Cache Cron Schedule - Schedule cron job to regenerate the cache for all non cached page(s).
Number of Concurrent Regeneration request - Please define the number of concurrent request.
When you enable the module and set General Settings > Can Regenerate Cache Manually > to "Yes" then it adds an additional option "Regenerate" under the "Actions ->Select" drop-down at Admin > System > Cache Warmer > Actions. This grid will have Id, Page URL, Page Type - (Home, Product, Category, CMS), Status - (Cached/Un-cached), Last Cached - (Date, Time), and Action- (Regenerate, Delete).
Regenerate - It regenerates cache manually for Category/Product/CMS pages. By clicking on the "Regenerate" action you can regenerate cache manually for a specific URL.
You can regenerate cache for Product/Category/CMS page(s) by running the following console commands: -
Category Page - If you want to regenerate cache for the category page then run this command scommerce:cachewarmer:category
Product Page - To regenerate cache for the product page(s), use this command scommerce:cachewarmer:product
CMS Page - To regenerate cache for CMS page please use this command scommerce:cachewarmer:cmspage
Cache Hit for the category page after the execution of category page command - When you run the command for category then it regenerates the cache. On the front-end you can debug the cache and check the status "Hit" or "Miss" using browser tool (Inspect element) under Network > Select Page URL > Header > Cache Debug: HIT
Cache Miss for the Category Page - Flush the cache by executing the command (c:f) and then check cache using browser tool .
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Table of Contents
Installation via app/code
Installation via Composer
Installation via Composer(Hyvä Theme)
General Settings
Cross Links Grid
Add New Cross Link.
Build External Link to Any Website
Alert Message for Inactive Product / Category
Cross Link on Category Page
Category Page Cross Link Redirecting on External Link
Cross Link on Product Page
Product Page Cross Link Redirecting on Internal Link
Cross Link on CMS Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Installation via Composer(Hyvä Theme): Go to My Account section then go to Composer Instructions. Run the composer config commands mentioned on the page then run the below command to install the module on hyva theme.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Cross Linking
Enabled – Select “Yes” or “No” to enable or disable the module.
Product Page Replacement Limit – Please define the replacement limit per product page. It determines how many keywords will be replaced on the given page.
Category Page Replacement Limit – Please define the replacement limit per category page. It determines how many keywords will be replaced on the given page.
CMS Page Replacement Limit – Please define the CMS page replacement limit. It determines how many keywords will be replaced on the given page.
Product Attributes for Replacement – Please select the product attributes where text will be replaced with link on product pages.
Category Attribute for Replacement – Please select the category attributes where text will be replaced with link on category page.
Cross Links Grid - You can manage and create new cross links from Admin > Marketing > SEO Cross Linking > Cross Links. This grid will have ID, Title, Status, Store View, Target, Replacement Limit, Priority, Nofollow, Action.
Add New Cross Link - To add new cross link, go to Admin > Marketing > SEO Cross Linking > Cross Links > Click on "Add New Link" button. It redirects on "Add New Cross Link" page and by providing all the general information you can create a new cross link.
This will have following general information:-
Active - Dropdown with 'YES' or 'NO' options
Link Title - Title of the link
Link Target - Dropdown with options self or blank
Keywords - Keywords can be entered with line breaks and wildcard % anywhere with the keyword for example %phone% (iPhone7)
Store View - Multi-select with options All Store Views, Default Store View
Reference - Dropdown with options, Product ID, Category ID or Custom Url
Reference Resource - This will show either category tree or product grid with filters or css grid with filters to choose category or product ID
Priority - Priority to be given to the link which has highest priority first in case the replacement is lower number
Replacement limit - Limit the number of links per page
No Follow - This will add follow or nofollow with the link on frontend
Build External Link to Any Website - You can set external link to any website from Admin > Marketing > SEO Cross Linking > Cross Links >Reference - Custom Url > Custom Url - Provide External Link.
Alert Message for Inactive Product / Category - It shows an alert / warning message when you disable the category or product from Admin > Catalog > Category / Product > Select Category / Product > Disable > Save.
Alert Message for Inactive Category
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Cross Link on Category Page - You can define the replacement limit for category page from Admin > Stores > Configuration > Scommerce Configuration > Cross Linking > Category Page Replacement Limit - 1. It determines how many keywords will be replaced on the given page and to define cross link, go to Admin > Marketing > SEO Cross Linking > Cross Links > Select Link > Replacement Limit -1.
Category Page Cross Link Redirecting on External Link - Click on the cross link "Luma" will redirect to external link.
Cross Link on Product Page - You can define replacement limit for cross link from Admin > Marketing > SEO Cross Linking > Cross Links > Select Link > Replacement Limit - 2. Individual Cross link limit determines how many times the link will be replaced on the given page.
Product Page Cross Link Redirecting on Internal Link - Click on the cross link "Duffle" will redirect to defined internal link.
Cross Link on CMS Page - You can set replacement limit for cross link from Admin > Marketing > SEO Cross Linking > Cross Links > Select Link > Replacement Limit - 1. Individual Cross link limit determines how many times the link will be replaced on the given page.
Welcome to the Scommerce Mage User Guide for Magento 2 Extensions
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Exclude Categories from Sitemap
Exclude Products from Sitemap
Exclude CMS Pages from Sitemap
How to Generate Sitemap
Add new Sitemap
Magento Out of the Box Functionality to set the Category Path
Product Link in Sitemap XML
Category Link in Sitemap XML
CMS Pages Link in Sitemap XML
General Settings
Configuration Path to Set Up Primary Category
Product Page Unique URL
General Settings
Category Canonical Tag
Product Canonical Tag
CMS Canonical Tag
No Index No Follow
Product Setup for Canonical URL
Category Setup for Canonical URL
CMS Setup for Canonical URL
Canonical Tag on the Category Page
Canonical Tag on the Product Page
Canonical Tag on the CMS Page
General Settings
Rich Snippets General Settings
Twitter Card Settings
Facebook Open Graph Settings
Facebook Open Graph Settings
Pinterest Rich Pins Settings
Home Page Markup Code
Category Page Markup Code
Product Page Markup Code
Twitter, Facebook Open Graph Social Sharing Code
Twitter Card
Facebook Open Graph
Increased and Optimized Page Ranking in Search Results
General Settings
Language and Country Settings
Hreflang Tag on the Home Page
Hreflang Tag on the Category Page
Hreflang Tag on the Product Page
Hreflang Tag on the CMS Page
Cross Links Grid
Add New Cross Link.
Build External Link to Any Website
Alert Message for Inactive Product / Category
Cross Link on Category Page
Category Page Cross Link Redirecting on External Link
Cross Link on Product Page
Product Page Cross Link Redirecting on Internal Link
Cross Link on CMS Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Base
Enabled - Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Sitemap
Enable - Select “Yes” or “No” to enable or disable the module.
Exclude Categories from Sitemap – To include or exclude categories, go to Admin > Catalog > Manage Categories > Select category (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”
Exclude Products from Sitemap – To exclude products from sitemap, go to Admin > Catalog > Manage Products > Select product (you want to exclude from sitemap) > General > Exclude from Sitemap: Set to ”Yes/No”.
Exclude CMS Pages from Sitemap – To exclude CMS pages from sitemap, go to Admin > CMS > Pages > Select CMS Page (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”
How to Generate Sitemap – To generate the site map from the admin panel go to, Admin > Marketing > Sitemap > Click ''Generate Sitemap''.
Add new Sitemap - You can create new site map from, Admin > Marketing > Sitemap > Click ''Add Sitemap'', it redirects to New Site Map page and by providing all the required details you can create Site Map.
Magento Out of the Box Functionality to set the Category Path - To include category path in product URLs in sitemap.xml, go to Admin > System > Configuration > Catalog > Catalog > Search Engine Optimizations > Use Categories Path for Product URLs: Set to "yes".
Google site map shows all the included Products, Categories, and CMS Pages links in the sitemap.xml.
Category Link in Sitemap XML - You can see the category link in the Google Sitemap XML.
CMS Pages Link in Sitemap XML - In the below screen grab you can see the about-us page link in the Google Sitemap XML.
Product Link in Sitemap XML - You can see the product link in the Google Sitemap XML.
Go to Admin > Stores > Configuration > Scommerce Configuration > Catalog URL
Enabled - Select “Yes” or “No” to enable or disable the module.
Exclude Root Categories – Exclude some root categories to appear as primary category dropdown against products.
Go to Admin > Catalog > Select Product > Search Engine Optimization > Primary Category . The drop down will show all the categories selected for the product from where you can select the primary category of the product.
Product Page Unique URL - You can assign primary category to any product from Admin > Catalog > Select Product > Search Engine Optimization > Primary Category. In the below image you can see the assigned category of product Rival Field Messenger is "Gear->Bags".
Go to Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags
Enable - Select “Yes” or “No” to enable or disable the module.
Category Canonical Enable – Set it to yes, if you want canonical tag on category pages.
Exclude Current Category in Admin – Set it to “Yes”, if you don’t want the same category to appear in the drop-down selection while choosing canonical category for a category.
Append Text with Every Category URL Path – Set it to yes, if you want to append text with overridden canonical url as well. This setting is useful when you have pagination/filtered navigation/sorting on your site.
Product Canonical Enable – Set it to yes, if you want canonical tag on product pages.
CMS Canonical Enable – Set it to "yes", if you want canonical tag on CMS pages.
No Index No Follow Enabled – Set it to yes, if you want to add no index, no follow in the head section.
Action names – Add action names here to add no index, no follow in the head section for specific page. New route name needs to be added in next line.
Route names – Add route name here to add no index, no follow in the head section for list of pages.
Go to Admin > Catalog > Products > Select Product (for which you want to set Canonical URL) > Search Engine Optimization Tab
Primary Category – Select primary category to be included in the canonical URL tag.
Override Canonical URL – Enter text here to be used as canonical tag URL.
Robot Settings – Select the robot settings from dropdown.
Go to Admin > Catalog > Category > select category (for which you want to set canonical URL) > Search Engine Optimization Tab.
Canonical URL – Select primary category to be included in canonical URL tag.
Override Canonical Tag – Enter text here to be used as canonical tag URL.
Robot Settings – Select the robot settings from dropdown.
Go to Admin > Content > Pages > Choose page (for which you want to set canonical URL) > Search Engine Optimization Tab
Override Canonical URL – Enter text here to be used as canonical tag URL.
Robot Settings – Select the robot settings from dropdown.
Canonical Tag on the Category Page - You can enable canonical tag on the category page from Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags > Category Canonical Enable - Select "Yes".
Canonical Tag on the Product Page - To add canonical tag on the product page, go to Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags > Product Canonical Enable - Select "Yes".
Canonical Tag on the CMS Page - You can add canonical tag on the CMS page from Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags > CMS Canonical Enable - Select "Yes".
Go to Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet
Enable - Select “Yes” or “No” to enable or disable the module.
Description – Select description/short description from the drop down.
Price – Select Price from the drop down. In case price is listed with tax and without tax select which price should be used.
Brand – Select brand from the drop down.
Global Product Identifier – Select product identifier from the drop-down list.
Global Identifier Type – Select product identifier type from the drop-down list. It could be one of the following: gtin8, gtin13, gtin14, mpn.
Enable - Select “Yes” or “No” to enable or disable the module.
Description – Select description/short description from the drop-down.
Price – Select price from the drop down. In case price is listed with tax and without tax select which price should be used.
Wrap with div – Select “Yes/No”. It helps prevent conflicts with SEO extensions.
Use JSON-LD – Select “Yes/No” use JSON-LD format for product snippet.
Enable - Select “Yes” or “No” to enable or disable the module.
Card Type – Select the card type.
Description - Select description/short description from the drop down.
Price – Select price from the drop down. In case price is listed with tax and without tax select which price should be used.
Twitter Site – Set Twitter site name (@ username for the website used in the card footer)
Twitter Creator – Set Twitter creator name (@username for the content creator / author)
Facebook Open Graph Settings
Enable – Set “Yes” to enable.
Description – Select description/short description from the drop down.
Price – Select price from the drop down. In case price is listed with tax and without tax select which price should be used.
Site Name – Set Facebook site name.
App ID – Set Facebook App ID.
Enable – Set “Yes” to enable Pinterest Rich Pins . It uses same tags as Facebook open graph, make sure Facebook Open graph is enabled as well.
Home Page Markup Code - You can add structured data/markup code on home page from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet > Enable - Select "Yes". To test structured data, go to Structured Data Testing Tool > Provide Home Page URL > Click "Run Test" button.
Category Page Markup Code - You can add markup code, breadcrumbs on category page from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet > Enable - Select "Yes".
Product Page Markup Code - To add structured data markup code on product page, set "Enable" to "Yes" from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet.
Twitter Card - You can enable Twitter Card from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet >Twitter Card Settings > Enable - "Yes".
Facebook Open Graph - Enable Facebook Open Graph from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet >Twitter Card Settings > Enable - "Yes".
Increased and Optimized Page Ranking in Search Results - In the below image you can see the increased and optimized page ranking in search results.
Go to Admin > Stores > Configuration > Scommerce Configuration > Hreflang
Enable - Select “Yes” or “No” to enable or disable the module.
Href UrLS Scope – Select options from the list.
Website Hreflang URLs: It will work within one website.
Global Hreflang URLs: This will work across multiple websites.
X-Default – Select default store view.
Enable Hreflang Tags for Categories – Select “Yes/No”. If set to “Yes” then it will enable Hreflang Tags for the categories.
Enable Hreflang Tags for Products – Select “Yes/No”. If set to “Yes” then it will enable Hreflang Tags for the products.
Enable Hreflang Tags for CMS Pages – Select “Yes/No”. If set to “Yes” then it will enable Hreflang Tags for the CMS Pages.
Select Language – Select Local or Custom languages from the drop down list.
Add Country – Select “Yes/No”. If set to “Yes” then only the “Select Country” option will be visible.
Select Country – Select country from the drop-down list.
Hreflang Tag on the Home Page - You can enable hreflang on the home page by selecting "Yes" for " Hreflang Tags For CMS Pages " from Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For CMS Pages.
Hreflang Tag on the Category Page - To enable hreflang on the category page, go to Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For Categories - "Yes".
Hreflang Tag on the Product Page - You can enable hreflang on the product page by selecting "Yes" for " Hreflang Tags For Products " from Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For Products.
Hreflang Tag on the CMS Page - Enable hreflang on the CMS Pages From Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For CMS Pages - "Yes".
Go to Admin > Stores > Configuration > Scommerce Configuration > Cross Linking
Enabled – Select “Yes” or “No” to enable or disable the module.
Product Page Replacement Limit – Please define the replacement limit per product page. It determines how many keywords will be replaced on the given page.
Category Page Replacement Limit – Please define the replacement limit per category page. It determines how many keywords will be replaced on the given page.
CMS Page Replacement Limit – Please define the CMS page replacement limit. It determines how many keywords will be replaced on the given page.
Product Attributes for Replacement – Please select the product attributes where text will be replaced with link on product pages.
Category Attribute for Replacement – Please select the category attributes where text will be replaced with link on category page.
Cross Links Grid - You can manage and create new cross links from Admin > Marketing > SEO Cross Linking > Cross Links. This grid will have ID, Title, Status, Store View, Target, Replacement Limit, Priority, Nofollow, Action.
Add New Cross Link - To add new cross link, go to Admin > Marketing > SEO Cross Linking > Cross Links > Click on "Add New Link" button. It redirects on "Add New Cross Link" page and by providing all the general information you can create a new cross link.
This will have the following general information:-
Active - Dropdown with 'YES' or 'NO' options
Link Title - Title of the link
Link Target - Dropdown with options self or blank
Keywords - Keywords can be entered with line breaks and wildcard % anywhere with the keyword for example %phone% (iPhone7)
Store View - Multi-select with options All Store Views, Default Store View
Reference - Dropdown with options, Product ID, Category ID or Custom Url
Reference Resource - This will show either category tree or product grid with filters or css grid with filters to choose category or product ID
Priority - Priority to be given to the link which has highest priority first in case the replacement is lower number
Replacement limit - Limit the number of links per page
No Follow - This will add follow or nofollow with the link on frontend
Build External Link to Any Website - You can set external link to any website from Admin > Marketing > SEO Cross Linking > Cross Links >Reference - Custom Url > Custom Url - Provide External Link.
Alert Message for Inactive Product / Category - It shows an alert / warning message when you disable the category or product from Admin > Catalog > Category / Product > Select Category / Product > Disable > Save.
Alert Message for Inactive Category
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Cross Link on Category Page - You can define the replacement limit for category page from Admin > Stores > Configuration > Scommerce Configuration > Cross Linking > Category Page Replacement Limit - 1. It determines how many keywords will be replaced on the given page and to define cross link, go to Admin > Marketing > SEO Cross Linking > Cross Links > Select Link > Replacement Limit -1.
Category Page Cross Link Redirecting on External Link - Click on the cross link "Luma" will redirect to external link.
Cross Link on Product Page - You can define replacement limit for cross link from Admin > Marketing > SEO Cross Linking > Cross Links > Select Link > Replacement Limit - 2. Individual Cross link limit determines how many times the link will be replaced on the given page.
Product Page Cross Link Redirecting on Internal Link - Click on the cross link "Duffle" will redirect to defined internal link.
Cross Link on CMS Page - You can set replacement limit for cross link from Admin > Marketing > SEO Cross Linking > Cross Links > Select Link > Replacement Limit - 1. Individual Cross link limit determines how many times the link will be replaced on the given page.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Rich Snippets General Settings
Twitter Card Settings
Facebook Open Graph Settings
Pinterest Rich Pins Settings
Free Shipping (Website Level)
Price Valid Until
Home Page Markup Code
Category Page Markup Code
Product Page Markup Code
Twitter, Facebook Open Graph Social Sharing Code
Increased and Optimized Page Ranking in Search Results
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet
Enable - Select “Yes” or “No” to enable or disable the module.
Description – Select description/short description from the drop down.
Price – Select Price from the drop down. In case price is listed with tax and without tax select which price should be used.
Brand – Select brand from the drop down.
Global Product Identifier – Select product identifier from the drop-down list.
Global Identifier Type – Select product identifier type from the drop-down list. It could be one of the following: gtin8, gtin13, gtin14, mpn.
Enable - Select “Yes” or “No” to enable or disable the module.
Description – Select description/short description from the drop-down.
Price – Select price from the drop down. In case price is listed with tax and without tax select which price should be used.
Wrap with div – Select “Yes/No”. It helps prevent conflicts with SEO extensions.
Use JSON-LD – Select “Yes/No” use JSON-LD format for product snippet.
Enable - Select “Yes” or “No” to enable or disable the module.
Card Type – Select the card type.
Description - Select description/short description from the drop down.
Price – Select price from the drop down. In case price is listed with tax and without tax select which price should be used.
Twitter Site – Set Twitter site name (@ username for the website used in the card footer)
Twitter Creator – Set Twitter creator name (@username for the content creator / author)
Facebook Open Graph Settings
Enable – Set “Yes” to enable.
Description – Select description/short description from the drop down.
Price – Select price from the drop down. In case price is listed with tax and without tax select which price should be used.
Site Name – Set Facebook site name.
App ID – Set Facebook App ID.
Enable – Set “Yes” to enable Pinterest Rich Pins . It uses same tags as Facebook open graph, make sure Facebook Open graph is enabled as well.
Some settings are only available on the website level for eg:- Region/State.
Show free shipping- Select “Yes” or “No” to add or remove free shipping schema from the product page.
Country – It determines which country will have free shipping for the selected website
Region/State – It determines which state within the selected country will have free shipping for the selected website
Base Currency - Added as a part of free shipping schema, set 'YES' to allow use of base currency of the website otherwise the currency chosen by the customer.
Send Price valid until with the offers markup code for products.
Start Month- Select the starting month from where the priceValidUntil field will be calculated. for example:- if you select the month of January then the calculations for the field will start from january.
Time Interval- Select "quarterly", "Six-monthly", or "Yearly" based upon the selection the price valid until date will be calculated. Example:- if the start month is January and the current date is 23-11-2023 and the time interval selected is "Six-monthly" then the first six-monthly is between 01-01-2023 to 31-06-2023 and the second six-monthly period is between 01-07-2023 to 31-12-2023 hence the priceValidUntil will be 31-12-2023 as our date lies in this period.
Home Page Markup Code - You can add structured data/markup code on home page from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet > Enable - Select "Yes". To test structured data, go to Structured Data Testing Tool > Provide Home Page URL > Click "Run Test" button.
Category Page Markup Code - You can add markup code, breadcrumbs on category page from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet > Enable - Select "Yes".
Product Page Markup Code - To add structured data markup code on product page, set "Show free shipping" to "Yes" from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet>Free Shipping.
Shipping Markup Code - To add structured data markup code on product page, set "Enable" to "Yes" from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet.
Price Valid Until - To add the price valid until date with the structured data markup code on the product page, Set the "Start Month" and the "Time Interval" from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet > Price Valid Until.
Twitter Card - You can enable Twitter Card from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet >Twitter Card Settings > Enable - "Yes".
Facebook Open Graph - Enable Facebook Open Graph from, Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet >Twitter Card Settings > Enable - "Yes".
Increased and Optimized Page Ranking in Search Results - In the below image you can see the increased and optimized page ranking in search results.
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Configuration Path to Set Up Primary Category
Primary Category settings for Category
Run the script to setup primary category of one or all products together
Product Page Unique URL
Search Page / Category Page Unique Catalog Product URL
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Base
Enabled - Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Catalog URL
Enabled - Select “Yes” or “No” to enable or disable the module.
Exclude Root Categories – Exclude some root categories to appear as primary category dropdown against products.
Go to Admin > Catalog > Select Product > Search Engine Optimization > Primary Category . The drop down will show all the categories selected for the product from where you can select the primary category of the product.
Go to Admin > Catalog > Categories > Select Category > Primary Category Settings. The drop down will show two primary category settings for the selected category: -
Exclude from Primary Category (Yes/No) - Select Yes/No whether you want this category to excluded from the primary category or not.
Exclude Root Categories – Set the priority for the category, the highest priority will be selected as the primary category.
We have included a PHP script that can be utilized to set primary category for one or all products together. Simply run the script in the url and the primary categories will get updated for the set products.
For one product – Run the script given and refer to the image below to update the primary category of a single product.
{{Website_URL}}/SetPrimaryCategoryM2.php?deleteSku s=MH01
For all Products – Run the script given and refer to the image below to update the primary category of all products.
{{Website_URL}}/SetPrimaryCategoryM2.php?deleteSkus=all
If the script doesen't work in the URL then make sure to place the script inside PUB directory and change line number 6 as follows:-
Once updated, please run the script again.
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
N.B - Run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Product Page Unique URL - You can assign primary category to any product from Admin > Catalog > Select Product > Search Engine Optimization > Primary Category. In the below image you can see the assigned category of product Rival Field Messenger is "Gear->Bags".
Search Page / Category Page Unique Catalog Product URL – We have assigned “Strive Shoulder Pack” product to “Gear” Category and the URL stays the same when we access the product from the search or category page
Table Of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Cron Settings
Regenerate
Category Page
Product Page
CMS Page
Cache Hit for the Category Page After the Execution of Category Page Command
Cache Miss for the Category Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Cache Warmer
Enabled - Select “Yes” or “No” to enable or disable the module.
Regenerate cache after page update - Please select "Yes" or "No" to regenerate cache for updated page.
Select Pages - Please select the page(s) from the multi-select option . This will regenerate the cache selected page(s) on page update.
Can Regenerate Cache Manually - Please select " Yes" or "No". If set to "Yes" then you can regenerate cache manually from cache warmer grid.
Generate Log - Select "Yes" to generate the log.
Generation order - Select which page will be generated first by adding the generation order alognside the page type. 1 is the highest priority.
Allow bestsellers products to be cached first - Select "Yes" to give best seller products the highest priority in cache generation.
Bestseller Frequency - Choose the range of bestleer products monthly/yearly. Based on your selection these products will be cached.
Website priority - In multi website structures change the website in order to prioritize which will be cached first. 1 is highest priority.
Cache Cron Schedule - Schedule cron job to regenerate the cache for all non cached page(s).
Number of Concurrent Regeneration request - Please define the number of concurrent request.
When you enable the module and set General Settings > Can Regenerate Cache Manually > to "Yes" then it adds an additional option "Regenerate" under the "Actions > Select" drop-down at Admin > System > Cache Warmer > Actions. This grid will have Id, Reference Id, Processed Time, Request Path, Page URL, Last Cache - (Date, Time ), Status - (Cached/Un-cached), Page Type - (Home, Product, Category, CMS), Store View, and Action- (Regenerate, Delete).
Regenerate - It regenerates cache manually for Category/Product/CMS page(s). By clicking "Regenerate" action you can regenerate cache manually for a specific URL.
You can regenerate cache for Product/Category/CMS page(s) by running the following console commands:-
Category Page - To regenerate cache for the category page, execute the below command.
scommerce:cachewarmer:category
Product Page - To regenerate cache for the product page(s), execute the below command.
scommerce:cachewarmer:product
CMS Page - To regenerate cache for CMS page, run the below command.
scommerce:cachewarmer:cmspage
Cache Hit for the Category Page After the Execution of Category Page Command - When you execute the command for category page then it regenerates the cache and on the front-end you check the status "Hit" or "Miss" using browser tool (Inspect element) at Network > Select Page URL > Header > X- Magento-Cache-Debug : HIT
Cache Miss for the Category Page - Flush the cache by executing the command, c:f and then check cache using browser tool at, Network > Select Page URL > Header > X-Magento-Cache-Debug : MISS
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 .
Image Compression Provider – Please select image compression provider. Provider API URL: Provider API URL. smush it – imageoptim – kraken.io –
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
In this section, you will find installation, setup and user guide for all our . If you don't find what you are looking for then you can email us at
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Minify HTML
Javascript Settings
CSS Settings
General Settings
Lazy Loading on the Homepage
Home Page Excluded from Lazy Loading
Lazy Loading on the Category Page
Lazy Loading on the Search Page
Lazy Loading on the Cart Page
General Settings
Compress/Optimize Product Image
Compress/Optimize Category Image.
Compress/Optimize CMS Image
General Settings
Cron Settings
Regenerate
Category Page
Product Page
CMS Page
Cache Hit for the category page after the execution of category page c ommand
Cache Miss for the Category Page
Home Page Mobile
Home Page Desktop
Category Page Mobile
Category Page Desktop
Product Page Mobile
Product Page Desktop
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Speed Optimiser
Enabled - Select “Yes” or “No” to enable or disable the module.
Enabled - Select “Yes” or “No” to enable or disable the module. If set to “Yes” then the module will remove all the unnecessary comments, line breaks, tabs and spaces from your HTML to reduce its size.
Defer Iframes – Select “Yes” or “No”. If set to “Yes” then attribute defer will be added to the iframe.
Select “Yes” to enable the Defer Iframes
Merge Javascript Files – Select “Yes” or “No”. If set to “Yes” then it will merge all JS files into one to reduce the number of queries.
Enable Javascript Bundling – Select “Yes” or “No”. If set to “Yes” then it will combine all JS files into few bundles and download them for each page. This will save time by reducing the number of server requests.
Javascript Files Minification – Please select “Yes” or “No”. If set to “Yes” then the module will remove all the unnecessary comments, line breaks, tabs and spaces from your Java Script to reduce its size.
Merge CSS Files – Select “Yes/No”. If set to “Yes” then it will merge all CSS files into one to reduce the number of queries.
Defer Fonts Loading – Select “Yes/No”. If set to “Yes” then browser will load the page with system fonts and replace them with your fonts when they are loaded. It makes store pages load faster.
Fonts Display Swap – Select “Yes/No”. If set to “Yes” then font-display will be replaced with swap. Helps avoid Luma-Icons issue.
CSS Files Minification – Select “Yes” or “No”. If set to “Yes” then the module will remove all the unnecessary comments, line breaks, tabs and spaces from your CSS to reduce its size.
Go to Admin > Stores > Configuration > Scommerce Configuration > Lazy Loading
Enabled - Select “Yes” or “No” to enable or disable the module.
Preload Images – Select “Yes” to preload the images.
Loading Icon – Show a preview image before the real image loads.
Skip Images Count by page category – Enter a valid image count to skip the images from lazy load. Based on the count this option will decide how many images to load without lazy loading.
Ignore Images that Contain – Provide a part of an image tag content into the field to exclude the image from the lazy load.
Exclude Pages – Select the page(s) from multi-select options to exclude from the lazy load.
Lazy Loading on the Homepage – Enable the module to implement lazy loading on the homepage, here is the configuration path Admin > Stores > Configuration > Lazy Loading- Enable "Yes". In the below screen grab you can see the product "Radiant Tee" with lazy loading.
Home Page Excluded from Lazy Loading – There is an option " Exclude Pages" available in the backend, from where you can select the page to exclude from the lazy loading.
Lazy Loading on the Category Page – Enable the module to implement the lazy loading on the category page Admin > Stores > Configuration > Lazy Loading - Enable "Yes".
Lazy Loading on the Search Page – There is an option available in the configuration settings at Admin > Stores > Configuration > Lazy Loading- Enable and by selecting "Yes" or "No" you can enable or disable the lazy loading on the search page.
Lazy Loading on the Cart Page – You can implement lazy loading on the cart page by by enabling the module from the back-end configuration Admin > Stores > Configuration > Lazy Loading- Enable "Yes".
Go to Admin > Stores > Configuration > Scommerce Configuration > Image Optimizer
Enabled - Select “Yes” or “No” to enable or disable the module.
Compress Images while uploading - Select available options to enable compression for new images uploaded via Magento admin. We recommend this to be enabled because all the new things will be compressed straight away.
Number of images to processed – Define how many number of images you want to process when the cron job runs. Please note this number should be reasonable especially when you have multiple stores and many additional product images.
Minimum image size required after optimisation -
Include folders – Please select list of folders you want to include for compressing the image.
Compress Cached Product Images (Yes/No) – Select “Yes” to compress cached product images generated by Magento. We could recommend to leave this setting turned off especially when you clear your cached images frequently and you have more than 5 additional images on the product page.
API Key – Please enter API Key (if provider is kraken.io).
API Secret Key – This will be required for certain providers like kraken.io
Exclude folders – Please enter the list of folders you want to exclude from media directory (comma separated) for example foldername1, foldername2, /foldername /subfolder1, foldername/subfolder2
Backup Images (Yes/No) – Select “Yes” to enable this feature to backup original images before compressing original file.
Debugging (Yes/No) – Select “Yes” to enable debugging. This will write logs in var – log – imageoptimize.log
Image Optimiser Schedule – Please define the Cron frequency to optimize images.
Compress/Optimize Product Image - You can compress product images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "Product ".
Compress/Optimize Category Image - You can compress category images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "Category ".
Compress/Optimize CMS Image - You can compress CMS images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "CMS ".
Go to Admin > Stores > Configuration > Scommerce Configuration > Cache Warmer
Enabled - Select “Yes” or “No” to enable or disable the module
Regenerate cache after page update - Please select "Yes" or "No" to regenerate cache for updated page.
Select Page - Please select the page(s) from the multi-select option. This will regenerate the cache selected page(s) on page update.
Can Regenerate Cache Manually - Please select " Yes" or "No". If set to "Yes" then you can regenerate cache manually from cache warmer grid.
Generate Log - Select "Yes" to generate the log.
Cache Cron Schedule - Schedule cron job to regenerate the cache for all non cached page(s).
Number of Concurrent Regeneration request - Please define the number of concurrent request.
When you enable the module and set General Settings > Can Regenerate Cache Manually > to "Yes" then it adds an additional option "Regenerate" under the "Actions ->Select" drop-down at Admin > System > Cache Warmer > Actions. This grid will have Id, Page URL, Page Type - (Home, Product, Category, CMS), Status - (Cached/Un-cached), Last Cached - (Date, Time), and Action- (Regenerate, Delete).
Regenerate - It regenerates cache manually for Category/Product/CMS pages. By clicking on the "Regenerate" action you can regenerate cache manually for a specific URL.
You can regenerate cache for Product/Category/CMS page(s) by running the following console commands: -
Category Page - If you want to regenerate cache for the category page then run this command scommerce:cachewarmer:category
Product Page - To regenerate cache for the product page(s), use this command scommerce:cachewarmer:product
CMS Page - To regenerate cache for CMS page please use this command scommerce:cachewarmer:cmspage
Cache Hit for the category page after the execution of category page command - When you run the command for category then it regenerates the cache. On the front-end you can debug the cache and check the status "Hit" or "Miss" using browser tool (Inspect element) under Network > Select Page URL > Header > Cache Debug: HIT
Cache Miss for the Category Page - Flush the cache by executing the command (c:f) and then check cache using browser tool .
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Selected WDYHAU Option in Orders Grid
WDYHAU Details at Customers Level
WDYHAU Details on the Sales Order View Page
“Where did you hear about us?” Drop-down Options in the Back-end
WDYHAU Option on the Registration Page
WDYHAU option on the Checkout Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Where did you hear about us?
Enabled – Select “Yes” or “No” to enable or disable the module.
Dropdown options – Please add the WDHAU options for customers and administrators to choose during checkout and creating order via admin respectively. There should be semicolon (;)separated values for example Google;Facebook;Twitter;Others
Other Options Title - Please add the title for other options.
Drop Down Label – Please add the label.
Other Label – Please add the label for other option.
Field Is Required On Customer Registration - Select “Yes” or “No” to enable or disable the Field is required on customer registration.
Exclue Statuses - Select exclude statuses which you would like to not include when generating the WDYHAU Report.
Selected WDYHAU Option in Orders Grid - You can see the selected "Where did you hear about us?" option at Admin > Sales > Orders grid.
WDYHAU Details at Customers Level - To see the "Where did you hear about us?" option at customers level go to Admin > Customers > All Customers > Select Customer > Account Information > Where did you hear about us?
WDYHAU Details on the Sales Order View Page - The selected WDYHAU option will be shown on order view page under "Account Information" section from Admin > Sales > Select Order > View.
“Where did you hear about us?” Drop-down Options in the Back-end - When you enable the module, then it shows WDYHAU drop-down option in the back-end at Admin > Sales > Create New Order > Select Customer > Select Product > Select "Where did you hear about us?" option.
WDYHAU Option on the Registration Page - You can define the "Where did you hear about us?" drop-down options from Admin > Stores > Configuration> Scommerce Configuration > Where did you hear about us? - Google; Twitter; Facebook; YouTube; Others, which will be shown on the registration page.
WDYHAU option on the Checkout Page - You can see the "Where did you hear about us?" option on the checkout page.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Compress/Optimize Product Images
Compress/Optimize Category Images
Compress/Optimize CMS Images
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser
Enabled - Select “Yes” or “No” to enable or disable the module.
Compress Images while uploading (All pages, CMS, Category and Product): Select available options to enable compression for new images uploaded via Magento admin. We recommend this to be enabled because all the new things will be compressed straight away.
Number of images to processed – Define how many number of images you want to process when the cron job runs. Please note this number should be reasonable especially when you have multiple stores and many additional product images.
Include folders – Please select list of folders you want to include for compressing the image.
Compress Cached Product Images (Yes/No) – Select “Yes” to compress cached product images generated by Magento. We could recommend to leave this setting turned off especially when you clear your cached images frequently and you have more than 5 additional images on the product page.
API Key – Please enter API Key (if provider is kraken.io).
API Secret Key – This will be required for certain providers like kraken.io
Exclude folders – Please enter the list of folders you want to exclude from media directory (comma separated) for example foldername1, foldername2, /foldername /subfolder1, foldername/subfolder2
Backup Images (Yes/No) – Select “Yes” to enable this feature to backup original images before compressing original file.
Debugging (Yes/No) – Select “Yes” to enable debugging. This will write logs in var – log – imageoptimize.log
Image Optimiser Schedule – Please define the Cron frequency to optimize images.
Compress/Optimize Product Images - You can compress product images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "Product ".
Compress/Optimize Category Images - You can compress category images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "Category ".
Compress/Optimize CMS Images - You can compress CMS images by enabling module from Admin > Stores > Configuration > Scommerce Configuration > Image Optimiser > Enabled - "Yes" > Compress Images while uploading - Select "CMS ".
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Lazy Loading on the Homepage
Home Page Excluded from Lazy Loading
Lazy Loading on the Category Page
Lazy Loading on the Search Page
Lazy Loading on the Cart Page.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Lazy Loading
Enabled - Select “Yes” or “No” to enable or disable the module.
Loading Icon – Show a preview image before the real image loads.
Skip Images Count by page category – Enter a valid image count to skip the images from lazy load. Based on the count this option will decide how many images to load without lazy loading.
Ignore Images that Contain – Provide a part of an image tag content into the field to exclude the image from the lazy load.
Exclude Pages – Select the page(s) from multi-select options to exclude from the lazy load.
Lazy loading for product only on category page – Select “Yes” to apply lazy load on product images only on category page.
Lazy Loading on the Homepage – To implement lazy loading on the homepage, enable the module from Admin > Stores > Configuration > Lazy Loading- Enable "Yes".
Home Page Excluded from Lazy Loading – You can exclude homepage images from lazy loading by selecting option "Home Page" from Admin > Stores > Configuration > Lazy Loading > Exclude Pages .
Lazy Loading on the Category Page – To implement lazy loading on the category page, enable the module from Admin > Stores > Configuration > Lazy Loading - Enable "Yes".
Lazy Loading on the Search Page – You can implement lazy loading on search page from Admin > Stores > Configuration > Lazy Loading - Enable "Yes".
Lazy Loading on the Cart Page – You can implement lazy loading on the cart page by enabling the module from Admin > Stores > Configuration > Lazy Loading- Enable "Yes".
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Infinite Scroll with ‘Load More Button’ on the Category Page
Infinite Scroll with Auto Loading on the Category and Search Pages
Auto Loading on the Category Page
Auto Loading on the Search Page
Infinite Scroll with ‘Load More Button’ and Page Number
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Infinite Scrolling
Enabled - Select “Yes” or “No” to enable or disable the module.
Loading Type - Select loading type “Load Automatically” or “Load with Button”.
Button Label - Enter button label. This will be shown only when the “Loading Type” is set to “Load with Button”.
Button Label Font Color - Set font color for "Load with Button" which appears on site front-end.
Button Label Background Color - Select button label background color. This will be shown only when the “Loading Type” is set to “Load with Button”.
Button Label Size – Define font size for the “Load with Button” which appears on the site.
Display Page Numbers (Yes/No) – Select “Yes” to show the page information on the side panel.
Grid Dom Class – This is the class for grid view of product listing pages.
List Dom Class – This is the class for list view of product listing pages.
Infinite Scroll with ‘Load More Button’ on the Category Page – You can display the “Load More Button” on the category page by selecting “Load with Button” option from Admin > Stores > Configuration > Infinite Scrolling > Loading Type.
Infinite Scroll with Auto Loading on the Category and Search Pages – You can implement auto loading on the category and search pages by selecting the option "Load Automatically" from Admin > Stores > Configuration > Infinite Scrolling > Loading Type.
Auto Loading on the Category Page
Auto Loading on the Search Page
Infinite Scroll with ‘Load More Button’ and Page Number – To display Load More Button with page numbers on category and search pages first select option “Load with Button” from Admin > Stores > Configuration > Infinite Scrolling > Loading Type and then select “Yes “ from Admin > Stores > Configuration > Infinite Scrolling > Display Page Numbers. This will display page numbers with Load More Button as shown in screen grab below.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Timer/Label Settings
Cron Settings
Start and End Date set up with product
Enable Product on Scheduled Date
Display Prelaunch Text and/or Countdown Timer (such as Launching Soon)
Disable Product on Scheduled Date
When Start and End Date is Same
"Launching Soon" Text for the New Product on the Category Page
Launching Soon Timer on the Product Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Product Scheduler
Enable Product Scheduler – Select “Yes” or “No” to enable or disable the module.
Enable Log – Yes/No (If set to yes then this create a log file in var/log folder for each day with a time stamp like product_scheduler 20190125 log. The log file will record all details about products being set to enable/disable along with the dates/store values).
Show Timer/Label Before Launch Date – Set yes to enable the module. If set to yes then the product status will be enabled and will show on the front end but there will be no add to basket on category or product page. Instead of Add to basket button it will either show timer on product page and launching soon label on category page.
Launching Soon Label Text on Category Page – This is a text box. This option will only show if “Show timer/label before launch date” is set to yes This is a text for adding label text which will appear with product on category page. Default text should be “Launching Soon”.
Launching Soon Label Font Size on Category Page – This is a text box. This option will only show if “Show/timer before launch date” is set to yes. The user can enter the font size for the launching soon label text on the category page. Default size should be 12px.
Launching soon Label Font Colour on Category Page – This is a text box. This option will only show if “Show timer/label before launch date” is set to yes. The user can enter the text colour for the launching soon label text on category page. Default colour should be #ffffff.
Launching Soon Label Background Colour – This is a text box. This option will only show if “Show timer/label before launch date” is set to yes. The user can enter the background colour for the launching soon label text on category page. Default colour should be #FF0000.
Launching soon Label Text on Product Page – This is a text box. This option will show if “Show timer/label before launch date” is set to yes. This is a text for adding label text which will appear with product on product page. Default text should be “Launching soon”.
Launching soon Label Font Size on Product Page – This is a text box. This option will only show if “Show timer/label before launch date” is set to yes. The user can enter the font size for the launching soon label text on product page. Default size should be 14px.
Launching Soon Label Font Colour on Product Page – This is a text box. This option will only show if “Show timer/label before launch date” is set to yes. The user can enter the text colour for the launching soon label text on product page. Default colour should be #FF0000.
Custom CSS – Enter custom CSS code and easily change the way Product Scheduler looks.
Cron Schedule – This will allow you to define cron frequency, how often you want to run product scheduler cron.
The module enables you to pre-launch products with a custom label text such as “Coming Soon/Launching Soon”. This label appears on various pages of your store such as cross-sell products, up sell products, category pages, etc. The style of the label is completely customizable from the backend. We have provided several individual styling options in the configuration that allows you to style aspects such as font size, font color, label background color, etc.
You can add an start and End date to your products based on which a label or a timer or both can be displayed on products and category pages. The time on the timer or the duration in which the label is displayed is calculated from the start date in the product scheduler settings by going into Admin>catalog>Products.
The Product can be enabled and disabled based on start/end date. Upon completion of end date the product gets automatically disabled. It is disabled using the cron job configured as shown above, when the cron runs and the end date is reached the product will be disabled. The product is enabled on the day when the start date and time is set.
Let us look at how to set up start and end date for products.
Start and End Date Setup at Product Level - You can schedule product for launching by selecting ''Start Date'' and ''End Date'' from Catalog > Products > Select Product > Start Date / End Date.
Enable Product on Scheduled Date- The product gets enabled based on the Start date added in the product settings. If the start date is set 2 days in the future then the product will be enabled/launched exactly after completion of 2days.
Display Prelaunch Text and/or Countdown Timer (such as Launching Soon)- The prelaunch text/Countdown timer gets displayed based on the Start date added in product settings. The time till which these are displayed are calculated based on the current date/time and the start date/time so Its current date and time minus the start date and time. It won't be displayed only when start date has already gone by, if its set in the future then it will always be displayed.
Disable Product on Scheduled Date- The product get's disabled on the completion of the end date. If no end date is set and this field is left empty then the product will be enabled unless disabled manually from the product settings.
When Start and End Date is Same- Only the Prelaunch text/ Countdown timer will be displayed given that the start date has already gone by i.e its in history. As the start date and end date is same product will be automatically disabled on this day.
"Launching Soon" Text for the New Product on the Product Page – You can show "LAUNCHING SOON" on the category page for the new product from Admin > Stores > Configuration > Scommerce Configuration > Product Scheduler > Timer /Label Settings > Show Timer/Label Before Launch Date - "Yes".
Launching Soon Timer on the Product Page - To show launching soon timer on the product page, go to Admin > Stores > Configuration > Scommerce Configuration > Product Scheduler > Timer /Label Settings > Show Timer/Label Before Launch Date - Select "Yes".
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Products Assigned to Sale Category in the Back-end
Sale Products on the Category Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Dynamic Sale Category
Enabled – Select “Yes” or “No” to enable or disable the module.
Sale Category – Choose the sale category where all the sale products will appear. All products in the current category would be removed, If any assigned. This category will only be populated with products set up for offer through special prices.
Exclude Categories – Exclude some categories for pulling sale products from them.
Hide Sale Category with no Product – Set to yes if you want to hide the sale category when no products are in offer.
Display Sale ends date on the Product Page – Set to yes if you want to show the sales end date on the product page.
Sale ends text on the Product Page – Add text for sale ends date on the product page.
Date Format on the Product Page – Select the date format for sale end date to be displayed on the product page.
Display Sale Ends text on the category Page – Set to yes if you want to show sales ends date in the product listing.
Sale ends text on the Category Page – Add text for sale ends date in listing. Please include space if needed.
Date Format on the Category Page – Select the date format for sale end date displayed on category page.
Cron Schedule – This setting will be used to send the email through the cron.
Duplicate Urls Fix - Use this if command shows error "URL key for specified store already exists.". Note: it's not going to fix URLs duplicated key issue. It will just use another algorithm of assigning. The best option is to to fix duplicated URLs. Put "Yes" if you know what you are doing
As soon as any product is set with valid special product it automatically gets assigns to category set up for sale/offers in configurations. You can set special price from Admin > Catalog > Products > Select Product > Advanced Pricing > Set "Special Price" . There is a cron job which runs midnight and checks for any product set up under offer.
Products Assigned to Sale Category in the Back-end - You can see the Sale Products in the back-end under "Sale/Offers" categories, from Admin > Catalog > Categories > Select Category "Offers" > Click on "Products in category" .
Run the below refresh command to show the products under sale category.
scommerce:dynamic-sale-category:refresh
Sale Products on the Category Page - The products with special price will be shown on the category page under the category you have selected from Admin > Stores > Configuration > Scommerce Configuration > Dynamic Sale Category - "Sale" or "Offer", along with the sale ends date.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Analyze Data with Facebook Events Manager
Facebook Events Manager Graph
Facebook Pixel Tag on the Category Page
Facebook Pixel Tag on the Product Page
Facebook Pixel Tag on the Cart Page
Facebook Pixel Tag on the Checkout page
Facebook Pixel Tag on the Payment Page
Facebook Pixel Tag on the Success Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Installation via Composer(Breeze Theme): Go to My Account section then go to Composer Instructions. Run the composer config commands mentioned on the page then run the below command to install the module on hyva theme.
Go to Admin > Stores > Configuration > Scommerce Configuration > Facebook Conversion Tracking
Enabled – Select “Yes” or “No” to enable or disable the module.
Audience Pixel Tag Id – Enter Custom Audience Pixel Id. This applies to old as well as new Facebook tracking.
Remarketing Default Value – Enter default value for events where value can’t be defined like CompleteRegistration, Search (only used for new Facebook tracking)
Always Send Parent SKU – Set “Yes” then it always send parent sku instead of child sku to facebook
Enable GDPR Cookie Check – Select "Yes" or "No" to enable/disable GDPR Cookie Check
Force decline – If you set this to yes then FACEBOOK tracking will be turned off unless customer accepts the cookie policy from the cookie notification message from your website
Analyze Data with Facebook Events Manager - Facebook Business Manager gathered enough information so that you can analyze data using event log, which shows how many times the tracker has been fired.
Facebook Events Manager Graph - You can view the event log and graph in Facebook business manager with all the events view details.
The module is GDPR compliant which can work with both our/third party GDPR modules. You can enable the GDPR support within the module so that the tracking doesent work without users consent.
To enable GDPR support go to Stores>Configuration>Scommerce Configuration>Facebook Conversion Tracking and set 'Enable GDPR cookie check' to 'Yes' then set 'Force decline' to 'Yes' and provide the GDPR cookie name in the 'GDPR Cookie Key' inputbox. If you are using our GDPR module then the cookie name is 'marketing_cookie' but if you are using other GDPR extension then please check with extension developer. Once the setting is complete unless the customer accepts the cookie the facebook tracking won't fire.
Facebook Pixel Tag on the Category Page - The extension offers all standard trackers that Facebook uses. When the category page is viewed then it shows page view with event info, which you can see in the below image.
Facebook Pixel Tag on the Product Page - When a key page is viewed such as a product page, e.g. landing on a product detail page. Provides detailed product information (such as Prices, SKU's, Currencies and Categories) for Dynamic Product Ads. You can enable dynamic product ads from Admin > Stores > Configuration > Scommerce Configuration > Facebook Conversion Tracking > Dynamic Products Ads Enabled - "Yes".
Facebook Pixel Tag on the Cart Page - When a product is added to the shopping cart, then it tracks the cart event.
Facebook Pixel Tag on the Checkout page - It tracks checkout , when a user clicks on checkout button.
Facebook Pixel Tag on the Payment Page - It tracks AddPaymentInfo when a payment information is added in the checkout flow, e.g. click on payment method.
Facebook Pixel Tag on the Success Page - When a purchase is made or checkout flow is completed, e.g. landing on thank you/success page, provides detailed order information such as Order Value and Cart Items.
Facebook Pixel Tag on Add to Wishlist Page -Add to Wishlist when "Always Send Parent SKU" set to 'NO" AND Dynamic Product Ads Enabled - "YES"
Facebook Pixel Tag on Add to Wishlist Page -Add to cart when "Always Send Parent SKU" set to 'NO" AND Dynamic Product Ads Enabled - "YES"
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Dynamic Remarketing Tag, Code Snippets on the Homepage
Dynamic Remarketing Tag/Code Snippets with Product Details
Dynamic Remarketing Ad
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Google Remarketing Tag
Enabled – Select “Yes” or “No” to enable or disable the module.
Google Conversion Id – Enter your Google Adwords Account Id.
Enable Tracking for other sites – This will enable other sites variables (https:/.developers.google.com/adwords-remarketing-tag/parameters#other) instead of retail site variables.
Enable dynamic remarketing tag – Set “Yes” to enable dynamic remarketing tag.
Product Id attribute – Use the same id you have submitted in your Google base feed.
Dynamic Remarketing Tag, Code Snippets on the Homepage - To view remarketing tag and code snippets go to Homepage > View Source . In the below image you can see the conversion ID and Custom variable. You can add conversion Id from Admin > Stores > Configuration > Scommerce Configuration > Google Remarketing Tag > Google Conversion Id.
Dynamic Remarketing Tag/Code Snippets with Product Details- In the code snippet you can see the product details with Product ID and Google conversion id. You can select Product Id attribute from Admin > Stores > Configuration > Scommerce Configuration > Google Remarketing Tag > Product Id attribute - Select "SKU".
Dynamic Remarketing Ad - When you enable the dynamic remarketing from Admin > Stores > Configuration > Scommerce Configuration > Google Remarketing Tag > Enable dynamic remarketing tag, then it shows ads to people who have previously visited your website.
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 .
Image Compression Provider – Please select image compression provider. Provider API URL: Provider API URL. smush it – imageoptim – kraken.io –
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Image Compression Provider – Please select image compression provider. Provider API URL: Provider API URL smush it –
imageoptim –
kraken.io –
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
New Facebook Tracking Enabled – Set yes to enable Facebook new pixel tracking or Remarketing tag
Dynamic Product Ads Enabled – Set yes to enable the Dynamic Product Ads
GDPR Cookie Key – You can add name of your GDPR cookie here for our the name of cookie key is marketing_cookie but if you are using other GDPR extension then please check with extension developer
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Apply Cart Rule for all custom options available
Apply cart Rule for specific custom options
When “only for selected custom options is set to “Yes”
When “only for selected custom options is set to “No”
When “only for selected custom options is set to “Yes” and Conditions are set
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Enabled - Select “Yes” or “No” to enable or disable the module.
Login to your admin panel then go to Catalog > Products. Select your product and click edit from the action column. Scroll down to Customizable options. Click on add option to add a new custom option for the selected product.
Go to Marketing > Promotions > Cart Price Rules and click on Add New Rule.
Create your Cart Price Rule Normally. Then scroll down to Actions dropdown. Make sure Only for selected Custom Option? Is set to “Yes”. This option will enable the cart price rule to be applied on the custom options. Make sure there are no conditions set.
To create cart price rule for specific custom options you will need to add conditions in the Actions Column. For eg: - we have added a condition to apply discount only on the custom option that has custom options title as “Gift Wrap”. So now the discount will only be available for the Gift wrap custom option. Similarly, you can create conditions based on custom options SKU and create your custom options discount.
Conditions available for custom options are custom options title and custom options SKU.
Installation via app/code
Installation via Composer
General Settings
Cash Back
Cash Back Reminder
Create Cart Price Rules for Cashback Discount
Cashback Transactions
Cashback Customize Email Template
Cashback Qualifying Message on the Checkout Page
Cashback Discount Option on the Checkout Page
Applied Cashback Discount on the Checkout Page
Auto Apply Discount
Cashback Discount Details on the Front-end - My Account Section
Cashback Expiry Reminder Email
Second Cashback Expiry Reminder Email
Order Confirmation Email
Invoice Email
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Cash Back
Module Enable - Select “Yes” or “No” to enable or disable the module.
Auto Apply Discount – Please select “Yes” if you would like to auto apply discount.
Tax Class - Select the tax class
Grand or SubTotal Attribute - Select the grand or subtotal attribute
Select discount in case of multiple cash back rules are applied – Please choose whether the customer will get minimum discount or maximum discount, in case there are more than one cashback rules are applicable on cart.
Include Shipping (Yes/No) – Please select “Yes” if you would like to include shipping price in Cash Back qualifying amount.
Cashback Title Message – Please add cashback discount title to show on checkout page. This will appear just before cashback discount message.
Cashback Qualifying Message – Please add cashback qualifying message. This will appear on checkout pages when a user will qualify for cashback discount %s and %d is dynamic variable for amount and date.
Apply Cashback Checkbox Label – Please add label for apply discount checkbox on checkout.
Transactions Update Schedule – This setting will be used to allow you to define schedule how often you want to update transactions.
Summary Update Schedule – This setting will be used to allow you to define schedule how often you want to update summary.
Enable (Yes/No) – This setting will enable or disable module.
Email Sender – Please select sender/from email address for Cash Back reminder email.
Email Template – Please select email template for Cash Back reminder email.
Second Email Template – Please select email template for second Cash Back reminder email.
Cashback Reminder Message – Please add a custom message for Cash back expiry reminder %1 and %2 is dynamic variable for amount and date.
Cashback Second Reminder Message – Please add a custom Message for Cas back expiry second reminder %1 and %2 is dynamic variable for amount and date.
Cashback Expiry Reminder Schedule – Please define how often you want to run cron for the cash back reminder email.
Send reminder (days) – Please add number of days for reminder email to be sent to the user before the Cash back Discount expires. For e.g. If set to “1” day, then an email will be sent 1 day before the Cash Back Discount expiry date.
Send second reminder (days) - Please add number of days for second reminder email to be sent to the user before the Cash back Discount expires. For e.g. If set to “1” day, then an email will be sent 1 day before the Cash Back Discount expiry date.
Create Cart Price Rules for Cashback Discount - You can create cart price rules from Admin > Marketing > Promotions > Cart Price Rules > Click on "Add New Rule", it redirects on new cart price rule and by filling all the required details you can create the new cart price rule.
Cashback Transactions - To view cash back transaction go to Admin > Sales > Scommerce Cash Back > Cash Back > Cashback Transactions.
The grid will have following columns/information:-
Customer Email – Customer email Id
Cashback Amount – Cashback amount
Cashback Expiry – Cashback discount expiry date
Transaction Date – Date of added or deducted cash back discount
Status – Cash Back discount status (Applied/Processing/Used)
Updated_at – Updated date
Applied Cashback Details on the Order View Page - You can view the applied cashback discount at Admin > Sales > Orders > select Order > View.
Cashback Customize Email Template - You can display cashback discount in any of your email templates using the built in variables.
Cashback Qualifying Message on the Checkout Page - You can define qualifying message from Admin > Stores > Configuration > Scommerce Configuration > Cashback Qualifying Message - " ", the message will be shown on the checkout page.
Cashback Discount Option on the Checkout Page - When you enable the module and if there is any cash back discount available then it shows "Apply cash back discount" option on the checkout page and by checking this option you can apply for cash back discount.
Applied Cashback Discount on the Checkout Page - You can see the applied cash back discount on the checkout page under "Order Summary" section.
Auto Apply Discount - To apply discount automatically and hide checkbox on checkout, set ‘Auto apply discount’ to ‘Yes’ from Admin > Stores > Configuration > Scommerce Configuration > Cash Back > Auto apply discount – “Yes/No”.
Cashback Discount Details on the Front-end - My Account Section - You can view cash back details on the front-end from My Account > My Cashback History.
Cashback Expiry Reminder Email - When you enable the "Cash Back Reminder" from Admin > Stores > Configuration > Scommerce Configuration > Cash Back > Cash Back Reminder > Enable - "Yes", it sends an expiry reminder email to customers before the period of the discount expired.
Second Cashback Expiry Reminder Email – You can set the email templates and reminder days for second email from Admin > Store > Configuration > Scommerce Configurations > Cash Back Reminder- Second Email Template and Send second reminder (days).
Order Confirmation Email – You can see the applied cashback discount on the order confirmation and invoice emails.
Invoice Email – Below is the image where you can see applied cashback discount.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Successful Applied Discount Message on the Front-end
Coupon Code On the Checkout Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Auto Coupon
Enabled – Select “Yes” or “No” to enable or disable the module.
Message After Applying Code – Message which will displays on the site after successful application of coupon code.
You can set up the discount coupon code from Admin > Marketing > Cart Price Rules > Click "Add New Rule", it redirects on "New Cart Price Rule" and by providing all the required details you can create the new rule and set up the discount code.
Once the discount is set up then on the front-end it can be applied using the below link :-
http://{[siteurl}}/applydiscount/?code={[discount_code}}&redirect_url={[any_url_ of_your_site}}
Site url – Site base URL.
Discount Code – Discount code as set up in discount.
Returning Site URL – This is optional parameter. If defined, user will be redirected to this URL after successful application of the discount code. If not defined then User will be redirected to the Home page.
Successful Applied Discount Message on the Front-end - The message you have set from Admin > Stores > Configuration > Scommerce Configuration > Auto Coupon > Message After Applying Code, will be shown on the front-end homepage.
Coupon Code On the Checkout Page - Applied discount coupon code will be shown on the front-end checkout page under "Order Summary" section.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General
Content
Format
Conditions
Facebook Product Feed XML
Google Product Feed XML
Google Product Feed CSV
Facebook Product Feed CSV
Make attribute visible in the Google Feed under Rule Conditions
Product Feed with Swatches
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Product Feed Generator
Enabled - Select “Yes” or “No” to enable or disable the module.
Batch Size – Indicate how many products will be handled during one iteration.
Affect the feed generation time and the server memory consumption.
Schedule – Please add the cron schedule for auto generated feeds.
You can create/manage/edit data feeds from Admin > Scommerce > Manage feed list > Click “Add Feed”, it redirects on Edit Feed page which contains all the settings required to create a new feed. You can do any custom adjustments while creating a feed or you can do them later. You will find an ACTIONS drop-down on the top left of the list. It contains the following option: -
Generate: - Click on it to generate the feed manually.
Status: - Select the feed and you can change the status to active or inactive from this option.
Mode: - You can also change the mode of a feed Auto or Manual from this option
Delete: - Click on it to delete a feed.
The general tab contains all the general settings such as Name of the feed, URL key, type of feed, store, status, and execution mode.
URL Key: - Here enter the URL key
Type: - You can specify the type of feed here such as XML, CSV, TXT etc.
Store: - Choose the store view
Exclude Parent Products: - If “Yes” then the feed will contain only child product links and if set to “NO” Then the feed will contain both child and parent products.
Status: - Status needs to be active to generate the feed.
Execution Mode: - Execution mode can be Manual or Auto. For the Manual mode you will have generate the feed manually. As for the auto mode, the feed will be generated by the scheduled cron on the time specified in the configurations.
In the content section, you will notice that our extension generates the code automatically for you. You can also make the changes if you want.
<g:google_product_category>: - Leave this empty but if you want to then please add the category relevant to google categories.
Tag: - You can add a tag into your content
Attribute: - Select attribute such as brand, price etc.
Format: - Now you can also select Price and Date in the format
Parent: - Select “Yes” to add parent product in the feed and “No” to only include child products.
Use Attribute Label: - Select “Yes” to display the attribute (in text format) and “No” to display attribute in a identifier format.
Fill From Child: - If set to "yes" and product is configurable - value will be taken from first child
Eg: - Suppose you want to add GBP in the price attribute then you can change it by simply navigating to the tag <g:price> and add “GBP” before closing the tag. Similarly you can customize any part of the data.
Here, you can customize the format of several parts of the data such as Price, date, etc.
The conditions tab allows you to add custom conditions specific to the feed. For instance, you can apply a condition to generate the feed for only one product by referring to its specific SKU. You can also apply several other conditions from the drop-down list.
Facebook Product Feed XML – When you click on the feed from Admin > Scommerce > Manage Feed List > Click “facebook.xml”, then it opens the product feed.
Google Product Feed XML – To generate Google feed go to Admin > Scommerce > Manage Feed List > Click “google.xml”, it opens the product feed.
Google Product Feed CSV – When you click on any CSV feed, it opens the product feed in CSV format.
Facebook Product Feed CSV – Here is the Facebook product feed in CSV format.
You can add from Admin > Stores > Attributes > Product > Select Product Attribute (e.g. sku) > Use for Promo Rule Conditions - 'Yes'
In the below image you can see that attribute “SKU” added under conditions.
To allow colour and size to be auto selected on product page, the URL needs to be created like show below.
attribute name and value of the attribute
for example - size=s&color=red
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Product Label Grid
Add New Product Label
Product Label on Category Page
Product Label on Product Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Product Label
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin>Catalog>Scommerce Product Labels>Product Labels
Go to Admin>Catalog>Scommerce Product Labels>Product Labels>Add New Product Label
Status– Select “Enabled” or “Disabled” to enable or disable the product label.
Scope– Choose the website scope where the product label will be applicable
Text– Enter the text displayed in the product label. You can use the several special variables mentioned below the inputbox to create enticing labels. Following special variables can be used for the tag:-
{PRICE} - regular price;
{PRICE_EXTAX} - price excluding tax;
{BR} - new line
{SAVE_PERCENT} - save percent
{SAVE_PERCENT_EXTAX} - save percent excluding tax
{SAVE_AMOUNT} - save amount
{SAVE_AMOUNT_EXTAX} - save amount excluding tax
{SPECIAL_PRICE} - special price
{SPECIAL_PRICE_EXTAX} - special price excluding tax;
{ATTR:code} - attribute value, e.g. {ATTR:color}
{SPDL} - days left for special price
{SPHL} - hours left for special price
{NEW_FOR} - days ago the product was added
{SKU} - product SKU
{STOCK} - product qty (for product view page)
Upload Label Image– Upload the product label image
Hide From Category– Select “Yes” or “No” to hide or show the label on Category page.
Hide From Product– Select “Yes” or “No” to hide or show the label on product page.
Hide From Search– Select “Yes” or “No” to enable or disable the label on search page.
Priority– Add the priority of the label with 0 being the highest priority. Product with multiple labels assigned will display the lable with highest priority.
Conditions– Add conditions for the label as per your requirement
Text Size– Enter the text size for the product label.
Text Color– Enter the text color for the product label.
Background Color– Enter the background color for the product label.
Label Position– Enter the label position for the product label.
Custom CSS– Enter the custom CSS for the product label.
Product Label on Category Page
Product label on Product Page
Product label on Search Page
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Perfect Audience Tag
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Perfect Audience
Enabled – Select “Yes” or “No” to enable or disable the module.
Tracking Tag ID – Enter tag Id only without .js.
You can add perfect audience tracking tag from Admin > Stores > Configuration > Scommerce Configuration > Perfect Audience > Tracking Tag ID.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Language and Country Settings
Override Canonical URL
Category Page
Product Page
CMS Page
Hreflang Tag on the Home Page
Hreflang Tag on the Category Page
Hreflang Tag on the Product Page
Hreflang Tag on the CMS Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Hreflang
Enable - Select “Yes” or “No” to enable or disable the module.
X-Default – Select default store view.
Enable Hreflang Tags for Categories – Select “Yes/No”. If set to “Yes” then it will enable Hreflang Tags for the categories.
Enable Hreflang Tags for Products – Select “Yes/No”. If set to “Yes” then it will enable Hreflang Tags for the products.
Enable Hreflang Tags for CMS Pages – Select “Yes/No”. If set to “Yes” then it will enable Hreflang Tags for the CMS Pages.
Select Language – Select local or custom languages from the drop-down list.
Add Country – Select “Yes/No”. If set to “Yes” then only the “Select Country” option will be visible.
Select Country – Select country from the drop-down list.
We have a priority system in place for the URL path that is to be included in the sitemap. The URL path is picked based on the below priority system:-
Override canonical URL:- It is of highest priority. If this is set for any product, category or CMS page then canonical URL path will be picked in the hreflang tag.
Set Primary Category:- It is secondest highest priority. If override canonical URL is not set then the primary category path set is picked in the hreflang tag.
Default Path:- if neither override canonical URL nor Set primary Category is set then the default path of the product, category or CMS page is picked to be included in the hreflang tag.
You can set the override canonical URL for any product, category or CMS page. The steps to setup override canonical URL is provided as below:-
Go to Admin>Catalog>Categories and select any category. Scroll down to find the tab "Search Engine Optimization". Enter the URL path in the "Override Canonical URL" section.
Go to Admin>Catalog>products and select any product and click edit. Scroll down to find the tab "Search Engine Optimization". Enter the URL path in the "Override Canonical URL" section.
Go to Admin>Content>Pages and select any page. Scroll down to find the tab "Search Engine Optimization". Enter the URL path in the "Override Canonical URL" section.
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Hreflang Tag on the Home Page - You can enable hreflang on the home page by selecting "Yes" for " Hreflang Tags For CMS Pages " from Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For CMS Pages.
Hreflang Tag on the Category Page - To enable hreflang on the category page, go to Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For Categories - "Yes".
Hreflang Tag on the Product Page - You can enable hreflang on the product page by selecting "Yes" for " Hreflang Tags For Products " from Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For Products.
Hreflang Tag on the CMS Page - Enable hreflang on the CMS Pages From Admin > Stores > Configuration > Scommerce Configuration > Hreflang > General Settings > Enable - Select "Yes " > Enable Hreflang Tags For CMS Pages - "Yes". Go to Admin > content > Pages select the about us page for each store view and go into Search Engine Optimization. Put the same identifier if you want interlinking between various languages of the same about us page.
Installation via app/code
Installation via Composer
General Settings
Free Shipping Bar Rule - Grid
New Shipping Bar - General Settings
New Shipping Bar - Websites & Customers Groups
New Shipping Bar - Shipping Countries
New Shipping Bar - Display Options
New Shipping Bar - Content
New Shipping Bar - Design
Font Color - Enter font color
Free Shipping Discount
Free Shipping Bar on the Homepage with Generic Message
Free Shipping Bar with Generic Message / Bar Position Bottom Fixed
Free Shipping Bar with Remaining Amount
Free Shipping Bar on the Cart Page with Success Message
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Free Shipping Bar Rule
Enabled - Select “Yes” or “No” to enable or disable the module.
You can add and customize Free Shipping Bar Rules from, Admin > Marketing > All Free Shipping Bar Rules > Free shipping Bar Rule
Free Shipping Bar Rule - Grid - To create new free shipping bar rule click on “Add Shipping Bar” button and to edit existing rule click “Edit” option under "Action"
Bar Name - Enter Bar name. This is only for admin use.
Bar Status - Select "Enable/Disable" bar status.
Minimum Order Amount Source - Select option "Specify Manually" (utilize the rules minimum order amount) or out of the box "Magento free shipping method"(utilize minimum amount from the freee shipping method).
From (Date) - Select date from date picker.
To (Date) - Select date from date picker.
Priority - Set priority level for the free shipping bar. Highest priority level will be picked up first
Rule Apply On - Select "Subtotal excluding VAT/Subtotal including VAT" to apply the free shipping bar rule.
Minimum Order Amount - Enter qualifying amount for cart goal.
Store View - Select the store view.
Customer Group - Select customer group.
Allowed Countries - Select allowed shipping countries.
Bar Position - Select the bar position from the dropdown list to show on the front-end.
Pages - Select the page(s) where you want to show the free shipping bar. If all pages are selected then the bar will be shown on all.
Add Link to the Bar - Select "Yes/No". If set to “Yes” then it will add the information link for terms and conditions.
Add Close Button - If this is “Yes” then it will hide the bar with ‘x’ button.
Show Customize Icon - Select “Yes/No” option. If set to “Yes” then “Upload Icon” option will be shown.
Upload Icon - This will be an option for user to upload an icon (visible when "Show Customize Icon" set to "Yes")
Initial Message - Provide initial message (This will be an informative or generic message about free shipping conditions).
In Progress Message - Provide in progress message (A message to inform customers about the amount left for free shipping).
Achieved Message - Provide achieved message (A customer will get it, when the cart total achieves the needed amount to get a free shipping).
Free Shipping Terms Content - Provide shipping terms or other important information. (This will be a fill in the message to provide customers with shipping terms or other important information right on the bar).
Font - Select font
Font Size - Enter font size
Font Color - Enter font color
Background Color - Enter background color
Custom CSS - Provide custom CSS (.classname {background- color:{color:#FFFFFF})
Free Shipping Discount - The extension only implements the bar display and actual shipping discount needs to be set separately in Magento out of the box.
Free Shipping Bar on the Homepage with Generic Message - You can set generic message for free shipping bar from Admin > Marketing > All Free Shipping Bar Rules > Free shipping Bar Rule > Click "Add Free Shipping Bar Rule" > New Shipping Bar > Initial Message
Free Shipping Bar on the Category Page with Generic Message / Bar Position Bottom Fixed - You can set bar position by selecting bar options from Admin > Marketing > All Free Shipping Bar Rules > Free shipping Bar Rule Click "Add Free Shipping Bar Rule" > New Shipping Bar > Display Options Bar Position.
Free Shipping Bar with Remaining Amount - You can inform customers about the remaining amount left for free shipping by providing in progress message from Admin > Marketing > All Free Shipping Bar Rules > Free shipping Bar Rule > Click "Add Free Shipping Bar Rule" > New Shipping Bar > In Progress Message
Free Shipping Bar on the Cart Page with Success Message - You can set success message from Admin > Marketing > All Free Shipping Bar Rules > Free shipping Bar Rule > Click "Add Free Shipping Bar Rule" > New Shipping Bar > Achieved Message
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Exclude Categories from Sitemap
Exclude Products from Sitemap
Exclude CMS Pages from Sitemap
How to Generate Sitemap
Add new Sitemap
Magento Out of the Box Functionality to set the Category Path
Product Link in Sitemap XML
Category Link in Sitemap XML
CMS Pages Link in Sitemap XML
Category Page
Product Page
CMS Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Base
Enabled - Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > SEO Sitemap
Enable - Select “Yes” or “No” to enable or disable the module.
Exclude Categories from Sitemap – To include or exclude categories, go to Admin > Catalog > Manage Categories > Select category (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”
Exclude Products from Sitemap – To exclude products from sitemap, go to Admin > Catalog > Manage Products > Select product (you want to exclude from sitemap) > General > Exclude from Sitemap: Set to ”Yes/No”.
Exclude CMS Pages from Sitemap – To exclude CMS pages from sitemap, go to Admin > CMS > Pages > Select CMS Page (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”
How to Generate Sitemap – To generate the site map from the admin panel go to, Admin > Marketing > Sitemap > Click ''Generate Sitemap''.
Add new Sitemap - You can create new site map from, Admin > Marketing > Sitemap > Click ''Add Sitemap'', it redirects to New Site Map page and by providing all the required details you can create Site Map.
Magento Out of the Box Functionality to set the Category Path - To include category path in product URLs in sitemap.xml, go to Admin > System > Configuration > Catalog > Catalog > Search Engine Optimizations > Use Categories Path for Product URLs: Set to "yes".
We have a priority system in place for the URL path that is to be included in the sitemap. The URL path is picked based on the below priority system:-
Override canonical URL:- It is of highest priority. If this is set for any product, category or CMS page then canonical URL path will be picked in the sitemap.
Set Primary Category:- It is secondest highest priority. If override canonical URL is not set then the primary category path set is picked in the sitemap.
Default Path:- if neither override canonical URL nor Set primary Category is set then the default path of the product, category or CMS page is picked to be included in the sitemap.
You can set the override canonical URL for any product, category or CMS page. The steps to setup override canonical URL is provided as below:-
Go to Admin>Catalog>Categories and select any category. Scroll down to find the tab "Search Engine Optimization". Enter the URL path in the "Override Canonical URL" section.
Go to Admin>Catalog>products and select any product and click edit. Scroll down to find the tab "Search Engine Optimization". Enter the URL path in the "Override Canonical URL" section.
Go to Admin>Content>Pages and select any page. Scroll down to find the tab "Search Engine Optimization". Enter the URL path in the "Override Canonical URL" section.
You can use a script provided with the extension to automatically add primary categories for products. Admin can exclude certain categories from primary category and also prioritise one category over the other to be picked as the primary category.
Go to Admin>Catalog>Categories select a category then scroll down to find the option "Primary Category Settings". Here click on "Exclude From Primary Category" to exclude this category from primary category or enter the priority 0 being the highes. The highest priority category will be picked first for the primary category.
To automatically assingn primary category for all products run the command given below by going into the root directory of your store.
N.B - If you are using older version then run the script provided in the extension folder at the path Data/SetPrimaryCategoryM2.php from ssh
Google site map shows all the included Products, Categories, and CMS Pages links in the sitemap.xml.
Category Link in Sitemap XML - You can see the category link in the Google Sitemap XML.
CMS Pages Link in Sitemap XML - In the below screen grab you can see the about-us page link in the Google Sitemap XML.
Product Link in Sitemap XML - You can see the product link in the Google Sitemap XML.
Table of Contents
Installation via app/code
Installation via Composer
Installation via Composer(Hyvä Theme)
General Settings
Checkout Behaviour
General Settings
Home Page with Tags
Gtag.js Code
Gtag.js Brand Name
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Installation via Composer(Hyvä Theme): Go to My Account section then go to Composer Instructions. Run the composer config commands mentioned on the page then run the below command to install the module on hyva theme.
Go to Admin > Stores > Configuration > Scommerce Configuration > Tracking Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Enable Enhanced Ecommerce – Select ‘Yes’ to enable this module. Please make sure this feature is enabled in Google Analytics first before enabling in Magento2.
Product ID Attribute – Select the attribute which you have submitted in your Google base feed. For e.g. SKU
Brand Attribute – Please select brand attribute, if you have one otherwise put your brand name in the below input box.
Use Base Currency - Set ‘Yes’ if you want to send base order data and ‘No’ to send store order data to Google. Set this ‘No’ only when you have multicurrency and you want to send different currency data to Google.
Product Price Include Tax- Set “Yes” then VAT will be included in the price.
Order Total Include VAT – Set “Yes” then VAT will be included in order total.
Always Send Parent SKU – Set “Yes” then it always send parent sku instead of child sku to GA during checkout.
Category Attribute- Please select category attribute if you have one otherwise put your brand name in the below input box. Attribute should be available for product listing 'Storefront Properties -> Used in Product Listing = Yes'
Is Category ID- Set "Yes" if "Category Attribute" is ID of the category, "No" if it is plain value
Send Parent Category – Set “Yes” to send the category path and Set “No” to send the category name only.
Default List- Enter the default list name if the product impression is not found
Send Admin Orders to Google– Select “Yes” to track orders created in admin
Source-Please add the Campaign Source for backend orders.
Medium-Please define the Campaign Medium for Backend Orders.
Send Product Impression on Scroll - Enable this feature when you have loads of products on product listing / category pages.
Category Ajax Enabled – Enable this feature if you have third party ajax enabled extension on your category page.
Add Carrier Title:- Use this to add carrier title to the shipping step. Set "Yes" to send carrier_code::carrier_title. Ex. flatrate::Flat Rate
Add Payment Title :- Use this to add payment method title to payment step. Set "Yes" to send method::title. Ex. checkmo::Check / Money Order
Steps Configuration:- define checkout steps
Step:- number of step
Selector:- add the selector for the step. Basic selector could be '#customer-email' this is equals to '#customer-email/change' and will send customer email itself
Type:- choose the step type from the dropdown
Go to Admin > Stores > Configuration > Scommerce Configuration > Global Site Tag (gtag.js)
Enabled – Select “Yes” or “No” to enable or disable the module.
Accounts ID – You can add multiple account id, it can be Analytics, Adwords.
Main Account – Select ‘Yes’ to set your main analytics id as an account id. This account will be used to connect gtag.js.
Use Linker – If this is enabled (set to ‘Yes’) then this account will be linked to domains from “Domains to link” field, which is specified below
Action – You can delete your account\, if required.
Enable Linker - If this is enabled then you can set linker properties, in domain configurations which is specified below e.g. Domain to link, Decorate Forms. This setting is mainly for Cross domain mesurement, so to use this you must first enable it in Google Analytics 4 Admin.
Domains to Link - Enter the domains that you want to link. Example destination.com, dest3.com or /^example.(com|de|nl)$/.
Decorate Forms - If you have forms on site pointing to the destination domain, set this property of the linker parameter to Yes
Promotion Tracking – Here is the format to set up the promotion tracking: <a href="#" data-promotion="CREATIVENAME" data-id="PROMOID" data-name="PROMONAME" data-creative="PROMOCREATIVE" data-position="PROMOPOSITION"> Content </a>
Enable Dynamic Remarketing Tag – If set to ‘Yes’, then this will enable and install remarketing tag to different pages.
Go to Analytics and select the website on which you want to implement GA4.
Once you are in universal analytics panel go into admin settings. Here you will notice an UPGRADE TO GA4 button, click on it. You will be walked with creating a new property. Follow along, once you are finished you will see the new GA4 view on your screen
Step 1:- Go to Google Analytics 4 Admin>Data Streams>Select your stream>Configure Tag Settings >Configure Your Domains, here add your domains or subdomains that you want to track.
Step 2:- Add the all domains added above in the configuration "Domains to link" comma separated. Now if you have any links taking you from your main site to the linked site, _gl cookie is automatically apended to the URL that contains several information such as source website, source campaign etc hereby accomplishing the cross domain measurement. an example of such URL is as follows:-
Home Page with Tags - In Tag Assistant tool you can see all the fired tags.
Gtag.js Code - In the below image you can see the UA and AW tracking id’s from Admin > Stores > Configuration > Scommerce Configuration > Global Site Tag (gtag.js) > Account Id > Click on “Add Account” – G-R6FSTDG16K, AW-123234123.
Gtag.js Brand Name – You can add brand name from Admin > Stores > Configuration > Scommerce Configuration > Global Site Tag (gtag.js) > Brand Name – “TestScommerce”.
Upload Package: 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.
Install extension: After the successful upload of the package you have to run the commands on Magento2 root directory via SSH
Clear Caches: This can be done from the admin console by navigating to the cache management page (System->Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change. Logout and login back in Admin.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin->System->Configuration->Scommerce Configuration->Google Tag Manager Tracking->General
Enable: Set yes to enable the module.
License Key: Enter the License key provided by Scommerce Mage.
Account Id: Enter your Google Tag Manager Account Id.
IN MAGENTO
Once you have installed the modules “Google Tag Manager Pro Tracking”, “Tracking Base”, ”Cookie Popup” and “GDPR”, enable them and enter the correct license key.
After that, go to “Customers” -> “Manage Cookie Choices” and click on “Add new Cookie Choice” to set up cookie choices in the Cookie Popup extension.
2a. You can do the setup of a new cookie as shown in the below image or you can create your own cookie/s. Please note that “Cookie Name” and “Set by default” are the most important fields as they would be used in the cookie mapping as described in the later steps.
2b. Once you have created a cookie or multiple cookies, your setup should resemble the below image-
Now, go to “System”->”Configuration”->“Tracking Base”. Scroll down and you would see the field “Enable Consent Mode”, enable it in order to enable the consent mode. Then, go to “Cookie mapping”, add the “Consent Param” that are given in the description”(personalization_storage, functionality_storage, security_storage are not mandatory for correct consent setup), set the “Default value” of the consent parameter as “granted” or “denied” based on the “Set by default” (step 2a) value of the cookie. Use the “Cookie Name” that you used while creating the cookies. For example- analytics_storage, if you want to do mapping of this consent param with Analytics cookie then in the field “Cookie name” add “analytics_cookie” because this cookie name was used when you were creating cookies (step 2a). While creating the cookie (in this case Analytics cookie), if the value of “Set by default” is set to “No” then while doing the mapping the “Default value” of the consent param (in this case analytics_storage) that is associated with that cookie should be set to “denied” or vice versa.
On Magento’s end consent mode setup is complete.
In GTM
Open the container that is connected with our GTM module, go to “Admin”->“Container Settings” and enable consent overview present in the additional settings.
Go to “Workspace”->”Tags” -> click on “Consent Overview” (shield) and set up consent for each tag. Make sure to select “No additional consent required” for Tags that already have “Built-In Consent”. These tags are generally Google related tags.
2a. In order to add “Additional Consent”, click on the tag name and go to ”Consent Settings” and choose “Require additional consent for tag to fire” and add the consent param that you want as “Additional Consent”. If cookies related to the consent parameter that is chosen as an additional consent are not accepted then that tag would not fire.
On GTM’s end consent mode setup is complete.
Verification
In order to verify whether the consent mode is working as per the configuration you have set or not, you can preview your changes and compare them with the frontend as shown in the below images. All the values should be the same.
Table of Contents
Installation via app/code
Installation via Composer
Installation via Composer(Hyvä Theme)
Installation via Composer(Breeze Theme)
General Settings
Checkout Behaviour
General Settings
Cookies From Query Params
Enable Enhanced Conversions in Google Adwords
Set up Enhanced Conversion with the Module
Order Total of Product without VAT
Order Total of Product with VAT
Send SKU of Child Product
Send SKU of Parent Product Only
Send Parent Category
Primary Category
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Installation via Composer(Hyvä Theme): Go to My Account section then go to Composer Instructions. Run the composer config commands mentioned on the page then run the below command to install the module on hyva theme.
Installation via Composer(Breeze Theme): Go to My Account section then go to Composer Instructions. Run the composer config commands mentioned on the page then run the below command to install the module on hyva theme.
Go to Admin > Stores > Configuration > Scommerce Configuration > Tracking Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Enable Enhanced Ecommerce – Select ‘Yes’ to enable this module. Please make sure this feature is enabled in Google Analytics first before enabling in Magento2.
Product ID Attribute – Select the attribute which you have submitted in your Google base feed. For e.g. SKU
Brand Attribute – Please select brand attribute, if you have one otherwise put your brand name in the below input box.
Primary Category Attribute – When a product is in more than one category then the primary category attribute will be sent to Google.
Brand Attribute – Please
Sliders name- Enter the name for custom sliders that will be sent as list name with the data layer.
Affiliation- Enter the affiliation name which you want to send with the GA4 data layers.
Use Base Currency - Set ‘Yes’ if you want to send base order data and ‘No’ to send store order data to Google. Set this ‘No’ only when you have multicurrency and you want to send different currency data to Google.
Product Price Include Tax- Set “Yes” then VAT will be included in the price.
Order Total Include VAT – Set “Yes” then VAT will be included in order total.
Always Send Parent SKU – Set “Yes” then it always send parent sku instead of child sku to GA during checkout.
Category Attribute- Please select category attribute if you have one otherwise put your brand name in the below input box. Attribute should be available for product listing 'Storefront Properties -> Used in Product Listing = Yes'
Is Category ID- Set "Yes" if "Category Attribute" is ID of the category, "No" if it is plain value
Send Parent Category – Set “Yes” to send the category path and Set “No” to send the category name only.
List Name with full path- Choose whether you want to send the full path of the category or not. When 'yes' The breadcrumbs are broken into separate categories and sent as item_category1, item_category2 etc. Set 'No' to send the lowest level category. for ex:- Men>Tops>Jackets, when 'yes' Men, tops, jackets all three categories will be sent. When 'no' only jackets is sent.
Send 'Default List'- When customers land on the product page directly then 'default' list' will be sent as list name when set to 'Yes'. When 'No' list name/ list ID will be removed.
Default List- Enter the default list name if the product impression is not found
Send Admin Orders to Google– Select “Yes” to track orders created in admin
Send Refund On Order Cancellation:- Set "yes" to send refund event on order cancellation.
Source-Please add the Campaign Source for backend orders.
Medium-Please define the Campaign Medium for Backend Orders.
Send Product Impression on Scroll - Enable this feature when you have loads of products on product listing / category pages.
Product item class on category / product listing page- Enter the product item class. Make sure this product class item hierarchy is as unique as possible for example for luma theme you can use div.products ol.product-items li.product-item
Threshold for Scroll:- Enter the number of product impressions to be sent with view_item_list on scroll.
Category Ajax Enabled – Enable this feature if you have third party ajax enabled extension on your category page.
Add Carrier Title:- Use this to add carrier title to the shipping step. Set "Yes" to send carrier_code::carrier_title. Ex. flatrate::Flat Rate
Add Payment Title :- Use this to add payment method title to payment step. Set "Yes" to send method::title. Ex. checkmo::Check / Money Order
Enabled – Select “Yes” or “No” to enable or disable the module.
Server Side Tagging – Set "Yes" to enable server side tagging and "no" to disable it. Please don’t turn this on unless you understand what this setting does.
Account Id – Enter your Google Tag Manager Account Id.
Enable dynamic remarketing tags – Set “Yes” if you want to enable google dynamic remarketing tags to used for GTM.
Enable tracking for other sites – Set “Yes” to enable tracking for other sites.
Send Ecom Category Path – Set "yes" to send the category path with ecomm_category.
Enable GDPR Cookie Check – Select "Yes" or "No" to enable/disable GDPR Cookie Check
Server Side Tagging – Set "Yes" to enable server side tagging and "no" to disable it. Please don’t turn this on unless you understand what this setting does.
Server Side script part - Enter the HTML code of server side GTM container. It will replace the default HTML code on the frontend.
Server Side noscript part - Enter the noscript part of server-side GTM code. It will also replace the default HTML code on the frontend.
Force decline – If you set this to yes then GTM tracking will be turned off unless customer accepts the cookie policy from the cookie notification message from your website
Enable GA4 data layer-Select "Yes" to add GA4(Google Analytics 4) events to the data layer.
Enabled – Select “Yes” or “No” to enable or disable the module.
Configuration – Use this setting to create cookies by entering cookie parameter, cookie name, and cookie value.
Lifetime – Enter the lifetime of the cookie. It will be stored in the users browser as per the time defined in this setting.
NOTE:- Please make sure to import the JSON files again after every upgrade of the module as we keep changing these files time to time and keep them updated with our latest data layers.
The extension package contains JSONs which can be imported in GTM to set up required Tags, Triggers and Variables.
Please follow the steps below to download the module:-
Step 1:- Login to your account and go to the My Account Section
Step 2:- Click on My Downloadable Products
Step 3:- Click on the extension and from the dropdown menu select download
Go to the extension file m2-google-tag- manager-pro and then to the Data Folder (Path - m2-google-tag-manager-pro/data/) to find these files.
The JSONs can be used to set up
GTM-GoogleAnalytics4.json:- Google Analytics 4
GTM-Facebook_Pixel_Tracking.json:- Facebook Pixel tracking
GTM-Snapchat_Tracking.json:- Snapchat Pixel tracking
GTM-AdwordsDynamicRemarketing.json:- Google AdWords Dynamic Remarketing
GTM-google_ads_conversion_tracking.json:- Google Ads Conversion Tracking
GTM-Pinterest.json:- Pinterest tracking
GTM-Pinterest-GA4.json:- Use this file if you are using only GA4 and not UA
GTM-Reddit_Pixel_Tracking.json:- Reddit Pixel Tracking
GTM-Tiktok_Pixel_Tracking.json:- Tiktok Pixel Tracking
GTM-Twitter.json:- Twitter Pixel Tracking
GTM-Partnerize.json:- Partnerize
GTM-Webgains_tracking.json:- Webgains Affiliate tracking
GTM-google_ads_enhanced_conversion_tracking.json:- Google Ads Enhanced Conversion Tracking(Make sure its enabled in the extension configuration and also ensure that "send conversion data using data layer is set to "No" in tracking base configuration)
GTM-google_ads_enhanced_conversion_tracking_using_datalayers.json - If you have set "send conversion data using data layer is set to "Yes" in tracking base configuration then import this JSON file which utilizes data layer push to populate the conversion PII data.
Note:- Please import only one Pinterest JSON file depending upon the extension configuration you are using. If you are only using GA4 and no UA then you can use the Pinterest GA4 JSON file. Also if you have 'Send Product Impression on Scroll ' enabled in Admin>Stores>Configuration>Scommerce Configuration>Tracking Base then use the Pinterest GA4 JSON file as well otherwise you can use the original Pinterest JSON file.
To import JSONS provided with extension package follow below steps:
Log into GTM and navigate to your Account and container
In the top navigation, click through the Admin
Under the container options, click on Import Container
Choose the JSON file which you would like to import
Choose to either Overwrite or Merge
Overwriting the existing container will remove all your existing tags, triggers, and variables, and will replace them with those in the imported container. A new container version will be created before the import.
Merging containers will let you keep your existing tags, triggers, and variables, and just add in the new ones. If you choose to Merge the new container with your existing container, you’ll have to then decide whether you want to overwrite conflicting tags or rename conflicting tags.
Overwrite – If a variable, tag, or trigger in the new container has the same name but the contents are different, overwrite the old one with the new one.
Rename – If a variable, tag, or trigger in the new container has the same name but the contents are different, keep the old one and rename the new one.
Click Continue. You’ll see a preview of changes, showing how many tags, triggers, and variables will be added, modified, or deleted. You can also click the link to View Detailed Changes to see which tags, triggers, and variables are being added, modified, or deleted.
Once you’re satisfied with the changes, click Confirm.
Once the GTM container file has been imported, you need to change variable information with correct value corresponding to the site. To access variables, go to workspace where you have imported the JSONs and click on variables on left hand side navigation.
Variables Created with JSON’s
GA4 Measurement ID – This variable is created when GTM-Google Analytics 4.json is imported and it holds value for Google Analytics 4 Measurement Id for the site. Click on the GA4 Measurement ID and change it to correct value.
conversionID - This variable is created when GTM- AdwordsDynamicRemarketing.json is imported and it holds value for Google Adwords Conversion Id for the site. Click on the conversionID and change it to correct value.
facebookPixelID - This variable is created when GTM-Facebook.json is imported and it holds value for Facebook pixel Id for the site. Click on the facebookPixelID and change it to correct value.
currencyCode - This variable is created when GTM-Facebook.json is imported and it holds value for currency used on site. Click on the currencyCode and change it to correct value.
Google Ads Conversion Tracking - Add Conversion ID and Conversion Label in the Google Ads Conversion Tracking tag before publishing the container. These IDs can be found in your Google Ads account.
Microsoft UET Tracking - Add the Microsoft Advertising UET Tag ID which can be obtained from microsoft Ads account.
Facebook Pixel Tracking - Add the Microsoft Advertising UET Tag ID which can be obtained from microsoft Ads account.
Snapchat Pixel Tracking - Add the Snapchat Pixel ID which can be obtained from snapchat Ads account as shown below.
Twitter Pixel Tracking - Add the Twitter Pixel ID which can be obtained from Twitter Ads account as shown below.
Reddit Pixel Tracking - Add the Reddit Pixel ID which can be obtained from Reddit Ads account as shown below.
Tiktok Pixel Tracking - Add the base pixel code and Tiktok Pixel ID which can be obtained from Tiktok Ads account as shown below.
Webgains Event ID - Add webgains event id received from Webgains in the GTM variable {{Webgains - Event ID}}
Webgains Program ID - Add the Webgains Program ID received from Webgains in the GTM Variable {{Webgains - Program ID}}
Once all set up is done and verified, need to Publish the tags to make it live on the website.
Step 1 − Click the SUBMIT button at the top right corner of the screen.
It will show the following screen.
Step 2 − Enter an identifiable Version name so that it can be easily understood for the changes made.
With the version description, you can be as elaborate as possible on the changes/additions of the tag in that version.
Step 3 − Scroll down to the Workspace Changes, you will see all the changes made in the tags, which are unpublished or in the PREVIEW mode.
Step 5 − Click PUBLISH and you will be presented with a summary for this version.
Go to Analytics and select the website on which you want to implement GA4.
Once you are in universal analytics panel go into admin settings. Here you will notice an UPGRADE TO GA4 button, click on it. You will be walked with creating a new property. Follow along, once you are finished you will see the new GA4 view on your screen.
Now we need to setup the tag manager for GA4. If you have already imported all the tags using our JSON file then you only need to edit the tag and add your Measurement ID. However, if you are creating tags yourself then you need to create a new configuration tag.
To create a new configuration tag in GTM. Please look at the image below: -
To get the measurement id you need to go to your GA4 view. Go to the admin settings and then data streams. Click on the website url coloured in blue and a popup should open.
You will see the Measurement ID listed on the top right corner of this page.
To setup Google Adwords Conversion, please make sure you add GTM-google_ads_conversion_tracking.json (data folder of the extension) file in your GTM container and add Conversion Label and Conversion ID which you should be able to get from Google Adwords account under Conversion section. This import will create the following tags -:
Conversion Linker Tag
Google Ads Conversion Tracking
To enable enhanced conversions we first need to enable enhanced conversions in Google Adwords then complete the extension setup.
In the upper right corner of your account, click the tools icon , and under "Measurement," click Conversions.
Open the conversion action you want to use for setting up enhanced conversions.
In the “Enhanced conversions” section at the bottom, click Turn on enhanced conversions.
Select ”Google tag or Google Tag Manager” to set up enhanced conversions.
Click Check URL to check your website for a Google tag.
In “Tag type” you should be defaulted to Google Tag Manager if that is how you track conversions for this conversion action. Because you used Google Tag Manager to set up website tags, you need to use it to set up enhanced conversions. Follow the instructions below to set up enhanced conversions manually with Google Tag Manager.
Click Save.
Go to Stores>Configuration>Scommerce Configuration>Tracking Base and set "Enable Enhanced Conversion" to "Yes". Import the JSON file either enhanced conversion using data layers or the normal enhanced conversion JSON that fetches the PII data from the global Javascript objec.
Once done import the JSON file named "GTM-google_ads_enh anced_conversion_tracking.json" if or import "GTM-google_ads_enhanced_conversion_tracking_using_datalayers.json" provided with the extension(data folder) in your GTM container . Change the 'conversion label' and 'conversion ID' in the "Google Ads Conversion Tracking" tag. Finally publish the changes to finish the setup.
Cookies from query Params configuration can be used to create new cookie parameters which can be stored in the users browser as per the valid time configured. for eg:- We have created a clickref cookie in the configuration. Now if the cookie parameter is passwed with the URL then that cookie will be created in the browser.
If you are using an older version of the extension(3.0.1 and below) where a common data layer is used to populate data to both UA and GA4 then upon updating to the latest version you need to make the following changes in GTM.
Google Analytics 4
GA4 Views/impressions of product/item details
GA4 View Item List Scroll
GA4 View Item List
GA4 Shipping info
GA4 Remove a product from a shopping cart
GA4 Refunds
GA4 Purchases
GA4 Promotion views/impressions
GA4 Promotion clicks
GA4 Product/Item List Clicks
GA4 Payment info
GA4 Begin Checkout
GA4 Add a product to a shopping cart
Ecommerce-detail-products
Ecommerce-product-detail-value
Ecommerce-checkout-products
Ecommerce-checkout-option
Ecommerce-remove-products
Ecommerce-refund-products
Purchase-affiliation
Purchase-tax
Purchase-shipping
ecommerce-promoView-promotions
ecommerce-promoClick-promotions
Ecommerce-click-products
ecommerce-product-click-list-name
View_item
View_item_list
Shipping Info
removeFromCart
Refund
Purchase
View_promotion
promotionClick
productClick
Payment_info
addToCart
Now follow the steps below to import the latest GA4 settings for GTM
Step 1:- Acquire the latest GA4 JSON file provided with the module.
Step 2:- Go to your GTM container then click on admin>Import Container.
Step 3:- Click on Choose container file and choose the JSON file acquired in step 1 then select the workspace new/existing. Also select Merge>Rename conflicting tags, triggers, and variables so that no crucial setting is lost.
Step 4:- Lastly, click confirm to finish the import. Once it's done you will have the latest tags, triggers and variables for GA4 in your GTM.
Go to Stores > Configuration > Scommerce > Google Tag Manager Pro. Scroll down to option Order Total Include Vat and toggle it to ‘No’. When turned ‘No’ the total order value data sent to Google analytics will not include VAT.
Go to Stores > Configuration > Scommerce > Google Tag Manager Pro. Scroll down to option Order Total Include Vat and toggle it to ‘Yes’. When turned ‘Yes’ the total order value data sent to Google analytics will also include VAT.
Go to Stores > Configuration > Scommerce > Google Tag Manager Pro. Scroll down to the option Always Send Parent SKU and toggle it to ‘No’. When turned ‘No’ if the customer selects a configurable product then the SKU data sent to Google analytics will be of the child product.
Go to Stores > Configuration > Scommerce > Google Tag Manager Pro. Scroll down to the option Always Send Parent SKU and toggle it to ‘Yes’. When turned ‘Yes’ if the customer selects a configurable product then only the SKU of the parent product will be sent to Google analytics.
Go to Stores > Configuration > Scommerce > Google Tag Manager Pro. Scroll down to the option Send Parent Category and toggle it to ‘Yes’. When turned ‘Yes’ if the customer selects a product then it will send the entire category path to the analytics if “No” then it will only send the category name.
Go to Catalog > Products and select any product. Then Scroll down to the option Primary Category.
Here you can set the primary category for any product. If you do not wish to send the assigned category to analytics, then you select which category path or name you want to send.
Please follow the below guide to set up consent mode v2 with GTM, also you would need to have both GTM and GDPR modules to complete this setup.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
GA4
Select Store View
GA4 Sync Log grid
GA4 Sync Log File
Google Analytics 4 Real Time Reports
Google Analytics 4 Custom Reports
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Google Analytics Synchronization
Enabled – Select “Yes” or “No” to enable or disable the module.
Enabled – Select “Yes” or “No” to enable or disable synchronization with UA(Universal Analytics).
Google View id – View Id can be obtained from Google Analytics. Go to Admin>View Settings>View ID.
Exclude order statuses – You can choose to exclude certain order statues from sync. These orders won’t be synced with Google Analytics.
Orders day Skip – Enter the number of days you want to skip checking. For eg:- Suppose if you enter 2 then orders from 2days ago will be synced today.
Skip Hours- This setting works in conjunction with Order days skip" setting. When Order days skip is set to 0 then you can add hours here to allow number of hours to skip before considering transaction has been missing and sending it to GA. Default value is 4 and we will recommend to keep it that way because original transaction can take longer to appear in Google Analytics.
Send Base Data – Select whether you want to send base order data or store order data.
Send Phone or Admin Orders – Enabling this option will also sync orders placed from admin panel and phone
Source – Pass a source to Google for admin orders
Medium – Pass a medium to Google for admin orders
Brand Attribute – Select a brand attribute to send with brand names
Brand Text box – Input brand name to send to Google
Default Landing Page - This setting allows you to set default landing page value which shows in Google Analytics in case landing page is not available to sent as part of missing transaction.
Cron Schedule – Schedule specific cron time to run the sync automatically.
Debugging – Enabling debugging will generate a detailed log report in /var/log directory
Test Mode- This setting allows you to check missing transactions before we send the transactions to GA. It helps in validating the data before it gets posted to Google Analytics
Synch GA4 – Select “Yes” or “No” to enable or disable the GA4 sync.
API Secret – Enter the API secret key here. API secret key can be created by going into GA4>Admin>Data Streams>Select website>Measurement Protocol API Secrets>Create enter the name and click on create to get the key.
Skip Order days – Enter the number of days that will be skipped before sending to GA4. Please put greater than 0 value. This is done to avoid duplicate transactions. For eg:- Suppose if you enter 2 then orders from 2days ago will be synced today.
Measurement ID – Enter the measurement ID of your GA4 property. Ga4 measurement ID can be extracted from GA4>Admin>Data Streams>Select website and it is available in the top right corner.
Property ID – Enter the property ID of GA4. GA4>Admin>Property Settings>Property ID
Select Store View
Enabled – Select “Yes” or “No” to enable or disable the module.
Enabled – Select “Yes” or “No” to enable or disable synchronization with UA(Universal Analytics).
Google View id – View Id can be obtained from Google Analytics. Go to Admin>View Settings>View ID.
Exclude order statuses – You can choose to exclude certain order statues from sync. These orders won’t be synced with Google Analytics.
Analytics Account Id – It is your Google Analytics account ID.
Orders day Skip – Enter the number of days you want to skip checking. For eg:- Suppose if you enter 2 then orders from 2 days ago will be synced today.
Skip Hours- This setting works in conjunction with Order days skip" setting. When Order days skip is set to 0 then you can add hours here to allow number of hours to skip before considering transaction has been missing and sending it to GA. Default value is 4 and we will recommend to keep it that way because original transaction can take longer to appear in Google Analytics.
Send Base Data – Select whether you want to send base order data or store order data.
Send Phone or Admin Orders – Enabling this option will also sync orders placed from admin panel and phone
Source – Pass a source to Google for admin orders
Medium – Pass a medium to Google for admin orders
Brand Attribute – Select a brand attribute to send with brand names
Brand Text box – Input brand name to send to Google
Default Landing Page - This setting allows you to set default landing page value which shows in Google Analytics in case landing page is not available to sent as part of missing transaction.
GA4
Synch GA4 – Select “Yes” or “No” to enable or disable the GA4 sync.
API Secret – Enter the API secret key here. API secret key can be created by going into GA4>Admin>Data Streams>Select website>Measurement Protocol API Secrets>Create enter the name and click on create to get the key.
Skip Order days – Enter the number of days that will be skipped before sending to GA4. Please put greater than 0 value. This is done to avoid duplicate transactions. For eg:- Suppose if you enter 2 then orders from 2days ago will be synced today.
Measurement ID – Enter the measurement ID of your GA4 property. Ga4 measurement ID can be extracted from GA4>Admin>Data Streams>Select website and it is available in the top right corner.
Property ID – Enter the property ID of GA4. GA4>Admin>Property Settings>Property ID
The synced transactions can be verified in two ways. Either checking the GA Sync logs or by checking the Real time reports in GA4 (as it takes 24 to48 hrs for GA4 to attribute data to reports realtime is the quickest way to verify).
GA Sync Log Grid: Go to System> Manage GA Sync Logs> GA Sync Logs
After clicking on "GA Sync Logs", user would see the generated logs in the Sync Log Grid.
User can also use filters to check a particular log in the grid.
GA4 Sync Log File: The GA Sync logs can be viewed by going into your server>Magento installation directory>Var>log>ga_sync.log.
After downloading/viewing the file, user can check the logs. This file contains details of each synced transaction alongwith the order data that was sent, please refer to the image below:-
Go to your Google Analytics 4 Property then from left menu click on reports:-
Next, select realtime from the left menu and under the event name column you can find the purchase event by clicking on that you can verify the transaction ID that was sent through the sync module.
Google Analytics 4 Custom Reports
The order tracking info is captured against each order which is later used to sync the transactions to GA4 attributing them to correct sessions and dates to improve report accuracy. The order tracking info can be viewed by going into Admin>Sales>Order>Edit any order. Please refer to the screengrab below.
Please follow the steps below to create project in Google developer console for GA reporting API and to obtain “application name” and “security key JSON File”: -
Google Analytics API (Used to access UA data)
Click Continue again without any selection
Click on Create Key from the image above and select json your key file will be downloaded. Place this key file in the VAR directory of your website. Copy the exact name with extension “.json” and input it into security Key in the configuration.
Login to your GA4 account. Go to Admin -> Property -> Property Access Management. Add the email we got in the steps above with “Viewer” or "Analyst" permissions.
Login to your Universal Analytics account. Go to Admin > User Management. Add the email we got in the steps above with “Viewer” or "Analyst" permissions.
Login to Your Google Analytics account and go to Admin>View Settings. You will be able to see your view Id there. You need to input this into the configuration as well.
php bin/magento scommerce:analyticssync:synchronize
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Configuration Settings
Back-end - Delivery Instruction Details
Delivery Instruction Section on the Checkout page
Delivery Time Selection
Delivery Date Selection
Delivery Instructions Details in Order Confirmation Emails
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce > Diamond Search
Module Enable - Select “Yes” or “No” to enable or disable the module.
Delivery Instruction Label – Enter delivery instruction label, this label will be shown on the frontend checkout page under delivery instruction section.
Delivery Date Label – Enter delivery date label, this label will be shown on the frontend checkout page.
Delivery Time Label – Enter delivery time label, this label will be shown on the frontend checkout page under delivery instruction.
Choose Time Label – Enter time label, this label will be shown on the frontend checkout page under delivery instruction.
Max Length - Enter max length of delivery instruction.
Enable Delivery Date – Select “Yes” to enable the delivery date on checkout.
Delivery Date cut off time – Select delivery date cut off time, after this time the order will be treated for next day.
Order Processing time – Number of days which is required for order processing. If this is set to 2 then the date calendar on checkout will show delivery dates of 2 days from order placement.
Exclude Dates – Dates which will be disabled on the date grid on checkout.
Timeslots – Times will be available in date calendar on checkout.
Disable days – Select weekdays which will be disabled on the checkout calendar.
Back-end - Delivery Instruction Details - To view the delivery instructions details, go to Admin > Sales > Order > Select Order > View.
Delivery Instruction Section on the Checkout page - When you enable the module and select the "Enable Delivery Date" to "Yes" from Admin > Stores > Configuration > Scommerce Configuration > Delivery Instruction > Configuration Settings, then it shows Delivery Date, Delivery Time under Delivery Instruction section on the checkout page.
Delivery Time Selection - You can add time slots from, Admin > Stores > Configuration > Scommerce Configuration > Delivery Instruction > Configuration Settings > Timeslots, and added time slots will be shown on the checkout page from where you can choose the convenient time slot for delivery.
Delivery Date Selection - To show delivery date on the checkout page, select "Enable Delivery Date" to "Yes" from Admin > Stores > Configuration > Scommerce Configuration > Delivery Instruction > Configuration Settings.
Delivery Instructions Details in Order Confirmation Emails - It sends delivery instructions details in order confirmation emails, which you can see in the below screengrab.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Enhanced Ecommerce
Real Time Event
Backend Order Tracking in Google Analytics
Shopping Behaviour
Checkout Behaviour
Product Performance
Sales Performance
Product List Performance by Category.
Home Page with Tags
GA - UA Tracking Code
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Google Universal Analytics
Enabled – Select “Yes” or “No” to enable or disable the module.
Account Id – Enter your Google Account Id.
Anonymize Ip – Sets the parameter anonymize in tracking. If set to yes, tells Google Analytics to anonymize the information sent by the tracker objects by removing the last octlet of the IP address prior to its storage.
Domain Auto – Enable/Disable to show ‘auto’ as domain name, when turned off, it shows the domain name itself.
Linker Accounts Enabled – Enable/Disable the linker accounts.
Base – Set “Yes” if you send base order data.
Ajax Add to Basket Enabled – Set “Yes” if you have AJAX add to basket enabled on your website.
Enable Enhanced Ecommerce – Select “Yes” to enable the enhanced ecommerce tracking.
Steps – You can select multiple steps here, these steps correspond to Magento onepage standard checkout steps. Also make sure you add these same steps in Google Analytics under Ecommerce settings by turning Enhanced E-commerce on.
Brand Attribute – You can select product attribute which you can use to set your brand names. This will be passed to Google for further reporting.
Brand Name – You can also pass hard coded brand name using this configuration settings.
Send Transactional Data Offline – Set “Yes” to send data on order creation only. This feature could be useful if your payment gateway show their own success instead of Magento order confirmation page.
Send Transactional Data Only on Invoice Creation – Set “Yes” to send data on invoice creation only. This feature could be useful if you take either payment on dispatch or your payment gateway show their own success page instead of Magento order confirmation page.
Send Phone or Admin Orders – Enable this feature only if you want to send admin or phone orders on order creation.
Source – You can add your source here to pass this to Google for admin orders.
Medium – You can add your source here to pass this to Google for admin orders.
Send Product Impression on Scroll – Enable this feature when you have loads of products on product listing / category page.
Product item class on category / product listing page – Make sure this product class item heirarchy is as unique as possible for example for luma theme you can use div.products ol.product-items li.product-item
Debugging – Set “Yes” to generate GA.log in var/log directory to log all transactional data which we send to Google using measurement protocol.
Click Admin at the top of any Analytics page.
Select the view for which you want to enable Enhanced E-commerce reporting.
In the view column, click E-commerce Settings.
Under Step 1, Enable E-commerce, set the status to ON.
Click Next Step.
Under Step 2, Enhanced E-commerce Settings, set the status to ON. When you turn this option on:
You can see the Enhanced E-commerce reports in the conversions section.
The older, older category of E-commerce reports is no longer available.
You can turn this option off to restore the older category of E-commerce reports.
Optionally, enter labels for the checkout steps that you have defined in your Magento steps configuration. Please see screenshot below for reference
Click Submit.
Real Time Event - You can view the tracked events from GA > Realtime > Events.
Backend Order Tracking in Google Analytics - You can track admin orders by selecting "Yes" for "Send Phone or Admin Orders" from Admin > Stores > Configuration > Scommerce Configuration > Google Universal Analytics > Enabled Enhanced Ecommerce - "Yes".
Shopping Behaviour - You can see the shopping behaviour from GA > Conversion >Ecommerce >Shopping Behaviour.
Checkout Behaviour - You can see the checkout behaviour in GA with billing & shipping method, payment method and transactions details from GA > Conversion
> Ecommerce > Checkout Behaviour.
Product Performance - To view the product performance go to GA > Conversion > Ecommerce > Product Performance.
Sales Performance - To view tracked sales performance go to GA > Conversion > Ecommerce > Sales Performance.
Product List Performance by Category - You can view the product list performance from GA > Conversion >Ecommerce >Product List Performance.
Home Page with Tags - In Tag Assistant tool you can see the fired tags.
GA - UA Tracking Code - In the below image you can see the UA tracking id's added from Admin > Stores > Configuration > Scommerce Configuration > Google Universal Analytics > Account Id - UA -33387561-9.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Social Booster - Facebook Settings
Social Booster - Twitter Settings
View Custom Field Screen
Create Competition
Add Fields in Competition Form
Add Custom Fields
Design
Facebook Settings
Twitter Sharing
Email Template for Competition Entry Email
Choose Winner
View Entrants
Competition Form
Social Sharing Links on the Form
Competition Entry Confirmation Email
Newsletter Subscription Confirmation Email
Competition Winner Confirmation Email
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Competition
Enabled – Select “Yes” or “No” to enable or disable the module.
Enable Captcha on Competition Form – Please select “Yes” or “No” to enable/disable captcha on the competition form.
Subscription to Newsletter on Form Submission – Please select “Yes” or “No” to enable/disable newsletter subscription on the competition form.
Enable (Yes/No) – Please select “Yes” or “No” to Facebook sharing for competitions global level.
Enable (Yes/No) – Please select “Yes” or “No” to Twitter for competitions on global level.
Enable (Yes/No) – Please select “Yes” or “No” for competition email.
Email Sender (Textbox) – Please add email sender for competition email.
Email Template for competition entry email – Please select dropdown to select default global level competition entry email template from the available list of templates. A default template will be added with the extension install.
You can create, update and delete custom fields from Admin > Competition > Custom Fields. The grid will have below columns:
ID – This will be custom field code.
Field code – This will be custom field code.
Field Title – This will be custom field title.
Field Type – This will be custom field type.
Action – Edit/Delete
View Custom Field Screen - Click on "Add New Custom Field" will redirect you to detailed view custom field page and by filling all the required details you can create a new custom field. It will have below tabs: -
Field Information
Field Code (text box) – This will be mandatory and unique. No spaces or special character will be allowed, and it will be all lower cases just like attribute code and will not be editable once created.
Display Name/Title (text box) – Name/Title for the custom field which will be displayed on front end in competition form.
Type (drop down) – This will be a drop down to select the type of the field, and it won't be editable once created.
Text
Text area
Checkbox
Radio Button
Dropdown
Multi Select
Date Picker
Maximum Character allowed (text box) – This will be only visible, if the type is Text or Text area. User will be able to define max character for the field.
Options(grid) – This will be only visible, only if the type is Checkbox or Radio or Dropdown or Multiselect. User will be able to relative options here. The grid will have the following columns: -
Is Default
Value
Label default store view
All other available store views
Delete/Remove (action)
Answer (text box) – This will be an optional field for adding answer. If the type is date picker then the date format for answer should be correct.
You can update, delete and create a new competition from Admin > Competition > Competitions.
The grid will have below columns: -
ID – This will be competition ID. System generated
Name – This will be competition name/title
URL Key – This will be competition URL Key
Store View – This will be a store view drop down for to select stores for competition.
Status – Competition status (active/disabled)
Start date – Start date for the competition
End date – End date for the competition
Created date – Created date for the competition
Updated date – Updated date for the competition
Action – Edit/Delete
Create Competition - Click on "Add New Competition" will redirect you to detailed competition page. It will have below tabs: -
Competition Name - Enter the competition name. The name will appear on the front-end competition form.
Competition URL - Enter the URL. This URL will be used to open the completion form on the front-end.
Competition Description - Add the description. This description will appear on the front-end competition form.
Competition Store – Multi select filled with values.
Include Name in Form – Dropdown, Include Name in Form (Yes/No)
Competition Status – Drop Down, Competition Status (Active/Disabled)
Competition Meta Title - Enter meta title
Competition Meta Description – Add meta description.
Competition Meta Keywords – Keywords
Competition Start Date – Date picker
Competition End Date – Date picker
Competition form Submit Button Label
Add Fields in Competition Form - To add fields in competition form go to Admin > Competition > Competitions > Add Fields in Competition Form. It will have the fields: -
ID
Field Title
Field Type
Action
Sort Order
Add Custom Fields - You can add fields from Admin > Competition > Competitions > Add Fields in Competition Form > Click on "Add Fields" > Select fields and Click on "Add Selected Fields". This screen will have all the available custom fields in a grid form and user will be able to select fields to add to the competition form.
Checkbox to select fields
Field Code
Field Name/Title
Field Type
Field Position – This will be editable numeric field and will decide the display position for the competition form. This is specific to competition form.
Design - This tab will display two drop downs with all the static block where user will be able to select static block for the competition entry page and success page from Admin > Competition > Competitions > Add Fields in Competition Form > Design.
Static block for Competition Entry Page – Please select static block for competition entry page on front end.
Static block for Competition Entry Thank you page – Please select static block for competition entry page on the front end.
Facebook Settings – This tab will only be visible, if enabled from Admin > Stores > Configuration > Scommerce Configuration > Competition > Social Booster-Facebook settings
Enabled (yes/no) – Please select “Yes” or “No” for Facebook sharing for the competition.
Twitter Sharing – This tab will only be visible, if enabled from Admin >Stores > Configuration > Scommerce Configuration > Competition > Social Booster- Twitter Settings
Enabled (yes/no) – Please select “Yes” or “No” for Twitter sharing on competition form.
Twitter Text – Please add description of your promotion which appears on the sharing popup.
Hashtags – Please add hashtag of your promotion which appears on the sharing popup at the end of the description.
Email Template for Competition Entry Email – This will be a dropdown to select default competition level competition entry email template from the available list of templates. If nothing selected, then it will pick up template defined in section Admin > Stores > Configuration > Scommerce Configuration > Email.
Choose Winner – It generates winners only when the competition has ended. This will be determined by competition end date and will have below two elements.
Number of winners – Please add number of winners you would like to generate for the competition.
Generate Winner Button – To generate a winner, click on "Generate Winner" button. It resets manually generated winners and selects a new winner randomly. This is a random process, and doesn't validate any answer or entries.
You can generate winner manually from Entrants grid by selecting "Mark Winner" under "Actions" from Admin > Competition > Entrants. Also you can delete and view entrants by selecting "View" from "Actions" . The grid will have below columns:-
User Email
Username
Competition Name
Store
Winner
Date Entered
Action
View Entrants – To view entrants details go to Admin > Competition > Entrants> Select "View", it opens View Entrants page from where you can select winner ma by selecting "Yes" from Mark Winner drop-down. It selects winner manually and it doesn't validate any answer or entries.
Competition Form - When you create a competition from Admin > Competition > Competitions, then based on defined URL key it opens the competition on the front-end site with the social sharing options, which you can see in the below screen grab.
Social Sharing Links on the Form - After entering into the competition when you share the competition on the social sites, it increases the possibility to win the competition. It allows you to enter five entries in the same prize draw competition by following / liking / sharing the prize draw or competition on Facebook and Twitter, also you can enable/disable the social sharing options from the back-end.
Competition Entry Confirmation Email - It sends an email to users to confirm their entry into the prize draw or competition.
Newsletter Subscription Confirmation Email - When you select "Yes" for " Subscription to Newsletter on Form Submission " from Admin > Stores > Configuration > Scommerce Configuration > Competition, then it sends newsletter subscription confirmation email to users.
Competition Winner Confirmation Mail
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Enable Tracking for Other Sites – This will enable other sites variables ( instead of retail site variables.
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Enable Enhanced Conversion:- Set "Yes" to enable enhanced conversion to send PII data to Google Adwords to target actual customers. You need to turn on enhanced conversions in Google Adwords.
Enable Consent mode - This setting activates . It lets us control how Google tags use user consent and protect user data
Cookie mapping - This setting defines the mapping between user preference cookies and the corresponding Google Consent Mode parameters ad_storage, ad_user_data, ad_personalization, analytics_storage Cookie preference cookie could be set using our or any Consent Management Platform (CMP).
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 .
GDPR Cookie Key – You can add name of your GDPR cookie here for our the name of cookie key is cookie_accepted but if you are using other GDPR extension then please check with extension developer
Now for the final step import our Google Analytics 4 JSON file in your GTM to get all the configurations for GA4. Once done you will see data flowing into Google Analytics 4. Learn more about .
Sign in to your .
Click Agree to the compliance statement. By turning on enhanced conversions you confirm that you comply with our . The apply to your use of enhanced conversions.
Note: Once you have accepted the Terms of Service, it can take up to 5 days for your Google Tag Manager account to be enabled for enhanced conversions. Make sure your conversion tracking tag is set up in Google Tag Manager and then check back in 5 days to see the enhanced conversions functionality enabled. Please for more details.
:- In this url we passed the cookie parameter "clickref" with the value "ab101". We can see this cookie being created in the below image:-
GDPR:-
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Application Name – It is the project name that you get from Google console. ( https://console.developers.google.com/ )
Security key (JSON) – Security key JSON file can be obtained from Google Console under account credentials.
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
Application Name – It is the project name that you get from Google console. ( https://console.developers.google.com/)
Security key (JSON) – Security key JSON file can be obtained from Google Console under account credentials.
You can create a transaction report in GA4 using custom reports to verify the transactions received. For more information, please
Google Analytics Data API (Used to access GA4 report Data)
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Display Feature – Enable/Disable the display feature plugin. For more information
Enable User Id – Enable/Disable User Id feature. Make sure this feature is enabled in Google Analytics first before enabling in Magento. For more information
Ecommerce Enabled – Enable/Disable the ecommerce plugin. For more information .
Linker Enabled – Enable/Disable the linker plugin to link cross domains. For more information .
Domains to Link – Add domain names or regular express for example ‘destination.com’, ‘dest3.com’ or /^example\.(com]|de|nl)$/ For more information .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Facebook Fan Page – Please add full URL of your Facebook page for example .
Facebook App ID – Please add Facebook application Id this can be obtained by creating app by clicking on the following URL () after login to your Facebook account.
Twitter Account – Please add unique id of your twitter account. For example our twitter account is so you just need to put Scommerce Mage.
Facebook Share Name – Please add name/title for the promotion which appears in bold on the sharing popup. For more info see
Facebook Image upload for sharing pop up – Please upload image for the promotion which appears on the sharing poup. For more info see
Facebook Share Caption – Please add caption for the promotion which appears above share description and below the name of the promotion on the sharing popup. For more info see
Facebook Share Description – Please add description for the promotion which will appears above share description and below the name of the promotion on the sharing popup. For more info see
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Surcharge for Multiple countries/Multiple payment methods
View Surcharge on the Order Details View Page
Surcharge for Admin Orders
Surcharge Percentage/Fixed Amount Per Payment Method and Country
View Surcharge on the Checkout Page
Surcharge with the Free Shipping
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Surcharge
Enabled – Select “Yes” or “No” to enable or disable the module.
Surcharge Label – This label text gets used in the frontend of the website which will be shown on basket, review, invoice, order, shipment, email confirmation and refund.
Surcharge Amount Type – This option allows you to choose fixed amount or percentage value. Percentage value gets calculated based on the grand total or subtotal attribute been selected.
Surcharge Percentage or Fixed Amount – This is the surcharge or additional fee which will be shown to the customer based on surcharge amount type (fixed to percentage)
Surcharge Percentage or Fixed Amount per payment method or payment method and country - Fixed or Percentage amount, additional fee will be applied based on grand or subtotal attribute been selected per payment method or payment method and country. Example checkmo:3;cashondelivery:2 or checkmo:3:FR;checkmo:5:GB
Grand or Subtotal Attribute – This option allows you to choose whether you want to apply percentage additional fee on grand or subtotal. This will also apply on Minimum Order Total.
Minimum Order Total – This value will be checked / validated based on the
Grand or Subtotal Attribute value been selected.
Skip with Free Shipping – This option can be used if you don’t want to charge additional fee when the shipping price is zero. This is useful when you are charging additional fee based on the shipping country but when the shipping is free then you might not want to charge additional fee.
Tax Class - Please select the tax class from the drop-down list.
Shipping Countries – The additional fee will be applied only to the specific shipping country(s). Please select all if you want to charge additional fee for all shipping countries.
Payment Method – The additional fee will be applied only to the specific payment method (s). Please select all if you want to charge additional fee for all payment methods.
Please select the Payment Method, surcharge will be applied only for the selected payment method
Surcharge for Multiple countries/Multiple payment methods - You can set surcharge for multiple countries by selecting countries from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > General Settings > Shipping Countries, and multiple payment methods from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > General Settings > Payment Method.
View Surcharge on the Order Details View Page - You can see the applied surcharge on the order details view page from Admin > Sales > Orders > Select Order > Edit , under "Order Totals" section.
Surcharge for Admin Orders - In the below image you can see the added surcharge value for the order placed from the admin panel, Admin > Sales > Orders > Create New Order > Select User > Select Product > Add Product.
Surcharge Percentage/Fixed Amount Per Payment Method and Country When you set "Surcharge Percentage or Fixed Amount per payment method and country" to "checkmo:3:FR" from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Surcharge Percentage or Fixed Amount per payment method, then the fixed or Percentage amount, additional fee will be applied based on grand or subtotal attribute been selected per payment method or payment method and country.
checkmo:3:FR - It will add 3% additional fee on "Subtotal Including Tax" , will be applied for shipping country France and payment method Check Money order.
checkmo:5:GB - It will add 5% additional fee on "Subtotal Including Tax" , will be applied for shipping country UK and payment method Check Money order.
checkmo:3 - It will add 3% additional fee on "Subtotal Including Tax", and will be applied only for Check Money Order payment method and shipping countries selected from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Shipping Countries .
Set Different Surcharge for Countries - You can set different surcharge for countries from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Surcharge Percentage or Fixed Amount per payment method - checkmo:3:FR;checkmo:5:GB.
View Surcharge on the Checkout Page - When you select "Surcharge Amount Type" to "Percentage" , " Surcharge Percentage or Fixed Amount " to "10" and " Payment Method " to "Cash On Delivery"/"Check Money order" from Admin > Stores > Configuration > Scommerce Configuration > Surcharge, then it adds 10 % additional fee on "Subtotal Including Tax" based on selected payment method and shipping countries. To add shipping countries go to Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Shipping Countries - Select Shipping Countries from the drop-down list.
Surcharge with the Free Shipping - You can skip surcharge for the free shipping orders from Admin > Stores > Configuration > Scommerce Configuration > Surcharge > Skip with Free Shipping - "Yes". This option can be used if you don’t want to charge additional fee when the shipping price is zero.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Manage FAQ's
Manage FAQ Category
FAQ Categories
FAQ Product
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > FAQ
Enabled – Select “Yes” or “No” to enable or disable the module.
Enable FAQ Site Wide – Set “yes” to enable FAQ page.
Site Wide FAQ Title – Title of FAQ page if FAQ for site enabled.
Enable FAQ for Products – If this is set to yes then FAQ Tab will appear on product pages.
Product FAQ title – Tab title on product page if FAQ for product enabled.
Admin Email – Email to send notification about new questions created from product front page.
FAQ Email Template – Email Template for sending to admin with the details when someone asks a question.
Manage FAQ's - You can manage, update and add new FAQ's from Admin > FAQ > Manage FAQ's. To add new FAQ's follow the below settings:-
Add New FAQ: Add new FAQ > General Tab
Status – Status of FAQ Active/Inactive
Title – Title for FAQ
Most Frequently – Set "Yes" if the question is asked frequently.
Category – Category for FAQ
Sort Order – To define sort order for FAQ
Add FAQ Answer: To add answer go to Admin > FAQ > Manage FAQ's > Add new FAQ > Answer > Save FAQ.
Answer – Add answer to the FAQ
Add Meta Description /Keywords for FAQ's: You can add meta description/keywords from Admin > FAQ > Manage FAQ's > Add new FAQ > Search Engine Optimization.
URL key – URL for FAQ
Meta Keywords – Keywords for FAQ
Meta Description – Description for FAQ
Add Websites: To add websites go to, Admin > FAQ > Manage FAQ's > Add new FAQ > Websites.
Stores view – Select stores where FAQ will be visible
Select Products for FAQ: You can select product from Admin > FAQ > Manage FAQ's > Add new FAQ > Selected Products > Save FAQ.
Select Product – Select products to associated FAQ’s.
Manage FAQ Category: You can manage, update and add new category for FAQ's from Admin > FAQ > Add new FAQ Category. Below is the configuration to add new FAQ category:-
Add New FAQ Category: Add new FAQ Category > General Tab
Status – Status of FAQ Category Active/Inactive
Title – Title for FAQ Category
Category Icon – Icon for Category
Sort Order – To define sort order for FAQ
Add Meta Description/Keywords for FAQ Category: You can add meta description/keywords from Admin > FAQ > Manage FAQ's > Add new FAQ Category > Search Engine Optimization.
URL Key – URL for FAQ Category
Meta Keywords – Keywords for FAQ Category
Meta Description – Description for FAQ Category
FAQ Category in Websites: To add websites go to, Admin > FAQ > Manage FAQ's > Add new Category > FAQ Category in Websites.
Stores view – Select stores where FAQ will be visible.
FAQ Categories - When you enable the module and set "Yes" for " Enable FAQ Site Wide" from Admin > Stores > Configuration > Scommerce Configuration> FAQ , then on the front-end, it shows FAQ page with categories.
FAQ Product - Select "Yes" for " Enable FAQ for Products" from Admin > Stores > Configuration > Scommerce Configuration > FAQ
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Handling Fee on Order Detail View Page
Add Handling Fee at Product Level
Handling Fee on Cart Page
Handling Fee On Checkout Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Handling Fee
Enabled – Select “Yes” or “No” to enable or disable the module.
Handling Fee Label – Please add the label displayed in totals.
Handling Fee on Order Detail View Page - You can see the handling fee under "Order Totals" section from Admin > Sales > Orders > Select Order > View
Add Handling Fee at Product Level - To add handling fee go to, Admin > Catalog > Products > Select Product > Handling Fee.
Handling Fee on Cart Page - In the below image you can see the handling fee under "Summary" section.
Handling Fee on Checkout Page - On the front-end checkout page the handling fee will be shown under "Order Summary" section.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Selected WDYHAU Option in Orders Grid
WDYHAU Details at Customers Level
WDYHAU Details on the Sales Order View Page
“Where did you hear about us?” Drop-down Options in the Back-end
WDYHAU Option on the Registration Page
WDYHAU option on the Checkout Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Where did you hear about us?
Enabled – Select “Yes” or “No” to enable or disable the module.
Dropdown options – Please add the WDHAU options for customers and administrators to choose during checkout and creating order via admin respectively. There should be semicolon (;)separated values for example Google;Facebook;Twitter;Others
Drop Down Label – Please add the label.
Other Label – Please add the label for other option.
Field Is Required On Customer Registration- Select "yes" to set the Where did you heard about us feild as required during signup.
Selected WDYHAU Option in Orders Grid - You can see the selected "Where did you hear about us?" option at Admin > Sales > Orders grid.
WDYHAU Details at Customers Level - To see the "Where did you hear about us?" option at customers level go to Admin > Customers > All Customers > Select Customer > Account Information > Where did you hear about us?
WDYHAU Details on the Sales Order View Page - The selected WDYHAU option will be shown on order view page under "Account Information" section from Admin > Sales > Select Order > View.
“Where did you hear about us?” Drop-down Options in the Back-end - When you enable the module, then it shows WDYHAU drop-down option in the back-end at Admin > Sales > Create New Order > Select Customer > Select Product > Select "Where did you hear about us?" option.
You can create and use affiliate codes using this module. The extension creates a session cookie when referral_source is passed with the URL. It expires only when the browser is closed. Cookie value is set based on the parameter passed with the URL. Also, this value is captured in the sales order grid against the order under 'Where Did you hear about us'.
A session cookie named referral_source is created in the browser with value SCOMMAG. Please refer to the image below:-
Once the order is placed the cookie value is captured against the order in the sales order grid. Please refer to the image below:-
WDYHAU Option on the Registration Page - You can define the "Where did you hear about us?" drop-down options from Admin > Stores > Configuration> Scommerce Configuration > Where did you hear about us? - Google; Twitter; Facebook; YouTube; Others, which will be shown on the registration page.
WDYHAU option on the Checkout Page - You can see the "Where did you hear about us?" option on the checkout page.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Shipping Methods
Admin Panel
My Account Section
Shipment Email
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Tracking Link
Enabled – Select “Yes” or “No” to enable or disable the module.
URLs – Enter the shipping method and the URL. The URL should contain the {number} parameter which will be used to pass the tracking number to the shipping carriers tracking site where the shipment can be tracked.
Additional Carriers- Add the additional carriers which will be available in the carrier selector dropdown list while creating a shipment.
Go to Admin>Sales>Order and select an order then click on 'Ship' to create a shipment. Scroll down to find shipping information then select the shipping carrier from the carrier dropdown list and enter the tracking number for that carrier. Select email copy of shipment checkbox then generate the shipment.
Admin Panel:- Once the shipment is generated you can go to the order then from the left menu select shipments and view the generated shipment. You should see the tracking number consists a link, and once you link on that link it will take you to the shipping carriers tracking site with your tracking number.
My Account Section:- Once the shipment is generated customers can view the shipmen in the My Account>My Orders>Order Shipments section where the trackings numbers with links will be available as per the shipping carriers selected with the shipment.
Shipment Email:- Once the shipment is generated the shipment email will be sent to the customer with tracking links to each of the shipping carriers.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Stock Status Rules Grid
Add New Rule
Custom Stock Status and Rule Name at Product Level
Salable Quantity
Assign Custom Stock Status Rule to Products Automatically or Manually
Manually
Automatically on Cron Run
Multi Websites Selection
Custom Stock Status Product Attribute
Custom Stock Message for Simple Products on the Product Page
Custom Stock Message for Configurable Products on the Product Page
Custom Stock Message on the Cart & Checkout Pages
Custom Stock Message on Related, Cross-sells and Up-sells Products
Status Message in the Order Confirmation Email
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Custom Stock Status
Enabled - Select “Yes” or “No” to enable or disable the module.
Custom Stock Message on Related Product – Select “Yes” to enable the custom stock message on related product.
Custom Stock Message on Up-Sells Product – Select “Yes” to enable the custom stock message on Up-sells product.
Custom Stock Message or Cross-Sells Product – Select “Yes” to enable the custom stock message on Cross-sells product.
Cron Schedule – Schedule cron job to automatically update custom stock status based on correct rule.
Stock Status Rules Grid – This will be a grid in admin > Catalog > Stock Status Rules, with below column: -
ID: ID, this is auto generated and non-editable
Rule Name: Name of the rule
Status: Status of the rule, Enabled/Disabled
Website: Name of the website
Priority: Priority of the rule
Action: Edit/Delete
Add New Rule – You can add new rule by clicking “Add New Rule” from Admin > Catalog > Products > Stock Status Rules >Add New Rule, it redirects to the detailed view for Rule from where you can create a new rule by filling the required fields.
Rule Name - Add generic name for rule
Website - Select website from multi-select, from here you can select multiple website
Enable - Please enable/disable rule by slider
Priority - You can add priority (int) for the rule. In case of conflicting rules for a product the lowest number will have highest priority like 0 will be given priority over 1. If no priority defined then any random rule will apply
Conditions - Add the conditions to match, leave blank for all products
Default Stock Message - You can select default stock message from the drop- down, which will be shown on the frontend and replace availability (In Stock / Out Stock) message.
Apply Stock Quantity Ranges: You can enable it by turning "On" this option. If it is enabled then it shows below grid where you can define stock ranges and corresponding status. Please note that if the range is not provided for given stock quantity then the default message will be shown.
Custom Stock Status and Rule Name at Product Level - You can view the associated rule to product from Admin > Catalog > Products > Select product.
Salable Quantity - On product save it updates the stock status message based on the salable quantity and the quantity rule. To view salable quantity go to Admin > Catalog> products > Select Product > Product Salable Quantity.
Manually - You can assign rules to product manually from Admin > Catalog> Products > Select Product > Rule Name - Select rule from the “Rule Name” drop-down list.
Automatically on Cron Run - You can schedule the Cron job from Admin > Stores > Configuration > Scommerce Configuration > Custom Stock Status, on cron run the rule will be automatically assigned to products based on the matched condition and set the correct message.
Multi Websites Selection - It fully supports multi-store and websites, you can select websites from Admin > Catalog > Products > Select Product > Product in Websites- check websites.
Custom Stock Status Product Attribute - You can add values to custom stock status product attribute from Admin > Store >Attribute > Product> Product Attribute>Select - custom_stock_status > Properties > Add option, the added values will be populated in the default /custom stock status message drop-down.
Custom Stock Message for Simple Products on the Product Page – It displays stock status message for simple product based on salable qty and quantity ranges rule.
Custom Stock Message on the Cart & Checkout Pages – You can see the stock status message on cart and checkout pages.
Custom Stock Message on Related, Cross-sells and Up-sells Products – When you select “Yes” for “Custom Stock Message on Related Product / Up-Sells/ Cross- Sells” from Admin > Stores > Configuration > Scommerce Configuration > Custom Stock Status, then it shows stock status message on related/up-sells/cross- sells products.
Status Message in the Order Confirmation Email – In the order confirmation email you can see the added stock status message.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Ajax Add to Wishlist - Ajax SignIn Popup
Ajax Add to Wishlist – Ajax Create an Account Popup
Ajax Add to Wishlist – Mini Cart Drop-Down Slider
Limit The Quantity of Products to Show In The Cart Slider
Ajax Add to Wishlist – Ajax Add to Wishlist Popup
Ajax Add to Wishlist – Ajax Add to Wishlist Confirmation Message
Ajax Add to Wishlist – Wishlist Products Under my Account – My Wishlist Section
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Enabled - Select “Yes” or “No” to enable or disable the module.
Enable Ajax Wish List – Select “Yes” or “No” to enable or disable the Ajax Wish List.
Enable Ajax Login – Select “Yes” or “No” to enable or disable the Ajax Login
Enable Slide Down Mini Cart – Select “Yes” or “No” to enable or disable slide down effect of mini cart after adding item to the basket.
No more waiting to be redirected to the Sign In page. When you click on Sign in a pop-up will appear on your screen and you will be able to login to the site without reloading the page. It is great for ease of access as well as saves time. Also, it does not matter which page you are browsing the pop-up will work with most pages. To enable the Ajax login feature first login to your admin panel.
Enables users to create an account or register on the website via a pop-up. Initially upon clicking on create an account users were redirected to a different page but now you can stay where you are browsing and create an account without having to reload or redirect the page. It makes convenient for new users to gain access.
You can toggle this feature on or off by loggin into your admin panel and then going to the path Stores > Configuration > Scommerce Configuration > Ajax Login & Wishlist. There will be flag named Enable Ajax Login you can select “Yes” or “No” from the drop-down that will turn this feature on or off.
When products are added to the cart a drop-down slider appears in the mini cart. It makes easy for users to keep track of their products that they have added to the cart. You can scroll down to browse your products in the cart. The number of products to appear in the list can be changed from settings.
This feature can be enabled or disabled from the admin panel. First Login to your admin panel then go to the following path Stores > Configuration > Scommerce Configuration > Ajax Login & Wishlist. There you will have an option named
Enable slide down mini cart, from the drop-down menu select “Yes/No” to Enable/Disable this feature.
Also, you can limit the quantity of products to show in the cart slider. You can do that by going into Stores > Configuration > Sales > Checkout > Shopping cart sidebar. There you will see an option named Number of items to display scrollbar. Here enter your quantity and the scrollbar will appear after that many number of products are added to the cart.
Generally, when a product is added to the wishlist you are redirected to another page but while this setting is enabled you will be able to add products to wishlist without redirecting or reloading the page. If you are not signed In, a pop-up will appear on the screen saying either sign in or create an account. This feature can be enabled
or disabled by log in to your admin panel then going to the path Stores > Configuration > Scommerce Configuration > Ajax Login & Wishlist. Here you will see an option named Enable Ajax Wish List, from the drop-down select Yes/No to Enable/Disable this functionality.
While this option is enabled when any product is added to the cart you will receive a pop-up message on the screen showing your product has been successfully added to the wishlist. Keep in mind you need to be logged in to add products to wishlist.
All the products added to the wishlist should be visible under your account under the wishlist section. Add multiple products to Wishlist without reloading the page every time and view them listed in the wishlist section of your account.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Cancel Order from My Account Section
Cancel Order Popup
Notification Message for Cancel Order
Cancel Order status (Cancelled)
Order Cancellation Email
Guest Form
Order ID
Billing Last Name
Find Order By
Order Information Page
Cancel Order Successfully
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Cancel Order
Enabled - Select “Yes” or “No” to enable or disable the module.
Label – Please provide label text for cancel order link which will be shown on the frontend.
Email Sender – Please enter/sender from email address for Order Cancellation email.
Email Template for Guest – Please select email template for sending cancellation email to guest customer.
Email Template for Registered Customer – Please select email template for sending cancellation email to registered customer.
Email BCC – Please add CC email addresses for Order Cancellation emails in comma separated format.
Reasons – Select order cancellation reason from the dropdown or select other to define your own reasons. Option “Other” will display a text box on front end, where you can add reason of cancellation.
Notification Message – Enter notification message you want to show on frontend for order cancellation.
Number of hours to cancel – Please add number of hours valid for order cancellation.
Cancel Order from My Account Section - When you enable the module then it shows "Cancel Order" link on the front-end My Account > My Orders section.
Cancel Order Popup - When you click "Cancel Order" button from My Account > My Orders section, it displays a pop up, from where you can add/select your own reasons of order cancellation and by clicking "Cancel Order" button you can cancel order.
Notification Message for Cancel Order - After the order cancellation it shows notification message on the front-end.
Cancel Order status (Cancelled) - When you cancel the order then it automatically updates the order status from Pending to Cancelled.
Order Cancellation Email - After the successful order cancellation, it sends an email notification to the administrator and the customer, below is the sample email for the same.
Order ID - enter the order Id, you want to cancel.
Billing Last Name - enter the last name.
Find Order By - select the Email / ZIP code.
Email - enter the email address.
Order Information Page - After filling the Orders and Returns form when you click “Continue” button, it redirects on order information page, from where you can cancel the order by clicking “Cancel Order” button.
Cancel Order Successfully - Once the order is cancelled, it displays the successful cancellation message.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Create Facebook App Id
Create Google App Id
Social Login Options on the Front-end
Social Login Options on the Sign In Page
Social Login Options on the Registration Page
Social Login Options on the Checkout Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Social Login
Enabled – Select “Yes” or “No” to enable or disable the module.
Send Password to Customers – Set yes or no for send password to customers.
Show Social Login Buttons on – Select where all you want to show the social login options.
Use Popup Login – Set yes or no to enable/disable the popup.
Popup Links Selector – Comma-seperated. Compatible: Etheme_YourStore [ dropdown-menu.dropdown-menu—xs-full ]
Popup effect – Select pop up appearing effect.
Style Management – Select color for the popup.
Custom CSS – Enter your Custom CSS.
Enabled – Select “Yes” or “No” to enable or disable the module.
Facebook App Secret – Enter your Facebook App secret.
Valid OAuth redirect URLs – Enter the redirect URLs.
Sort Order – Enter the sort order for display.
Enabled – Select “Yes” or “No” to enable or disable the module.
Client Secret – Enter your Secret Id.
Redirect Urls – Enter the redirect urls.
Sort Order – Sort order for display.
Specify the “Display Name” and “Contact Email” for your app. After that, click the “Create App ID”.
Go to the Settings > Basic tab to configure your app. The App ID and App Secret will be generated automatically. Fill the App Domains field and choose your app Category.
Click on the “Add Platform” button to choose the platform for your social apps.
After clicking on the Add Platform button you will see the grid with various platform types. Please select Web.
After specifying the platform type, insert your website URL and click on the “Save Changes” button.
Enable the “Client OAuth Login” from Facebook Login > Settings and provide the “Valid OAuth Redirect URLs”.
To apply the configuration, change the Status from “In development” to “Live”.
Insert your Facebook App Id and Secret Key in Facebook settings and Save the configuration.
Specify your “Project name”, the project ID will be generated automatically.
Go to the Credentials tab and create a client ID to integrate your website with Google.
Insert your website URL in the required field. In the field “Authorized Redirect URLs” add redirect website URL. Then, press the Create button.
Please copy the Client ID and Client Secret. Insert your API KEY (Client ID) and API Secret (Client Secret) in the appropriate fields in the backend Google settings and save the configuration.
Social Login Options on the Front-end - When you enable the Facebook and Google logins and select the pages to show social login pop ups from Admin > Stores > Configuration > Scommerce Configuration > Social Login > "Show Social Login Buttons On" - Customer Login Page/ Customer Create Page/Social Popup Login/Shopping Cart/Checkout, then it shows social login options on the respective pages.
Social Login Options on the Sign In Page – When you click on “Sign in with Google” then it opens Sign in with Google page.
After successful login, it redirects to My Account page.
Social Login Options on the Registration Page
Social Login Options on the Checkout Page
Table of Contents
Installation via app/code
Installation via Composer
General Settings
360 view settings
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Product 360 view
Enabled – Select “Yes” or “No” to enable or disable the module.
Enable Controls – Select “Yes” or “No” to enable or disable the navigation controls on 360view image.
Enable Auto Play – Select “Yes” or “No” to enable or disable automatically spin 360 view image on page load .
Autoplay Speed – Enter the speed for automatic spin of 360 view image. It controls the Speed of changing frames for autoplay in milliseconds
Drag Speed – Enter the speed with which user can drag on the image. It controls the Speed Factor of changing frames on drag event
Reverse Autoplay – Select “Yes” or “No” to enable or disable reverse autoplay.
Enable Fullscreen Button – Select “Yes” or “No” to open or close 360 view spin in fullscreen.
Magnifier – Select the Magnifier stregnth from dropdown which controls the zoom for the image.
Button Position – Select the placement of 360 view button on the frontend.
Custom Button Image– Upload custom 360 view button image.
Max Popup Width – Enter the maximum width of 360 view popup.
Login to admin panel and go to Catalog>Products, select a product then click edit from the Action column. Scroll down to find '360 View Images' and upload the images as shown in the below screengrab:-
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Subcategories Widget
Display Mode Selection Drop-down “Subcategories Only”
Sub-categories Settings Dropdown
Subcategories Grid View on the Front- end
Subcategories List View on the Front- end
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Enabled - Select “Yes” or “No” to enable or disable the module.
Subcategories Background Color – Please select the Subcategories background colour.
Thumbnail Placeholder – Please choose the file of Thumbnail placeholder
Thumbnail width – Please add the Thumbnail width.
Thumbnail height – Please add the Thumbnail height.
Subcategories widget will allow you to display subcategories in a Grid/list view on any page. Navigate to Content > Pages, edit the page that where you want to display the subcategories. Go into Content and then simply click on insert widget and you will have options such as widget type where you have to select the widget named “Subcategories List” then select the category and the number of columns you want to display the subcategories in. Then Lastly click on insert widget.
Go to any of the categories page where you want to display subcategories on by navigating to Catalog > Categories. Next go to display settings where you can select the display mode as “subcategories only” so that the page can display subcategories instead of products
Go to any of the categories pages where you can select the settings by going into
Sub-categories settings dropdown. You can change the following settings: -
Thumbnail Category Image – Here you can upload a thumbnail image for the category.
Sub-category Short Description – You can add a short description here.
Number of columns – Select the number of columns you want to display your subcategories in.
After successfully enabling subcategories you can see them listed in a Grid view on the frontend. You can select the number of columns depending upon that the frontend will review the Grid view. To select the columns Navigate to Catalog > Categories and then select the category. Scroll down to Sub-Categories Settings. Here you will have the option to upload the thumbnail image, short description and number of columns. Please refer to the image below. Each of the subcategories will be listed with a description, background and image as defined by you.
Navigate to Catalog > Categories, select the category, and then scroll down to Sub-Categories settings. You can select the number of columns here. Similarly display the subcategories in a list view by selecting the number of columns as “1”. See the image below for reference.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Previous Purchase Grid
Hide Columns in the Previous Purchase Grid
Add One or Multiple Products to Cart Directly From the Grid
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Enabled – Select “Yes” or “No” to enable or disable the module.
Hidden Columns – You can hide one or multiple columns from the previous purchases grid. The columns that can be hidden are listed below:-
Qty(Quantity)
To hide one or multiple columns from the previous purchases grid please go to Admin> Stores> Configuration> Scommerce Configuration> Previous Products.Find the setting named Hidden Columns select one or multiple columns that you want to hide and save the settings.
Go to the website and login to your account then navigate to My Account section and from the left menu click on My Previous Products. This grid shows detailed information about all off your previous purchases. You can easily navigate through the list with the help of pagination and selectors. The previous purchases grid will open as shown in the image below:-
Please go to Admin> Stores> Configuration> Scommerce Configuration >Previous Products and select the columns in Hidden Columns that you want to hide. For eg:- we have selected Thumbnail, QTY, Last Order Price(Incl taxes) and Last Order Price(Excl Taxes). You can see in the image below that these columns are now hidden in the grid.
If you want to add one product to cart then click on the checkbox in the selector column then click on Add to Cart from the rightmost column Whereas if you want to add multiple products to cart then select the products that you want to purchase then click on the Add All Selected to Cart button either on the top or bottom of the list.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Infinite Scroll with ‘Load More Button’ on the Category Page
Infinite Scroll with Auto Loading on the Category and Search Pages
Auto Loading on the Category Page
Auto Loading on the Search Page
Infinite Scroll with ‘Load More Button’ and Page Number
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Infinite Scrolling
Enabled - Select “Yes” or “No” to enable or disable the module.
Loading Type - Select loading type “Load Automatically” or “Load with Button”.
Button Label - Enter button label. This will be shown only when the “Loading Type” is set to “Load with Button”.
Button Label Font Color - Set font color for "Load with Button" which appears on site front-end.
Button Label Background Color - Select button label background color. This will be shown only when the “Loading Type” is set to “Load with Button”.
Button Label Size – Define font size for the “Load with Button” which appears on the site.
Display Page Numbers (Yes/No) – Select “Yes” to show the page information on the side panel.
Grid Dom Class – This is the class for grid view of product listing pages.
List Dom Class – This is the class for list view of product listing pages.
Infinite Scroll with ‘Load More Button’ on the Category Page – You can display the “Load More Button” on the category page by selecting “Load with Button” option from Admin > Stores > Configuration > Infinite Scrolling > Loading Type.
Infinite Scroll with Auto Loading on the Category and Search Pages – You can implement auto loading on the category and search pages by selecting the option "Load Automatically" from Admin > Stores > Configuration > Infinite Scrolling > Loading Type.
Auto Loading on the Category Page
Auto Loading on the Search Page
Infinite Scroll with ‘Load More Button’ and Page Number – To display Load More Button with page numbers on category and search pages first select option “Load with Button” from Admin > Stores > Configuration > Infinite Scrolling > Loading Type and then select “Yes “ from Admin > Stores > Configuration > Infinite Scrolling > Display Page Numbers. This will display page numbers with Load More Button as shown in screen grab below.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
General Settings
Lazy Loading on the Homepage
Home Page Excluded from Lazy Loading
Lazy Loading on the Category Page
Lazy Loading on the Search Page
Lazy Loading on the Cart Page.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimiser Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Lazy Loading
Enabled - Select “Yes” or “No” to enable or disable the module.
Loading Icon – Show a preview image before the real image loads.
Skip Images Count by page category – Enter a valid image count to skip the images from lazy load. Based on the count this option will decide how many images to load without lazy loading.
Ignore Images that Contain – Provide a part of an image tag content into the field to exclude the image from the lazy load.
Exclude Pages – Select the page(s) from multi-select options to exclude from the lazy load.
Lazy loading for product only on category page – Select “Yes” to apply lazy load on product images only on category page.
Lazy Loading on the Homepage – To implement lazy loading on the homepage, enable the module from Admin > Stores > Configuration > Lazy Loading- Enable "Yes".
Home Page Excluded from Lazy Loading – You can exclude homepage images from lazy loading by selecting option "Home Page" from Admin > Stores > Configuration > Lazy Loading > Exclude Pages .
Lazy Loading on the Category Page – To implement lazy loading on the category page, enable the module from Admin > Stores > Configuration > Lazy Loading - Enable "Yes".
Lazy Loading on the Search Page – You can implement lazy loading on search page from Admin > Stores > Configuration > Lazy Loading - Enable "Yes".
Lazy Loading on the Cart Page – You can implement lazy loading on the cart page by enabling the module from Admin > Stores > Configuration > Lazy Loading- Enable "Yes".
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Vat Exempt Settings
Create New Reason
Declaration Statement on Order View Page
VAT Exemption Details on Order View Page
VAT Exemption Option for Admin Orders
Include or Exclude Product
VAT Exempt Form on the Cart Page
VAT Exempt Message on the Cart Page
VAT Exempt Option on the Checkout Page
VAT Exempt Discount
Shipping VAT…
VAT Exempt Discount on the Front-end
VAT Exempt Declaration Statement on the Front-end
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Vat Exempt Settings
Enabled - Select “Yes” or “No” to enable or disable the module.
Shipping VAT Exempt - Please Select "Yes/No" to include or exclude shipping from VAT exemption (Default - No).
Declaration Statement - Please provide declaration statement. This will be shown in admin along with order details and on the frontend in My Account section.
VAT Exempt Title - Please provide title. This will be shown on the checkout page before VAT Exempt message and declaration form (Default - VAT Exempt).
Basket VAT Exempt Message - Please add VAT exempt message. This will be shown on the cart/basket page.
VAT Exempt Message - Please provide VAT Exempt message. This will be shown on the checkout page under VAT exempt section to users who are applying for VAT exemption. (Default - VAT Exempt products are in your basket so if you are disable or from eligible charity then you should be able to claim VAT exemption from here).
Terms and Condition Message - Please provide terms and conditions message. This will be shown on the checkout pages along with checkbox on VAT exempt declaration form.
Use Reason as Text Input- Set "Yes" to allow customers to enter their own custom reasons without selecting from the dropdown list
Show VAT Exempt - Set "Yes" to show vat exempt form on the checkout otherwise it will be hidden.
Next button text- Use this setting to change text for “Next” button on the checkout page.
Apply button text- Use this setting to change text for “Apply VAT exempt” button on the checkout page.
Cancel button text- SUse this setting to change text for “Cancel VAT exempt” button on the checkout page.
More info area- Set "Yes" to add more information about VAT exemption for your customers
You can create and manage reasons for VAT Exemption from the backend, Admin > VAT Exempt > Reasons > Vat Exempt Reasons. This grid will have columns like, ID, Reason, Status, Action, along with create new button to add new reason.
Create New Reason - To create new reason from the backend, go to Admin > VAT Exempt > Reasons > click "Create New" and set below configuration.
Reason : Add the reason title
Sort Order: Enter sort order
Status: Select reason status
Declaration Statement on Order View Page - You can see the declaration statement and VAT exemption details on the order view page at, Sales > Orders > Select Order > View.
VAT Exemption Details on Order View Page - In the screen grab you can see the Vat exempted amount under ''Order Totals’’ section.
VAT Exemption Option for Admin Orders - For admin orders you can apply for Vat exemption by checking “Apply Vat Exempt” option from Sales > Orders > Create New Order > Select Customer > Add Products > Vat Exemption – check “Apply Vat Exempt”.
Include or Exclude Product - To include/exclude store products for the VAT exemption, go to Catalog > Product > Select Product > Edit > VAT Exempt - ''Yes/No''.
VAT Exempt Option on the Cart Page - Apply for Vat Exempt option appears on the cart page and when user opts for this option, then it opens the form on the checkout page after the shipping details to add the required information.
VAT Exempt Message on the Cart Page – You can display VAT exempt message on the cart page from Admin > Stores > Configuration > Scommerce Configuration > Vat Exempt Settings > Basket VAT Exempt Message – add message, the added message will be shown on the cart page.
VAT Exempt Form on the Checkout Page - When the user enables the module and adds a VAT exempted product to cart then "Apply for Vat Exempt" option appears on the checkout page and check on this option opens the form. On the form “Apply VAT Exempt” and once applied, “Cancel VAT Exempt” buttons are available for VAT exemption claim.
VAT Exempt Discount - You can see the exempted amount on the checkout page under ''Order Summary'' section.
Shipping Vat - You can enable shipping Vat exempt by selecting “Yes” for “Shipping VAT Exempt” from Admin > Stores > Configuration > Scommerce Configuration> Vat Exempt Settings > Shipping VAT Exempt - “Yes”. In the below image you can see the exempted Vat is £ 3.05 (Shipping Tax (.41) + Tax (2.64)).
VAT Exempt Discount on the Front-end - You can view the VAT exemption information on the front-end under ''My Orders'' section.
You can see the VAT exempt declaration statement under My Account > My Order section.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Batch Settings
Product Batches Grid
Add Sources at Product Level
Add New Product Batch
Un-Associate / Delete Product Batch
Product Batches at Product Level
Add Specific Batch to Product
Select Batches During Shipment
Batch Details on the Order View Page
Deleting or Un- Associating a Product Batch
Deleting
Un-Associating
Batch Report
Import / Export Product Batches
Batch Expiration Email Notification
Authentication Token
Creating a Batch using API
Retrieve all Batches using API
Retrieve Date of Batch using ID 1 Using API
Delete Batch with ID 1 Using API
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Product Shelf Life Expiration
Enabled - Select “Yes” or “No” to enable or disable the module.
Batch expiry email notification period (number of days) - Please define batch expiry email notification period. This setting will check the batch expiry date and will send an email notification to the admin for the same.
Batch expiry email notification (Yes/No) - Please select “Yes” or “No” to “Enable” or “Disable” the email notification regarding batch expiration.
Disable batch once expired - Please select “Yes” or “No” to disable the batch. It disables the batch automatically once their expiry date is passed and runs as part of cron job at midnight.
Email Addresses - Please provide email addresses (comma separated) to send the batch expiration email notification.
Email Sender – Please select sender/ from email addresses for Batch expiry updated.
Select Email Template -Please select the email template for batch expiry email notification.
Cron Scheduler for expiry batch notification - This setting will be used to send the email through the cron.
Batch Selection Attribute – This setting will determine how batches are selected automatically.
Batch Selection Attribute Direction – As per the batch selection attribute you can choose the direction for example Ascending(ASC) or Descending(DSC).
Batch Selection – You can choose to select batches automatically based on batch selection attribute or you can set it to Manual. When Manual you will be able to select batches during shipment.
You can create and manage product batches from, Admin> Product Batches. This grid will have all the details about batches like ID, Batch Code, Product SKU, Batch Status, Batch Qty, Batch Expiry, Action/Edit and Source Inventory.
Add Sources at Product Level -You can add product source from Admin > Catalog > Select Products > Click "Assign Sources"> Select "Source"> Click "Done" .
Add New Product Batch -To create new product batch, go to Admin > Product Batches>click 'Add New Batch'. It will take you to the new product batch page and by providing all the required details; you can create the new batch.
Un-Associate / Delete Product Batch -Toun-associate and delete product batch, go toAdmin > Product Batches> Select Batch > Edit >Click "Un-Associate with Product'' and for Delete click on "Delete" button.
When user enables the module then Product Batches section appears at, Admin>Catalog>Product>Select Product>Edit>Product Batches. From this section, users can add new batch or can associate specific existing batch to a product.
You can also add specific batches to a product from, Admin > Catalog > Product > Select Product >Edit >Product Batches >Click"Add Specific Batch". It redirects to Batch Grid and by selecting batch ID you can associate active batches to a product.
Select Batches During Shipment -To select the batch during shipment make sure Batch Selection is set to manual in the configuration then navigate to Admin> Sales > Order > Select Order > View>Generate Invoice>Click on Ship. When you scroll down on the page you will see the option to select the batches manually. The product quantity will be deducted from the selected batch. Please refer to the image below:-
Batch Details on the Order View Page -To view theproduct batch related details, go to Admin > Sales > Order > Select Order > View.
Deleting: -To delete a product batch, go to Catalog>Product Batches then select the product batch that you want to delete. From Action coloumn click Edit. Here you will see the option to delete the Product batch.
Un-Associating:- To Un-Associate a product batch, go to Catalog>Product Batches then select the product batch that you want to delete. From Action column click Edit. Here you will see the option to Un-Associate the Product batch.
Batch Report:- To view the detailed batch report go to your admin panel then Reports>Sales>Batches. Here you can see all the orders associated with a product batch with the following information:-
Order Number
Purchase Date
Customer
Customer Group
Product Name
Batch code
Batch Quantity
Expiry Date
To import and export product batches, go to Admin > System >Import / Export.
Import - It updates the stock quantity and disables the batches if they are expired.
Export-It exports the batches in the selected file format, e.g. CSV.
CSV File Format for Import - CSV file will have batch_code, batch_qty, batch_status, batch_expiry, product_sku and source_inventory.
Batch Expiration Email Notification - When you select "Yes" for "Batch expiry email notification"from Admin > Stores > Configuration > Scommerce Configuration > Product Shelf Life Expiration > Batch Settings, then it sends an email notification for batch expiration.
You would need credentials to your store with admin rights Parameters:-.Admin credentials
Username
Password
{
"username": "admin", "password": "admin"
}
Authorization token received from the above step
Batch code
Batch quantity
Batch status
Batch expiry
Product SKU
Authorization: Bearer {{auth_token}}
{
"batch_code": "batchcode_001", "batch_qty": "10",
"batch_status": "1",
"batch_expiry": "2020-12-06", "product_sku": "MH0001"
}
Authorization token
Authorization: Bearer {{auth_token}}
Authorization token
Batch ID in URL
Authorization: Bearer {{auth_token}}
Authorization token
Batch ID
Authorization: Bearer {{auth_token}}
{
"batchId": 1
}
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
For eg:-
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Guest Form - The guest user can cancel order by submitting the Orders and Returns form. Here is the link to access the form . The form will have the following fields: -
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
Facebook App Id – Enter your Facebook App Id. To create App Id, check .
Client Id – Enter your Google Client Id. To create Client Id, check .
Create Facebook App Id - To create Faceook app Id go to , login as a developer and choose “Create App” in the “My Apps” drop-down.
Create Google App Id – To create Google App go to Click on the “CREATE PROJECT” button and configure your app settings.
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
POST URL:- Content-Type: application/json
POSTURL:- Content-Type: application/json
GET URL:- Content-Type: application/json
GET URL:- Content-Type: application/json
PUT URL: - Content-Type: application/json
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
Update Email Address from Order Detail View Page
Updated Email Address Visible on the Order Detail View Page
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.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Update Order Email
Enabled – Select “Yes” or “No” to enable or disable the module.
Update Email Address from Order Detail View Page - You can update email address from Admin > Sales > Orders > Select Order > Click on "Change" then add new email address > Click "Save".
Updated Email Address Visible on the Order Detail View Page - The updated email address will be shown on the order detail view page under "Account Information" section.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Stock Status Rules Grid
Add New Rule
Custom Stock Status and Rule Name at Product Level
Salable Quantity
Assign Custom Stock Status Rule to Products Automatically or Manually
Manually
Automatically on Cron Run
Multi Websites Selection
Custom Stock Status Product Attribute
Custom Stock Message for Simple Products on the Product Page
Custom Stock Message for Configurable Products on the Product Page
Custom Stock Message on the Cart & Checkout Pages
Custom Stock Message on Related, Cross-sells and Up-sells Products
Status Message in the Order Confirmation Email
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Custom Stock Status
Enabled - Select “Yes” or “No” to enable or disable the module.
Custom Stock Message on Related Product – Select “Yes” to enable the custom stock message on related product.
Custom Stock Message on Up-Sells Product – Select “Yes” to enable the custom stock message on Up-sells product.
Custom Stock Message or Cross-Sells Product – Select “Yes” to enable the custom stock message on Cross-sells product.
Cron Schedule – Schedule cron job to automatically update custom stock status based on correct rule.
Stock Status Rules Grid – This will be a grid in admin > Catalog > Stock Status Rules, with below column: -
ID: ID, this is auto generated and non-editable
Rule Name: Name of the rule
Status: Status of the rule, Enabled/Disabled
Website: Name of the website
Priority: Priority of the rule
Action: Edit/Delete
Add New Rule – You can add new rule by clicking “Add New Rule” from Admin > Catalog > Products > Stock Status Rules >Add New Rule, it redirects to the detailed view for Rule from where you can create a new rule by filling the required fields.
Rule Name - Add generic name for rule
Website - Select website from multi-select, from here you can select multiple website
Enable - Please enable/disable rule by slider
Priority - You can add priority (int) for the rule. In case of conflicting rules for a product the lowest number will have highest priority like 0 will be given priority over 1. If no priority defined then any random rule will apply
Conditions - Add the conditions to match, leave blank for all products
Default Stock Message - You can select default stock message from the drop- down, which will be shown on the frontend and replace availability (In Stock / Out Stock) message.
Apply Stock Quantity Ranges: You can enable it by turning "On" this option. If it is enabled then it shows below grid where you can define stock ranges and corresponding status. Please note that if the range is not provided for given stock quantity then the default message will be shown.
Custom Stock Status and Rule Name at Product Level - You can view the associated rule to product from Admin > Catalog > Products > Select product.
Salable Quantity - On product save it updates the stock status message based on the salable quantity and the quantity rule. To view salable quantity go to Admin > Catalog> products > Select Product > Product Salable Quantity.
Manually - You can assign rules to product manually from Admin > Catalog> Products > Select Product > Rule Name - Select rule from the “Rule Name” drop-down list.
Automatically on Cron Run - You can schedule the Cron job from Admin > Stores > Configuration > Scommerce Configuration > Custom Stock Status, on cron run the rule will be automatically assigned to products based on the matched condition and set the correct message.
Multi Websites Selection - It fully supports multi-store and websites, you can select websites from Admin > Catalog > Products > Select Product > Product in Websites- check websites.
Custom Stock Status Product Attribute - You can add values to custom stock status product attribute from Admin > Store >Attribute > Product> Product Attribute>Select - custom_stock_status > Properties > Add option, the added values will be populated in the default /custom stock status message drop-down.
Custom Stock Message for Simple Products on the Product Page – It displays stock status message for simple product based on salable qty and quantity ranges rule.
Custom Stock Message on the Cart & Checkout Pages – You can see the stock status message on cart and checkout pages.
Custom Stock Message on Related, Cross-sells and Up-sells Products – When you select “Yes” for “Custom Stock Message on Related Product / Up-Sells/ Cross- Sells” from Admin > Stores > Configuration > Scommerce Configuration > Custom Stock Status, then it shows stock status message on related/up-sells/cross- sells products.
Status Message in the Order Confirmation Email – In the order confirmation email you can see the added stock status message.
Installation and User Guide for Magento 2 Admin Activity Logger Extension
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
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
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.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Security Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Admin Activity Logger
Enabled - Select “Yes” or “No” to enable or disable the module.
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.
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.
Admin Activity Logger - You can view admin activity logger from, Admin > System > Scommerce Admin Activity Logger > Admin Activity / Login Activity.
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.
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.
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.
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
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.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Ajax Add to Wishlist - Ajax SignIn Popup
Ajax Add to Wishlist – Ajax Create an Account Popup
Ajax Add to Wishlist – Mini Cart Drop-Down Slider
Limit The Quantity of Products to Show In The Cart Slider
Ajax Add to Wishlist – Ajax Add to Wishlist Popup
Ajax Add to Wishlist – Ajax Add to Wishlist Confirmation Message
Ajax Add to Wishlist – Wishlist Products Under my Account – My Wishlist Section
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Enabled - Select “Yes” or “No” to enable or disable the module.
Enable Ajax Wish List – Select “Yes” or “No” to enable or disable the Ajax Wish List.
Enable Ajax Login – Select “Yes” or “No” to enable or disable the Ajax Login
Enable Slide Down Mini Cart – Select “Yes” or “No” to enable or disable slide down effect of mini cart after adding item to the basket.
No more waiting to be redirected to the Sign In page. When you click on Sign in a pop-up will appear on your screen and you will be able to login to the site without reloading the page. It is great for ease of access as well as saves time. Also, it does not matter which page you are browsing the pop-up will work with most pages. To enable the Ajax login feature first login to your admin panel.
Enables users to create an account or register on the website via a pop-up. Initially upon clicking on create an account users were redirected to a different page but now you can stay where you are browsing and create an account without having to reload or redirect the page. It makes convenient for new users to gain access.
You can toggle this feature on or off by loggin into your admin panel and then going to the path Stores > Configuration > Scommerce Configuration > Ajax Login & Wishlist. There will be flag named Enable Ajax Login you can select “Yes” or “No” from the drop-down that will turn this feature on or off.
When products are added to the cart a drop-down slider appears in the mini cart. It makes easy for users to keep track of their products that they have added to the cart. You can scroll down to browse your products in the cart. The number of products to appear in the list can be changed from settings.
This feature can be enabled or disabled from the admin panel. First Login to your admin panel then go to the following path Stores > Configuration > Scommerce Configuration > Ajax Login & Wishlist. There you will have an option named
Enable slide down mini cart, from the drop-down menu select “Yes/No” to Enable/Disable this feature.
Also, you can limit the quantity of products to show in the cart slider. You can do that by going into Stores > Configuration > Sales > Checkout > Shopping cart sidebar. There you will see an option named Number of items to display scrollbar. Here enter your quantity and the scrollbar will appear after that many number of products are added to the cart.
Generally, when a product is added to the wishlist you are redirected to another page but while this setting is enabled you will be able to add products to wishlist without redirecting or reloading the page. If you are not signed In, a pop-up will appear on the screen saying either sign in or create an account. This feature can be enabled
or disabled by log in to your admin panel then going to the path Stores > Configuration > Scommerce Configuration > Ajax Login & Wishlist. Here you will see an option named Enable Ajax Wish List, from the drop-down select Yes/No to Enable/Disable this functionality.
While this option is enabled when any product is added to the cart you will receive a pop-up message on the screen showing your product has been successfully added to the wishlist. Keep in mind you need to be logged in to add products to wishlist.
All the products added to the wishlist should be visible under your account under the wishlist section. Add multiple products to Wishlist without reloading the page every time and view them listed in the wishlist section of your account.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Add Substitute Products
Order Placed with Substitute Product
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration >Substitute Products
Enabled - Select “Yes” or “No” to enable or disable the module.
The substitute product should have exactly same configurations as the main product only the SKU will be different. You can create a duplicate product of the main product while creating a new substitute product.
Go to Admin>Catalog>Products, navigate to your product from the list and click on Edit from the action column. Scroll down to find the Subsitute Products tab. Please refer to the image below:-
Click on Enabled to enable the substitute products for this main product. Add the SKU of the product that you want to add as a substitute of this product and add the priority. In case of multiple substitute products you can set the priortiy highest being 0 so that whenever products are out of stock, upon order placement the SKU will be chosen based on the priority set.
Also, as long as the substitute products attached to the main product are not out of stock the main product on the frontend will never show out of stock.
You can add substitute products for several products such as Simple, Configurable, Bundled etc.
Suppose our main product is out of stock then when a customer visits the storefront they will always see the product available as long as the substiute product assigned is in stock. Orders placed with the main product will be fullfilled with the subsitute product. Place an order with the main product then go to Admin>Sales>Orders, and select your order. We can see the substitute product SKU in the order detail since main product is out of stock.
We place the order with the main product having sku SubstitutetestMain but since this product is out of stock the order should be fullfilled with the substitute product assigned. Now upon placing the order go to My Account>My Orders and view the order, you will be able to see that the order is placed with the substiute product.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Category Page
CMS Pages
Email Field in Review Form
Reviews on CMS Pages
Reviews on Category Pages
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration >Substitute Products
Enabled - Select “Yes” or “No” to enable or disable the module.
Email Field Enabled -Set "Yes" to enable the email field in the product review form and set "No" to disable the email field.
Go to 'Marketing'->'Product Review Slider'
Click on 'Add New Slider'
In 'slider information' fill the title then go to 'product reviews'. and you will be able to see approved reviews.
Select as many reviews as you want and click on 'Save Slider' or 'Save and Continue Edit'
You can add this review slider to any category page, CMS page and CMS block
To see reviews under category page.
Go to Catalog-> Categories. Select any category.
Under ‘Content’ group, go to ‘Product Reviews Slider’ and add one of the Review Slider you have created.
Save and clear the caches.
To see reviews under CMS page(e.g.->home page)
Go to Content->Pages. Select any one of the pages.
Select the HTML code and click on edit.
Click on Insert Widget. Select the Widget type and widget option.
Save and clear the caches.
Note:- Similary you add product reviews slider in Blocks using widgets.
Once Email field is enabled from the configuration this field is visible in the Product review form:-
We had assigned product reviews slider to the What's New Page the review slider can be seen on the product page.
Go to the frontend to that category and reviews will be seen at the bottom of the page.
Table Of Contents
Installation via app/code
Installation via Composer
General Settings
Order Archive Settings
Order Delete Settings
Archive or Delete Orders from Order View Page
Restore
Restore Orders From Archived Order View Page
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Archive Orders
Module Enable - Select “Yes” or “No” to enable or disable the module.
Enabled (Yes / No) - Select "Yes" to archive orders automatically.
Retention Period - Please define retention period. This setting will automatically archive orders older than specified number of days
Cron Schedule - Schedule the cron job to automatically archive the orders (Default - Midnight)
Send Email (Yes / No) - Select "Yes" to send email after successfully archival orders.
Sender - Please enter sender/from email address to send an email to administrator after the successful archival of order(s).
Email Template - Please select email template for order archival email.
Receiver - Please add email addresses of administrators who will receive order archival email (comma separated).
Order Statuses (Multi-select) - Please select certain order statuses to be allowed by administrators to be archived.
Enabled (Yes / No) - Please select "Yes" or "No". If set to "Yes" then it will permanently delete orders.
Sender - Please enter sender/from email address .
Email Template - Please select email template for order deletion email.
Receiver - Please add email addresses of administrator, who will receive order deletion email (comma separated).
Order Statuses (Multi-select) - Please select certain order statuses for order deletion.
When you enable the "Order Archive" and "Order Delete" settings from Admin > Stores > Configuration > Scommerce Configuration > Archive Orders > Order Archive / Order Delete Settings > Enabled - "Yes" , then it adds two additional options "Archive" and "Delete " under the "Actions" drop-down at Admin > Sales > Order > Actions.
Archive - It moves/archives order(s) to another storage(archive grid) instead of deleting them. This action can be restored from the archive order view page.
Delete - It deletes order(s) permanently. The "Delete" action cannot be reversed and erases all order(s) and related information.
Archive or Delete Orders from Order View Page - You can delete and archive order(s) from, Admin > Sales > Orders > Select Order > View. The order view page will have two additional options "Delete" and "Archive" and using these two buttons you can perform "Delete" and "Archive" actions. Buttons will only be visible when the module is enabled and the administrator has right role to archive/delete order(s).
To view archived orders, go to Admin > Sales > Archive Orders. This grid will have an additional option "Restore "under "Actions" drop-down to restore the archived orders.
Restore - By selecting "Restore" from Admin > Sales > Archive Orders> Actions drop-down you can easily restore archived order(s).
Restore Orders From Archived Order View Page - You can restore archived orders from Admin > Sales > Archive Orders > Select Order > View > Click "Restore".
Restore - It restores archived orders.
When you enable the module and define the number of days for "Retention Period" from, Admin > Stores > Configuration > Scommerce Configuration > Archive Orders > Order Archive Settings, then it automatically archives order(s) older than defined days. After each successful order archival process, it sends an email to an administrator with details like how many numbers of orders being archived etc..
Upload Package
Install Extension
General Settings
Sales Detailed Report
Sales Item Detailed Report
Sales Summary Report
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Advanced Reporting
Enabled - Select “Yes” or “No” to enable or disable the module.
You can see the sales detailed report at, Admin > Reports > Advanced Reports > Sales Detailed Report.
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))))
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.
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
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).
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)))
Table of Contents
Installation via app/code
Installation via Composer
General Settings
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Export Product Attribute
Enabled – Select “Yes” or “No” to enable or disable the module.
Allowed Attributes – Select the porduct attributes that you want to list in separate columns while exporting the catalog products.
Make sure the custom attributes that you want to import are selected under Admin>Stores>Configuration>Scommerce Configuration>Export Custom Attributes>Allowed Attributes. Please follow the steps below to do the export.
Step 1:- Go to Admin>System>Export
Step 2:- Select product from the 'Entity Type' dropdown list and select the attributes that you want to exclude from the export.
Step 3:- Click on continue and when the cron runs the export will be generated and added in the list below
Step 4:- Finally, download the export file from the select dropdown.
Step 5:- You can see in the export file that our custom attributes new and sale are present in separate columns.
Table of Contents
Installation via app/code
Installation via Composer
Order Tags Logs
Order Tags Grid
General Settings
Static Tags
Dynamic Tags
Predefined Tags
Manually Assign/Remove Tags
Assign Tags Based on Conditions
Order Grid
Filter Order Grid
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Order Tagger
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin>Sales>Scommerce Order Tagger>Order Tags
Name– Enter the name of the tag.
Type– Select “Static” or “Dynamic” or "Predefined". Static tags can be manually assigned and dynamic tags can be assigned using conditions. Predefined tags already have conditions set so you only to select the predefined tag type.
Sort Order– Define the priority of the tag(0 being the highest priority), the highest priority tag will be displayed first.
Text Color– Add the text color for the tag.
Background Color– Add the background color for the tag
Conditions– Add the conditions using order or address attributes.
Go to Admin>Sales>Scommerce Order Tagger>Order Tags Logs
The logs keep track of all the dynamic tags that are assigned to orders. It has its own set of filters which can be used to identify a specific assigned tag.
There are three of tags within the extension static, dynamic, and predefined tags.
After creation, these types of tags are added manually via Magento order grid. Conditions are not added in these types of tags. They are not shown in order tags logs.
After creation, these types of tags are added automatically to the orders applicable.Conditions are added in these types of tags.They are shown in the Order tags logs.
After creation, these types of tags are added automatically to the orders applicable.Conditions are not added in these types of tags as they are already set. They are shown in the Order tags logs Irrespective of the name, only one type of tag can be created for one 'Predefined' field.
There are five types of predefined tags to choose from:-
Out of Stock :- Gets automatically assigned to the orders whose products are out of stock. As soon as the product is available the tag gets removed automatically.
Partially Shipped Order:- Gets automatically assigned to orders that are partially shipped i.e only a few quantities are shipped from the order. As soon all the entire order is invoiced the tag gets removed automatically.
Partially Invoiced Order:- Gets automatically assigned to orders that are partially invoiced i.e only some quantity of the order is invoiced. As soon all the entire order is invoiced the tag gets removed automatically.
Back Order:- Gets automatically assigned to backorders. This tag doesn't work with downloadable and virtual products. As soon as all the items in the order are shipped the tag gets removed automatically.
First Time Customer:- Gets automatically assigned to the orders that are placed by first-time customers. This works for both guest/registered users.
The tags can be assigned either manually or automatically using conditions set during the tag creation.
Go to Admin>Sales>Orders then select the order or multiple orders then click on the Actions dropdown and click on 'Add tags' or 'Remove tags'. Select the tag that you want add with the order from the 'Select Tags' dropdown and finally click on Add tags.
Note:- Only static Tags can be manually assigned.
Dynamic Tags are automatically assigned based on the conditions set while creating the tag. Go to Admin>Sales>Scommerce Order Tagger>Order Tags then create a new tag and set conditions from the left menu.
The Tags are displayed in the order grid in a separate column. Multiple tags can be assigned and displayed for a single order.
Orders can be filtered based on the tags. New filter option can be found in the filters where orders can be sorted based on the tags selected. Go to Admin>Sales>Filters and click on the Tags dropdown to select the tags.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Product Association at Product Level
Product Association for Simple Product
Product Association for Configurable/Child Product
Product Grid at Product Level
Associated or Linked Product Stock Update
Import
Export
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Associated Product
Enabled - Select “Yes” or “No” to enable or disable the module.
Optimise Stock save - Select "Yes" or "No". If set to "Yes" then it will optimise stock save for better performance on products with large amounts of associated products.
Product Association at Product Level – You can associate products from Admin > Catalog > Products > Select Product > Product Association > Click “AddProduct”.
Product Grid at Product Level – You can add products from Admin > Catalog> Products > Select Product > Product Association > Click “Add Product” > Product Grid > Select Products > Click “Add Selected Products”.
Associated or Linked Product Stock Update - Associated product stock/quantity will be updated based on the main product, which you can see in the below screen grab. It supports multiple linking where one product can have multiple associated products.
Product associations can be fixed to make sure the following criterias are met:-
Same product is not associated with itself
One product is associated with only 1 parent
To fix product associations run the command given below:-
To import associated products go system > Data transfer > Import. Then select product association from the drop down list. You will see the importing menu opening on your screen as shown in the image below. Select the import file and add import behavior settings as per your preferences. Lastly click on check data button on the right corner of your screen.
Export – Go to System > Data Transfer > Export. Select product associated in the entity type dropdown list. You should see the export menu popup on your screen as shown in the image below: -
Installation and User Guide for Magento 2 Repeat Order Subscription Extension
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Repeat Order Subscription Email
Payment / Order Failed Emailed
Subscription Status Update Notification
Re-start/Pause, Cancel Subscriptions
Subscribed Items and Order History on the Edit Subscription Page
Backend Order Page Link through Subscription Order
View Subscription Payment Details
Subscription Options on the Checkout Page
Frequency Selection Drop-down
My Subscription Section on the My Account Page
Subscription Details on the My Subscriptions Page
View / Edit Subscription Information from the Front-end/ My Account
Subscription Confirmation Email
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Repeat Order Subscription
Module Enable - Select “Yes” or “No” to enable or disable the module.
Subscription Title – Enter the title of subscription, which will be shown on the front-end.
Subscription Frequency Drop down Title – Enter the title of subscription frequency.
Subscription Frequency Drop down Options – Select the frequency option from the dropdown list.
Subscription Discount Percent – Enter the discount percent, this will be offered on subscription orders. If left blank, then no discount will be offered.
Use Tier Prices in Subscription – Select “Yes” to use tier prices in subscription.
Email Sender – Please enter sender/from email address for Repeat Order Confirmation Email.
Email Template – Select order confirmation email template for repeat order. The template will contain Subscription Id, Order Amount, Discount Subscription Frequency, Subscription Start Date, Billing address, Shipping address, Payment Method, Subscribed items.
Email CC – Please add CC email addresses for Repeat Order emails in comma separated format.
Email Sender – Please enter sender/from email addresses for Payment order failed email.
Email Template – Select Order/Payment failure email template for repeat order. The template will contain Subscription Id, Due Order Date (for which payment/order failed).
Email CC – Enter CC email address.
Email Sender – Please enter sender/from email addresses for Subscription status update email.
Email Template for Subscription Pause/Suspend – Select notification template for subscription pause.
Email Template for Subscription Pause/Suspend for admin – Notification template for Subscription Pause for Admin.
Email Template for Subscription Restart – Select notification template for subscription Re-start.
Email Template for Subscription Restart for Admin – Notification template for subscription Re-start for Admin.
Email Template for Subscription Cancellation – Select notification template for Subscription Cancellation.
Email Template for Subscription Cancellation for Admin – Notification template for Subscription cancellation for admin.
Email CC – Enter CC from email address.
Email Receiver – Enter receiver email address to receive Card Expiration notification email.
Email Template for Card Expiration for Admin – Email template for Card Expiration for admin.
Email Template for Card Expiration – Select email template for Card Expiration.
You can manage subscriptions from, Admin > Scommerce Mage > Repeat Order > Manage Subscriptions. This grid will have all the details about the subscriptions like Subscription ID, Frequency, Customer Email, Last Order date, Status, Action (Edit). With the action ‘Edit’ you can easily update subscription details and can also perform Cancel/Pause/Re-start actions.
Re-start/Pause, Cancel Subscriptions - You can re-start, pause and cancel subscriptions from Admin > Scommerce Mage > Repeat Order > Manage Subscriptions > Select Subscription > Edit.
Subscribed Items and Order History on the Edit Subscription Page - You can see the subscribed items and order history from Admin > Scommerce Mage > Repeat Order > Manage Subscriptions > Select Subscription > Edit.
Backend Order Page Link through Subscription Order – When you click on subscription order URL visible under Orders History section at Admin > Scommerce Mage > Repeat Order > Manage Subscriptions > Select Subscription > Edit, then it redirects to backend order page.
Subscription order link redirected to order view page
To see subscriptions payment details go to Admin> Scommerce Mage > Repeat Order > Subscription Payments. This grid will provide a view of payment status for the Payment transactions processed for automated subscription order. This will mainly have Subscription Id, First name, Transactions date and time, Transaction error/response.
View Subscription Payment Details - You can view payment details from Admin> Scommerce Mage > Repeat Order > Subscription Payments > Select Subscription > View.
Subscription Options on the Checkout Page - When you enable the module then it shows subscription options on the checkout page, by checking "Yes please I would like to receive future discounts" you can subscribed for the repeat order.
Frequency Selection Drop-down - On the checkout page when you check the subscription option then it shows frequency drop down, from where you can select the repeat order frequency.
My Subscription Section on the My Account Page - On the front-end you can see the subscription details at My Account > My Subscriptions
Subscription Details on the My Subscriptions Page - To view subscriptions details go to My Account > My Subscriptions.
View / Edit Subscription Information from the Front-end/ My Account - On the front-end you can view and edit the subscriptions from My Account > My Subscriptions > Select Order > Edit.
Subscription Confirmation Email – When you subscribed for repeat order, it sends subscription confirmation email.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Vat Exempt Settings
Create New Reason
Declaration Statement on Order View Page
VAT Exemption Details on Order View Page
VAT Exemption Option for Admin Orders
Include or Exclude Product
VAT Exempt Form on the Cart Page
VAT Exempt Message on the Cart Page
VAT Exempt Option on the Checkout Page
VAT Exempt Discount
Shipping VAT…
VAT Exempt Discount on the Front-end
VAT Exempt Declaration Statement on the Front-end
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Vat Exempt Settings
Enabled - Select “Yes” or “No” to enable or disable the module.
Shipping VAT Exempt - Please Select "Yes/No" to include or exclude shipping from VAT exemption (Default - No).
Declaration Statement - Please provide declaration statement. This will be shown in admin along with order details and on the frontend checkout page.
VAT Exempt Title - Please provide title. This will be shown on the checkout page before VAT Exempt message and declaration form (Default - VAT Exempt).
Basket VAT Exempt Message - Please add VAT exempt message. This will be shown on the cart/basket page.
VAT Exempt Message - Please provide VAT Exempt message. This will be shown on the checkout page under VAT exempt section to users who are applying for VAT exemption. (Default - VAT Exempt products are in your basket so if you are disable or from eligible charity then you should be able to claim VAT exemption from here).
Terms and Condition Message - Please provide terms and conditions message. This will be shown on the checkout pages along with checkbox on VAT exempt declaration form.
Use Reason as Text Input- Set "Yes" to allow customers to enter their own custom reasons without selecting from the dropdown list
You can create and manage reasons for VAT Exemption from the backend, Admin > VAT Exempt > Reasons > Vat Exempt Reasons. This grid will have columns like, ID, Reason, Status, Action, along with create new button to add new reason.
Create New Reason - To create new reason from the backend, go to Admin > VAT Exempt > Reasons > click "Create New" and set below configuration.
Reason : Add the reason title
Sort Order: Enter sort order
Status: Select reason status
Declaration Statement on Order View Page - You can see the declaration statement and VAT exemption details on the order view page at, Sales > Orders > Select Order > View.
VAT Exemption Details on Order View Page - In the screen grab you can see the Vat exempted amount under ''Order Totals’’ section.
VAT Exemption Option for Admin Orders - For admin orders you can apply for Vat exemption by checking “Apply Vat Exempt” option from Sales > Orders > Create New Order > Select Customer > Add Products > Vat Exemption – check “Apply Vat Exempt”.
Include or Exclude Product - To include/exclude store products for the VAT exemption, go to Catalog > Product > Select Product > Edit > VAT Exempt - ''Yes/No''.
VAT Exempt Option on the Cart Page - Apply for Vat Exempt option appears on the cart page and when user opts for this option, then it opens the form on the checkout page after the shipping details to add the required information.
VAT Exempt Message on the Cart Page – You can display VAT exempt message on the cart page from Admin > Stores > Configuration > Scommerce Configuration > Vat Exempt Settings > Basket VAT Exempt Message – add message, the added message will be shown on the cart page.
VAT Exempt Form on the Checkout Page - When the user enables the module and adds a VAT exempted product to cart then "Apply for Vat Exempt" option appears on the checkout page and check on this option opens the form. On the form “Apply VAT Exempt” and once applied, “Cancel VAT Exempt” buttons are available for VAT exemption claim.
VAT Exempt Discount - You can see the exempted amount on the checkout page under ''Order Summary'' section.
Shipping Vat - You can enable shipping Vat exempt by selecting “Yes” for “Shipping VAT Exempt” from Admin > Stores > Configuration > Scommerce Configuration> Vat Exempt Settings > Shipping VAT Exempt - “Yes”. In the below image you can see the exempted Vat is £ 3.05 (Shipping Tax (.41) + Tax (2.64)).
VAT Exempt Discount on the Front-end - You can view the VAT exemption information on the front-end under ''My Orders'' section.
You can see the VAT exempt declaration statement under My Account > My Order section.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Batch Settings
Product Batches Grid
Add Sources at Product Level
Add New Product Batch
Un-Associate / Delete Product Batch
Product Batches at Product Level
Add Specific Batch to Product
Select Batches During Shipment
Batch Details on the Order View Page
Deleting or Un- Associating a Product Batch
Deleting
Un-Associating
Batch Report
Import / Export Product Batches
Batch Expiration Email Notification
Authentication Token
Creating a Batch using API
Retrieve all Batches using API
Retrieve Date of Batch using ID 1 Using API
Delete Batch with ID 1 Using API
Update Batch with Batch Code 'xyz' Using API
Update Batch with Batch ID 'xyz' Using API
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Product Shelf Life Expiration
Enabled - Select “Yes” or “No” to enable or disable the module.
Batch expiry email notification period (number of days) - Please define batch expiry email notification period. This setting will check the batch expiry date and will send an email notification to the admin for the same.
Batch expiry email notification (Yes/No) - Please select “Yes” or “No” to “Enable” or “Disable” the email notification regarding batch expiration.
Disable batch once expired - Please select “Yes” or “No” to disable the batch. It disables the batch automatically once their expiry date is passed and runs as part of cron job at midnight.
Email Addresses - Please provide email addresses (comma separated) to send the batch expiration email notification.
Email Sender – Please select sender/ from email addresses for Batch expiry updated.
Select Email Template -Please select the email template for batch expiry email notification.
Cron Scheduler for expiry batch notification - This setting will be used to send the email through the cron.
Batch Selection Attribute – This setting will determine how batches are selected automatically.
Batch Selection Attribute Direction – As per the batch selection attribute you can choose the direction for example Ascending(ASC) or Descending(DSC).
Batch Selection – You can choose to select batches automatically based on batch selection attribute or you can set it to Manual. When Manual you will be able to select batches during shipment.
You can create and manage product batches from, Admin> Product Batches. This grid will have all the details about batches like ID, Batch Code, Product SKU, Batch Status, Batch Qty, Batch Expiry, Action/Edit and Source Inventory.
Add Sources at Product Level -You can add product source from Admin > Catalog > Select Products > Click "Assign Sources"> Select "Source"> Click "Done" .
Add New Product Batch -To create new product batch, go to Admin > Product Batches>click 'Add New Batch'. It will take you to the new product batch page and by providing all the required details; you can create the new batch.
Un-Associate / Delete Product Batch -Toun-associate and delete product batch, go toAdmin > Product Batches> Select Batch > Edit >Click "Un-Associate with Product'' and for Delete click on "Delete" button.
When user enables the module then Product Batches section appears at, Admin>Catalog>Product>Select Product>Edit>Product Batches. From this section, users can add new batch or can associate specific existing batch to a product.
You can also add specific batches to a product from, Admin > Catalog > Product > Select Product >Edit >Product Batches >Click"Add Specific Batch". It redirects to Batch Grid and by selecting batch ID you can associate active batches to a product.
Select Batches During Shipment -To select the batch during shipment make sure Batch Selection is set to manual in the configuration then navigate to Admin> Sales > Order > Select Order > View>Generate Invoice>Click on Ship. When you scroll down on the page you will see the option to select the batches manually. The product quantity will be deducted from the selected batch. Please refer to the image below:-
Batch Details on the Order View Page -To view theproduct batch related details, go to Admin > Sales > Order > Select Order > View.
Deleting: -To delete a product batch, go to Catalog>Product Batches then select the product batch that you want to delete. From Action coloumn click Edit. Here you will see the option to delete the Product batch.
Un-Associating:- To Un-Associate a product batch, go to Catalog>Product Batches then select the product batch that you want to delete. From Action column click Edit. Here you will see the option to Un-Associate the Product batch.
Batch Report:- To view the detailed batch report go to your admin panel then Reports>Sales>Batches. Here you can see all the orders associated with a product batch with the following information:-
Order Number
Purchase Date
Customer
Customer Group
Product Name
Batch code
Batch Quantity
Expiry Date
To import and export product batches, go to Admin > System >Import / Export.
Import - It updates the stock quantity and disables the batches if they are expired.
Export-It exports the batches in the selected file format, e.g. CSV.
CSV File Format for Import - CSV file will have batch_code, batch_qty, batch_status, batch_expiry, product_sku and source_inventory.
Batch Expiration Email Notification - When you select "Yes" for "Batch expiry email notification"from Admin > Stores > Configuration > Scommerce Configuration > Product Shelf Life Expiration > Batch Settings, then it sends an email notification for batch expiration.
You would need credentials to your store with admin rights Parameters:-.Admin credentials
Username
Password
{
"username": "admin", "password": "admin"
}
Authorization token received from the above step
Batch code
Batch quantity
Batch status
Batch expiry
Product SKU
Authorization: Bearer {{auth_token}}
{
"batch_code": "batchcode_001", "batch_qty": "10",
"batch_status": "1",
"batch_expiry": "2020-12-06", "product_sku": "MH0001"
}
Authorization token
Authorization: Bearer {{auth_token}}
Authorization token
Batch ID in URL
Authorization: Bearer {{auth_token}}
Authorization token
Batch ID
Authorization: Bearer {{auth_token}}
{
"batchId": 1
}
Authorization token
Batch Qty
Batch Status
Batch_expiry
Product_sku
You can several other parameters that you want to update.
POST URL:- http://baseurl/index.php/rest/V1/productbatches/updatebatchByCode/{{batch_code}}
Content-Type: application/json
Authorization: Bearer {{auth_token}}
{
"batch_qty": "10",
"batch_status": "1",
"batch_expiry": "2020-12-06",
"product_sku": "MH0001"
}
Authorization token
Batch Qty
Batch Status
Batch_expiry
Product_sku
You can several other parameters that you want to update.
POST URL:- http://baseurl/index.php/rest/V1/productbatches/updatebatchById/{{batch_ID}}
Content-Type: application/json
Authorization: Bearer {{auth_token}}
{
"batch_qty": "10",
"batch_status": "1",
"batch_expiry": "2020-12-06",
"product_sku": "MH0001"
}
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
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
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact
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 .
POST URL:- Content-Type: application/json
POSTURL:- Content-Type: application/json
GET URL:- Content-Type: application/json
GET URL:- Content-Type: application/json
PUT URL: - Content-Type: application/json
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
Admin Login Attempts
Blacklist
Whitelist
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.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Security Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Admin Login Security
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.
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
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.
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.
Go to Admin > System > Scommerce Admin Login Security>
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.
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.
Go to Action>Edit and you can change various details for each of the records such as IP Address, Username, and Valid till date.
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.
Go to Action>Edit and you can change various details for each of the records such as IP Address, and Username.
Installation and User Guide for Magento 2 Content Security Policy (CSP) Whitelist Manager
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
CSP Directives
Critical Security Overrides
Steps to Check and Fix Console CSP Errors through CSP Grid
Steps to Check and Fix Console CSP Errors
Inline Style Error Example
Inline Script Error Example
Download Extension: Once you have placed the order from our site then go to My Account section and click on My Downloadable Products and download the extension package.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > CSP Whitelist
IMPORTANT INFORMATION- When adding or changing whitelist, ensure to include only those domains that are recognized and trustworthy. This precaution is crucial because unauthorized or compromised domains may contain malicious scripts.
Enabled – Select “Yes” or “No” to enable or disable the module.
Report Only Mode - Set "Yes" to enable Report Only mode for CSP ( it will only report CSP vulnerabilities in the CSP reports grid and browser console. Make sure to add Report URL in Configuration>Security>CSP for the CSP grid to collect reports. Set "No" to enable Strict Mode ( it will prevent data from loading or code from getting executed to prevent vulnerabilities).
Report Collection Enabled:- Set "Yes" to enable collecting CSP reports in the CSP grid, Set "No" these errors will only be available in the browser console
Report URL Configuration:- Please add following URLs in Security > CSP section of your Store config Admin Default - https://BASE_URL/scommercereporturi/report/admin Storefront Default - https://BASE_URL/scommercereporturi/report/storefront
Default Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for default-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Base Uri
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for base-uri
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Child Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for child-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Connect Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for connect-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Font Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for font-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Form Action
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for form-action
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Frame Ancestors
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for frame-ancestors
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Frame Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for frame-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Img Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for img-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Manifest Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for manifest-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Media Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for media-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Object Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for object-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Script Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for script-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Style Src
Enabled- Select “Yes” or “No” to enable or disable csp whitelist for style-src
Whitelist entries- Please add URLs that you want to whitelist. By default, the type of entry added would be host. You can also delete this entry and add multiple entries.
Critical Security Overrides
Enable Unsafe Inline Script-This setting permits the execution of unsafe inline scripts, which can be introduced by your developers / third party extensions / attackers. Make sure you assess these unsafe inline scripts before setting this to YES.
Caution: Enabling unsafe inline scripts is a temporary measure and should only be done under the guidance of your developer. You must ask your developers or third party extension providers to whitelist their inline scripts. This setting must NOT be left on 'YES' permanently, as it significantly increases the risk of security vulnerabilities, making your site an easy target for attackers. Always prioritise the security of your site and user data.
The CSP Reports Grid collects and displays all the CSP errors on both frontend and backend. To enable report collection please make sure to add the following URLs in Security > CSP section of your Store config:-
Admin Default - https://BASE_URL/scommercereporturi/report/admin
Storefront Default - https://BASE_URL/scommercereporturi/report/storefront
For eg:-
To access the grid go to Admin>System>Scommerce CSP Records> CSP Report Only Grid
ID:- Id of the record
Blocked URL:- The URL reported in the CSP error
Report Type:- Store Front (frontend) or Admin(backend), where the error was reported
Source URLs:- The Source URL of the page where this error was reported
Policy violation:- The CSP directive which was violated in this record.
Last report date:- When was this error last reported.
Steps to Check and Fix Console CSP Errors thorugh CSP Reports Grid
Go to Admin>System>Scommerce CSP Records> CSP Report Only Grid, select the error records that you want to whitelist then from the Actions dropdown, select whitelist.
Please clear caches as prompted:-
Once done all the selected entries will be whitelisted into their specific CSP directive and should be visible in the admin configuration.
Note:- If you have already whitelisted the entries manually in the configuration then you can delete these records from the grid by selection the records that you want to delete and then click on Action dropdown and select delete.
Steps to Check and Fix Console CSP Errors Manually
Check the errors present in the frontend's console.
Check the source of these errors.
Check the URL present in these errors.
In the backend, add the URL to the source to which that error belongs to.
You would no longer see the error on the frontend
In this section, we will show you how to fix the inline script and style related console errors for Content Security Policy. Please check the image below:-
Identify the script or style tag that's causing the console error.
Alternatively you can generate the hash using PHP as shown below.
Next we add this hash to our module in the correct section i.e either style or script.
Let us look at examples to understand this process better:-
Inline Style Error Example
Suppose we identified the style thats causing the issue as follows:-
Next we will go the site and create a SHA256 hash as well as the base64 encode of this hash of the contents of the style tag as shown in screengrab below:-
Now copy this hash and go to Stores>Configuration>Scommerce Configuration>CSP Whitelist and scroll down to find the Style Src section. Add the hash here as shown in the image below:-
Please make sure hash is selected in the type dropdown. This should resolve the console error.
Inline Script Error Example
The identified script tag causing the issue is as follows:-
Now copy this hash and go to Stores>Configuration>Scommerce Configuration>CSP Whitelist and scroll down to find the Script Src section. Add the hash here as shown in the image below:-
Please make sure hash is selected in the type dropdown. This should resolve the console error.
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
Product Settings
Category Settings
CMS Page Settings
Short Description
Description
Meta Title
Meta Description
Meta Keywords
Description
Meta Title
Meta Description
Meta Keywords
Page Content
Meta Title
Meta Description
Meta Keywords
Download Extension: Once you have placed the order from our site then go to My Account section and click on My Downloadable Products and download the extension package.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > AI Content Generator
Enabled – Select “Yes” or “No” to enable or disable the module.
Content Writing using Chat GPT - Set "Yes" to use ChatGPT to generate content and set "No" to configure Google Gemini to be used for content generation.
Chat GPT versions - Select the ChatGPT version from the available option that you want to use to generate content.
Content Writing using Gemini - Set "Yes" to use Gemini to generate content. Please make sure "Content Writing using ChatGPT is set to "NO" to expose Gemini settings.
Gemini API version - Select the Gemini version from the available option that you want to use to generate content. (Gemini Pro and Gemini Flash)
Purge Log - Set "Yes" to enable purging of the log data in the database.
Retention Days - Define the retention days for the logs that are kept in the database.
Cron Job - Define Cron schedule for purging of the log data.
Note:- Switch store view or website to expose the settings below:-
Meta Title Character Prompt– Add the prompt for Meta Title on product pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Product Meta Title. This data can be overwritten or custom prompt can be used at the product level. Google recommendation for Meta title limit is up to 70 characters.
Meta Description Prompt – Add the prompt for Meta Description on product pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Product Meta Description. This data can be overwritten or custom prompt can be used at the product level. Google recommendation for Meta Description limit is up to 160 characters.
Meta Keywords Prompt– Add the prompt for Meta Keywords on product pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Product Meta Keywords. This data can be overwritten or custom prompt can be used at the product level. Google recommendation for Meta keyword limit is up to 10 keyword phrases or 160 characters.
Short Description Prompt – Add the prompt for Short Description on product pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Product Short Description Title. This data can be overwritten or custom prompt can be used at the product level. Google recommendation for Short Description is up to 200 words.
Product Description Prompt – Add the prompt for Product Description on product pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Product Description. This data can be overwritten or custom prompt can be used at the product level. Google recommendation for Page Description limit is up to 3600 characters.
Meta Title Character Prompt– Add the prompt for Meta Title on category pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Category Meta Title. This data can be overwritten or custom prompt can be used at the category level. Google recommendation for Meta title limit is up to 70 characters.
Meta Description Prompt – Add the prompt for Meta Description on category pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Category Meta Description. This data can be overwritten or custom prompt can be used at the category level. Google recommendation for Meta Description limit is up to 160 characters.
Meta Keywords Prompt– Add the prompt for Meta Keywords on category pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Category Meta Keywords. This data can be overwritten or custom prompt can be used at the category level. Google recommendation for Meta keyword limit is up to 10 keyword phrases or 160 characters.
Category Description Prompt – Add the prompt for Category Description on category pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Category Page Description. This data can be overwritten or custom prompt can be used at the category level. Google recommendation for Page Description limit is up to 3600 characters.
Meta Title Character Prompt– Add the prompt for Meta Title on CMS Pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Content Meta Title. This data can be overwritten or custom prompt can be used at the CMS page level. Google recommendation for Meta title limit is up to 70 characters.
Meta Description Prompt – Add the prompt for Meta Description on CMS Pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Content Meta Description. This data can be overwritten or custom prompt can be used at the CMS page level. Google recommendation for Meta Description limit is up to 160 characters..
Meta Keywords Prompt– Add the prompt for Meta Keywords on CMS Pages. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Content Meta Keywords. This data can be overwritten or custom prompt can be used at the CMS page level. Google recommendation for Meta keyword limit is up to 10 keyword phrases or 160 characters.
Page Content Prompt – Add the prompt for CMS pages content. This prompt setting will be used to extract AI generated content from either ChatGPT or Google Gemini for Content Page Description. This data can be overwritten or custom prompt can be used at the CMS Page level. Google recommendation for Page Description limit is up to 3600 characters.
AI content generator works with the following fields on the product pages. Go to Admin>Catalog>Product and then select any product.
Click on Fetch Content and Based on the prompt set in the configuration the content is generated and populated automatically into this field.
In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Edit the description with page builder and when add a HTML element the AI Content Generator options are present. Click on Fetch Content and Based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Product settings>Search Engine Optimization. Click on Fetch Content below Meta Title and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Product settings>Search Engine Optimization. Click on Fetch Content below Meta Description and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Product settings>Search Engine Optimization. Click on Fetch Content below Meta Keywords and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Edit the description with page builder and when add a HTML element the AI Content Generator options are present. Click on Fetch Content and Based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Category settings>Search Engine Optimization. Click on Fetch Content below Meta Title and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Category settings>Search Engine Optimization. Click on Fetch Content below Meta Description and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Category settings>Search Engine Optimization. Click on Fetch Content below Meta Keywords and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Edit the content with page builder and when add a HTML element the AI Content Generator options are present. Click on Fetch Content and Based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Page settings>Search Engine Optimization. Click on Fetch Content below Meta Title and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Page settings>Search Engine Optimization. Click on Fetch Content below Meta Description and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
Go to Page settings>Search Engine Optimization. Click on Fetch Content below Meta Keywords and based on the prompt set in the configuration the content is generated and populated automatically into this field. In case you want to add a custom prompt for this product simply click on AI Content Using Custom Prompt and add your prompt then when you click Fetch Content the content is generated based on your custom prompt.
AI content generator generates content on all Category, Product, CMS Pages. Please check some of the frontend screengrabs of the generated content:-
Go to Scommerce AI Content Generator>API Logs to view logs of each API request used by AI content Generator.
The grid contains request response and the AI engine used:-
Table of Contents
Installation via app/code
Installation via Composer
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > OTP Login
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. Please go to Admin > Stores > Configuration > Scommerce Configuration > Core and click on "Verify" to verify the license key.
Enable Login with Mobile - Select "Yes" or "No". If set to "Yes" then users will be able to login to the store using their mobile number.
Allowed Countries- Select the countries allowed to be used for sending via SMS.
OTP Type - You can select the OTP type that sent via sms from Number, Alphabets, and Alphanumeric.
OTP Length - Enter the length of the OTP sent.
Expire Time- Add the time after which the OTP is expired and can't be used after this duration.
Time Between Resend (sec)- Enter the time in seconds after which users will be able to resend the otp.
Retry Count- Enter the number of retries allowed to resend otp before the user is locked out.
Lock Time (minutes)- Add the lock time on multiple otp failures
Channel on Register- Select the countries allowed to be used for sending via SMS.
Sender ID- Add the sender ID from Twilio.
Authorization Key - Add the authorization key from Twilio
Mobile Number- Add the mobile number from Twilio without the "+" sign
This section is to configure the Sender Email and the Email template used to send OTPs via Email:-
Success Email Sender- Select the Email to be used for sending successful login emails.
Otp Email Template - Select the Email template to be used for OTP emails.
This section is to configure the Sender Email and the Email template used to send OTPs via Email:-
Register Channel Message- Enter the message to be displayed on the registeration page for the users.
Go to the frontend and click on Sign In, you will it opens a popup to signin with Mobile. Add your Mobile number and click on Send OTP. Make sure Sign in with Mobile is enabled in the configuration only then you will be able to sign in using Mobile Number.
Enter the OTP to sign in
If the OTP is expired click on resend to resend the otp.
Go to the frontend and click on Sign In, you will it opens a popup, select Signin with Email.
Add credentials and proceed an OTP will be sent to your email, add to login to the store.
Go to the store and click on "Create an account", the registration will popup, add your details alongwith your phone number.
Finally click on Create Account and an OTP will be sent to your mobile number use it to register on the store.
Users can update their Phone Number with the Account by signing in to the store and then going to the "My Account" section. From the left menu click on "OTP Settings". Add your new number and password to update the mobile number.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Subcategories Widget
Display Mode Selection Drop-down “Subcategories Only”
Sub-categories Settings Dropdown
Subcategories Grid View on the Front- end
Subcategories List View on the Front- end
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Enabled - Select “Yes” or “No” to enable or disable the module.
Subcategories Background Color – Please select the Subcategories background colour.
Thumbnail Placeholder – Please choose the file of Thumbnail placeholder
Thumbnail width – Please add the Thumbnail width.
Thumbnail height – Please add the Thumbnail height.
Subcategories widget will allow you to display subcategories in a Grid/list view on any page. Navigate to Content > Pages, edit the page that where you want to display the subcategories. Go into Content and then simply click on insert widget and you will have options such as widget type where you have to select the widget named “Subcategories List” then select the category and the number of columns you want to display the subcategories in. Then Lastly click on insert widget.
Go to any of the categories page where you want to display subcategories on by navigating to Catalog > Categories. Next go to display settings where you can select the display mode as “subcategories only” so that the page can display subcategories instead of products
Go to any of the categories pages where you can select the settings by going into
Sub-categories settings dropdown. You can change the following settings: -
Thumbnail Category Image – Here you can upload a thumbnail image for the category.
Sub-category Short Description – You can add a short description here.
Number of columns – Select the number of columns you want to display your subcategories in.
After successfully enabling subcategories you can see them listed in a Grid view on the frontend. You can select the number of columns depending upon that the frontend will review the Grid view. To select the columns Navigate to Catalog > Categories and then select the category. Scroll down to Sub-Categories Settings. Here you will have the option to upload the thumbnail image, short description and number of columns. Please refer to the image below. Each of the subcategories will be listed with a description, background and image as defined by you.
Navigate to Catalog > Categories, select the category, and then scroll down to Sub-Categories settings. You can select the number of columns here. Similarly display the subcategories in a list view by selecting the number of columns as “1”. See the image below for reference.
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
General Settings
Security Checklist Report
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.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Security Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Security Checklist
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 app/etc/env.php 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.w
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.
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 app/etc/env.php 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
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.
Go to Admin > System > Scommerce Security> Security Checklist
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.
Table of Contents
Download Extension
Installation via app/code
Installation via Composer
General Settings
General Settings
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
Admin Login Attempts
Blacklist
Whitelist
Security Checklist Report
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.
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via Composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Security Base
Enabled – Select “Yes” or “No” to enable or disable the module.
Go to Admin > Stores > Configuration > Scommerce Configuration > Security Checklist
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 app/etc/env.php 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.w
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.
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 app/etc/env.php 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
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.
Go to Admin > Stores > Configuration > Scommerce Configuration > Admin Activity Logger
Enabled - Select “Yes” or “No” to enable or disable the module.
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.
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.
Admin Activity Logger - You can view admin activity logger from, Admin > System > Scommerce Admin Activity Logger > Admin Activity / Login Activity.
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.
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.
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.
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
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.
Go to Admin > Stores > Configuration > Scommerce Configuration > Admin Login Security
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.
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
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.
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.
Go to Admin > System > Scommerce Admin Login Security>
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.
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.
Go to Action>Edit and you can change various details for each of the records such as IP Address, Username, and Valid till date.
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.
Go to Action>Edit and you can change various details for each of the records such as IP Address, and Username.
Go to Admin > System > Scommerce Security> Security Checklist
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.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Admin Account Switcher
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. Please go to Admin > Stores > Configuration > Scommerce Configuration > Core and click on "Verify" to verify the license key.
Using this extension an admin can login into another admin's account directly from admin edit form section without requiring a password which allows them to debug easily without having to reset the other admin's password.
The admin can only use this functionality if they have the "Scommerce Switch Admin Account" (Admin>System>Permissions>User Roles>Select Role>Role Resources)selected under role resources for their user role.
Go to Admin>System>Permissions>All Users, here select(click edit) the admins account in which you want to login.
From the top menu click on "Switch User" and you will be logged into that admin's account without password authentication.
The “Switch to User” button is displayed only if the current admin user has the “Scommerce Switch Admin Account“ permissions in their user role.
To check this, you can go to Admin>System>Permissions>User Roles>Role Resources and check whether the user role has "Scommerce Switch Admin Account Role" selected.
Table of Contents
Installation via app/code
Installation via Composer
Configuration Settings for Admin Message Manager
General Settings
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Admin Account Switcher
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. Please go to Admin > Stores > Configuration > Scommerce Configuration > Core and click on "Verify" to verify the license key.
Using this extension an admin can login into another admin's account directly from admin edit form section without requiring a password which allows them to debug easily without having to reset the other admin's password.
The admin can only use this functionality if the have the "Scommerce Switch Admin Account" selected under role resources for their user role.
Go to Admin>System>Permissions>All Users, here select(click edit) the admins account in which you want to login.
From the top menu click on "Switch User" and you will be logged into that admin's account without password authentication.
The “Switch to User” button is displayed only if the current admin user has the “Scommerce Switch Admin Account“ permissions in their user role.
To check this, you can go to Admin>System>Permissions>User Roles>Role Resources and check whether the user role has "Scommerce Switch Admin Account Role" selected.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Integration Settings
Noths Order Import
Noths Order Details on Order View Page
Noths Order Logs
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Noths
Enabled - Select “Yes” or “No” to enable or disable the module.
API Uri – NOTHS API URI should be mentioned here.
API Key - Please enter API Key
API Log – Select “Yes” to enable the API Log. If set to “Yes” then it will log communication with Noths API.
Select the allowed order statuses – Please select order status which will be imported from Noths
Cron for Order Import - Please add define schedule how often you want to update transactions
Select the store for NOTHS Orders – Please select the store for Noths orders.
Noths Order Payment Method – Please add the payment method which will be used to import orders from Noths.
Noths Order Shipping Method – Please add the shipping method which will be used to import orders from Noths.
Send dispatch to NOTHS - Select Yes/No. If this is set to yes then dispatch API call will be sent when shipment is created in Magento.
Dispatch Notes Path – Please add the dispatch notes path in media/noths/dispatchnote/[order number].pdf
Estimated Days to ship – Please add the days for estimated days to ship.
Attributes Mapping – Please add the mapping of Magento attribute with options in Noths.
Create Files for Log - Select Yes/No”. If this is set to yes then it will log communication with NOTHS API
Purge Log - Please enable purging of the log data in the DB.
Retention Data - Please add number of days worth of logs you want to keep it in the DB.
Cron Job - Please add define schedule how often you want the logs to be purged.
Noths Order Import - You can view imported Noths order(s) from Admin > Sales> Orders. This grid will have "Dispatch Note " and "Noths Id".
Noths Order Details on Order View Page - You can view Noths order details at Admin > Sales > Select Order > View.
Noths Order Logs - To view Noths Logs go to Admin > Scommerce Noths > Order Logs. This log will have Entity Id, Request, Status, Type, Created At, and Response.
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Rate Limiter
Invalid Search
Rate Limiter
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Antispam Catalog Search
Enabled – Select “Yes” or “No” to enable or disable the module.
Black List – You can blacklist certain keywords from the search of your website. Enter omma separated blacklist words which you don’t want customers or crawlers to search on your website. For example "casino", "gambling" etc.
Disallow URLs– Select "no" to enter URL's in your website's search and "yes" to allow.
Disallow Foreign Words– Use this setting to define whether users can enter Foreign words in the search or not.
Disallow Numbers– Select "no" to allow customers to search with numbers and "yes" to disallow.
Disallow Special Characters– Select "no" to allow customers to search with special characters and "yes" to disallow.
Disallow repeated character– Select "no" to allow customers to search with repeated characters and "yes" to disallow. It prevents repeated letters in the search query.
Number of repeated characters - Enter the maximum allowed number of repeated characters
Message for invalid searches– Enter the message to be displayed when an invalid search is made by the customer.
Enabled– Select "yes" to block Ip address of the customers based on the number of searches performed in a specific time.
Number of seconds– Enter the time limit under which a user can make specific searches. If the number of searches exceeds this time limit then their IP will be temprorily blocked.
Number of searches– Enter the number of searches allowed for a user under the time restraint entered in the above setting.
Minutes to block IP– Define the Ip block time for users.
Log Enabled– Select "yes" to create logs under /var/log/antispamcatalogsearch.log
Message– Enter the message to be displayed when the IP of an user is blocked.
When an user searches with diallowed character then the warning message appears on the frontend as shown below:-
When an user exceeds the search limit then the IP block message appears as shown below:-
Module Installed via composer
Module Installed by Placing Files in app/code
Installation via app/code
Installation via Composer
General Settings
Filter Widget Settings
Myo Widget
Local
RapNet
Settings
Diamonds
Choosing a Diamond
Choosing a Setting
Review Complete Ring
Certificate
360 view
If you have previously installed this module on your store using MageInn Extension then you need to follow the steps below in order to install it again on your site. You will need to remove the module first then proceed with the installation steps in the next section.
If the module was installed previously via composer then run the commands below to remove it completely:-
If the module was previously installed by placing extension files in app/code then simply go the following directory app/code/MageInn/
and remove the DiamondSearch folder completely then run the upgrade commands as shown below:-
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin> Stores> Configuration> Scommerce > Diamond Search
Enable Module – Select “Yes” or “No” to enable or disable the module.
Source:- Select the source from where the products are pulled. Rapnet/Demo pulls products via Rapnet API where Rapnet is live. "Local" pulls products from Magento.
Theme Color:- Enter the color code for the entire diamond search theme
Diamond Image Type:- Choose between two image types schematic or photo for diamonds that appear in the list
Settings Attribute Set:- Attribute Set used to select products on Settings step(step 2) in Ring Builder (eg:- something like "Rings"). If you are creating a custom attribute set for rings then include critical Settings attributes which are Shape, Size from, and Size To, and these attributes must have values against them for everything to work correctly on the front end as these values get used to select the correct Ring.
Diamond Search Category:- Diamond Search Category used to show Settings on Step 2(choose a setting)
Show Dropdown filters:- If set then filters will be dropdowned. If not set then filters will be always displayed
Expand filters:- Select "Yes" to expand widget filters by default and select "No" to keep it hidden
Show Natural / Lab filter:- Select "Yes" or "no" to show or hide the natural/lab filter for diamonds.
Default Diamond Type:- Select default diamond type filter natural or lab.
Show selected Shapes:- Select "Yes" to show different diamond varieties in filter menu and select "No" to keep them hidden
Shapes:- Allowed Shapes(list of diamonds to appear in filter menu)
Show selected Sizes:- Enable/Disable CARAT filter. Set "Yes" to show CARAT filter. If set to "No" CARAT filter will be disabled
Size From:- CARAT filter range start
Size To:- CARAT filter range end
Show selected Colors:- Enable/Disable COLOR filter. Set "Yes" to show COLOR filter. If set to "No" COLOR filter will be disabled
Color From:- COLOR filter range start
Color To:- COLOR filter range end
Show selected Clarities:- Enable/Disable CLARITY filter. Set "Yes" to show CLARITY filter. If set to "No" CLARITY filter will be disabled
Clarity From:- CLARITY filter range start
Clarity To:- CLARITY filter range end
Show selected Cuts:- Enable/Disable CUT filter. Set "Yes" to show CUT filter. If set to "No" CUT filter will be disabled
Cut From:- CUT filter range start
Cut To:- CUT filter range end
Show selected Polishes:- Enable/Disable POLISH filter. Set "Yes" to show POLISH filter. If set to "No" POLISH filter will be disabled
Polish From:- POLISH filter range start
Polish To:- POLISH filter range end
Show selected Symmetry:- Enable/Disable SYMMETRY filter. Set "Yes" to show SYMMETRY filter. If set to "No" SYMMETRY filter will be disabled
Symmetry From:- SYMMETRY filter range start
Symmetry To:- SYMMETRY filter range end
Show selected Labs:- Enable/Disable CERTIFICATE/LAB filter. Set "Yes" to show CERTIFICATE/LAB filter. If set to "No" CERTIFICATE/LAB filter will be disabled
Labs:- Select list of labs to appear in CERTIFICATE/LAB filter
Filter by Price Total In Currency:- Enable/Disable PRICE filter. Set "Yes" to show PRICE filter. If set to "No" PRICE filter will be disabled
Filter by Price Total In Currency From:- PRICE filter range start
Filter by Price Total In Currency To:- PRICE filter range end
Show selected Fancy Colors:- ENABLE/DISABLE fancy colors in COLOR filter. NOTE:- Fancy Colors will only appear when "fancy" is selected in "Default Search Type" setting.
Fancy Colors:- Allowed Fancy Colors(List of fancy colours to appear in the COLOR filter) NOTE:- Fancy Colors will only appear when "fancy" is selected in "Default Search Type" setting.
Show Filter by Paired:- ENABLE/DISABLE PAIR filter. If "yes" Pair will be available in the Filter. It allows to filter diamonds by paired attribute.
Diamond Title Format In Widget:- Placeholders like [size] means diamond property. Placeholders like {STRING} means lexicon string
Default Search Type:- WHITE/Fancy selecting "white" will enable COLOR filter and color filter range wheras selecting "fancy" will enable the FANCY filter and fancy filter range.
Page Size:- Enter the total number of products to appear in the Diamond list.
Show Price:- If set to "Yes" then the PRICE column will be available in the Diamond list. If "No" then price column will disappear from the diamond list.
Show Add To Cart Button:- Set "Yes" or "No" to show or hide Add To Cart Button On Frontend Diamond Page
Show Add To Wishlist Button:- Set "Yes" or "No" to show or hide Add To Wishlist Button On Frontend Diamond Page
Is Responsive:- Set "Yes" or "No" to choose whether the style is reponsive for diamond search or not.
Add custom size option to bundle product:- Set "Yes" or "No" to Add or Remove custom size option to bundle product
Bundle Generated Size Label:- Bundle Generated Size Label for dropdown with custom options of generated bundle product
Custom Sizes:- Select the custom Sizes added to bundle product on the fly
The extension comes with two integration modes:- Local and RapNet.
When mode is set to local you can create your diamond products directly from Magento admin. All you need to do is to assign “Diamonds” attribute set to your diamond products
By default, the module adds two attribute sets i.e. Settings and Diamonds. These contain essential attributes for the module to work. If you want to create a custom attribute set, you need to include the attributes from these existing sets in order for your custom attribute set to work properly and the functional flow to be correct. We will go through each of these attribute sets and the attributes contained within them.
If you want to use a custom attribute set for "Rings" aside from settings then include critical Settings attributes which are Shape, Size from and Size To and these attributes must have values against them for everything to work correctly on frontend as these values get used to select correct Ring. All the attributes included in this attribute set are as follows:-
ds_size_min
ds_size_max
ds_shape
ds_is_paired
All the attributes included in this attribute set are as follows:-
mdiamond_id
mshape
msize
mcolor
mfancy_color_dominant_color
mfancy_color_secondary_color
mfancy_color_overtone
mfancy_color_intensity
mclarity
mcut
msymmetry
mpolice
mdepth_percent
mtable_percent
mmeas_length
mmeas_width
mmeas_depth
mgirdle_min
mgirdle_max
mgirdle_condition
mculet_size
mculet_condition
mfluor_color
mfluor_intensity
mhas_cert_file
mcountry
mcity
mlab
mtotal_purchase_price
mtotal_sales_price
mcurrency_code
mcurrency_symbol
mtotal_sales_price_in_currency
mcert_num
mstock_num
mhas_sarineloupe
msarineloupe_url
mis_fancyColor
ds_is_paired
mis_lab_diamond
Ring Builder is a great tool to allow your customers to pair any diamond with setting of their choice. Ring builder is fully responsive. You can also define a filter for each setting, so that only compatible diamonds are shown when setting is selected.
The entire process is divided into three steps namely, choosing a diamond, choosing a ring and in the final step a bundled product is created using previous selections and customers can place an order with that product.
Note:- Customers can start by either choosing a diamond first or choosing a setting(ring) first they will automatically be redirected to the next step.
If customers chooses to start by selecting a diamond then they will be able to see the diamond search page as shown in the image below. It contains several filters which can be utilized to pinpoint the exact diamond as per requirements.
Once the customer decides on a diamond they click on it which takes them to a detailed page for that diamond. It contains all the necessary details related to that specific diamond. Once satisfied they click on SELECT DIAMOND and they are redirected to the next step i.e choosing a ring.
In the next step, customers are directed towards the ring selection. Rings automatically get filtered and only the compatible rings for the diamond selected are displayed on this page. Simply click on choose this setting and you will redirected to the final step.
In the final step a bundled product is created using the first two selections which customers can add to basket and place an order with it.
Multiple currencies can be added/selected from Admin > Stores Configuration > General > Currency Setup – Allowed Currencies – Select currencies
Currency rates can be configured against base currency from Admin > Stores > Currency > Currency Rates
Base currency can be defined from Admin > Stores Configuration > General > Currency Setup > Base Currency – Select currency
Please follow the steps provided below in order to setup 360 view and certificate:-
Use local inventory in the configuration
Update diamond and add below values from Admin > Catalog > Products > Select Diamiond > Edit > “Diamond Details“
The below screengrab contains order with custom ring size selected:-
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Integration Settings
Noths Order Import
Noths Order Details on Order View Page
Noths Order Logs
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > Noths
Enabled - Select “Yes” or “No” to enable or disable the module.
Cron for Order import – Please allow to set cron frequency for order import from Noths.
API Url – Please enter API Url.
API Log – Select “Yes” to enable the API Log. If set to “Yes” then it will log communication with Noths API.
Create Files for Log – Select “Yes” to enable the create files for log. If set to “Yes” then it will log communication with Noths API.
API Key – Please enter API Key.
Select the allowed order statuses – Please select order status which will be imported from Noths
Select the store for NOTHS Orders – Please select the store for Noths orders.
Noths Order Payment Method – Please add the payment method which will be used to import orders from Noths.
Noths Order Shipping Method – Please add the shipping method which will be used to import orders from Noths.
Dispatch Notes Path – Please add the dispatch notes path in media/noths/dispatchnote/[order number].pdf
Estimated Days to ship – Please add the days for estimated days to ship.
Attributes Mapping – Please add the mapping of Magento attribute with options in Noths.
Noths Order Import - You can view imported Noths order(s) from Admin > Sales> Orders. This grid will have "Dispatch Note " and "Noths Id".
Noths Order Details on Order View Page - You can view Noths order details at Admin > Sales > Select Order > View.
Noths Order Logs - To view Noths Logs go to Admin > Scommerce Noths > Order Logs. This log will have Entity Id, Request, Status, Type, Created At, and Response.
Installation via app/code
Installation via Composer
General Settings
API Configuration
Limits and Messages Configuration
Limits Configuration
Emails
Customer Configuration
CreditSafe Transactions Grid
Import CreditSafe transactions in the Grid
Apply for CreditSafe Application
CreditSafe Company Application
Successful Credit Application
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin> Stores> Configuration> Scommerce > Credit Safe
Enable Module – Select “Yes” or “No” to enable or disable the module.
Show Address Form on Registration – Set "Yes" to collect billing address from customer on user registration or signup form. If set "No" billing address won't be captured on user registration.
Archiving Log – Set "Yes" to archive credit safe logs after a certain number of days and set "No" to turn off archiving.
Archive Log After Number Of Days – Enter the number of days after which the logs will be archived.
User Name – Enter the Creditsafe Username
Password – Enter the Creditsafe Password. Once both username and password are entered and saved click on the "Test API Creds" button if it shown "success" in green then your credentials are correct if not then please re verify your credentials.
Use Test Mode – Set "Yes" to enable sandbox creditsafe and set "No" to use live creditsafe.
Enable API Logging – Set "Yes" or "No" to Enable/Disable API logging in DB
Create creditsafe rules based on your requirements.
Type – Select the user type either "Business" or "Consumer" this rule will be created for the appropriate applicant type.
CS Credit Limit/Score Range - Enter the credit limit or credit score range for the particular rule.
Limit– Enter the credit limit to be assigned for this rule based on the score entered previously. If the score is in this range then the entered limit should be provided to the applicant.
Limit Type –There are two main credit limit types:
Absolute Limit: This limit is a fixed amount set by you or your business, regardless of external factors. It's directly entered into the "limit field" you mentioned.
Percentage Limit: This limit is determined as a percentage of an external creditworthiness score. The external score typically comes from CreditSafe.
The calculation involves: Credit Limit Received from CreditSafe (e.g., 1000) Limit Specified in the Limit Field (e.g., 50) The final credit limit is the percentage of the CreditSafe limit multiplied by the limit field value. In this example: Final Limit = 50% * 1000 = 500
Response – Enter the response shown to the customer when they fullfill the criteria for this rule and the the limit is assigned to them
Response Type – Choose the response type from either Success or Failure.
Similarly you can create multiple rules as per your requirements to appropriately assign the credit limits to your applicants.
Credit Applied Message – Enter the message that will be displayed to user when they have previously applied for Creditsafe application.
Enable Email – Select “Yes” or “No” to enable or disable the creditsafe application emails.
Success Email Template – Select the template to be used for success emails (successful credit safe application).
Success Email Sender – Select the Email Sender, the email to be used to send the success emails.
Success Email Recipient – You can add an additional email where the success emails will be sent alongside the applicant.
Fail Email Template – Select the template to be used for fail emails (failed credit safe application). This email will only be sent to the customer.
Fail Email Sender – Select the Email Sender, the email to be used to send the failure emails.
Fail Email Recipient – This is optional. You can add an additional email where the failure emails will be sent other than the customer. This email will be exactly same as the one sent to the customer.
Admin Fail Email Template – Select the template to be used for fail emails (failed credit safe application) to admin. This email template is only sent to the Administrator and not the customer. It contains for details regarding the failure of the credit application.
Admin Fail Email Sender – Select the Email Sender, the email to be used to send the failure emails to admin.
Admin Fail Email Recipient – This is optional. You can add an additional email where the failure emails will be sent alongside the admin. This failure email will be exactly same as the one sent to administrator.
Admin API Result Email Template – Select the template to be used for API results to admin. When the credit application occurs the requests and responses from various end points will be sent to the admin via this email template.
Admin API Result Email Sender – Select the Email Sender, the email to be used to send API results to admin.
Admin API Result Email Recipient – This is optional You can add an additional email where the API results will be sent alongside the admin. This email will be exactly same as the one sent to administrator contianing requests and responses of various end points hit during the credit application.
Approval Type – Select either "disabled" "manual" or "automatic". If "disabled" is selected, the verification will be disabled. If "manual" is selected,the credtisafe applications will be only approved/verified by the magento admin. If "automatic" is selected, the credisafe applications will be automatically approved or denied based on the Credit limits and Messages Configuration.
Allow customers to retry – If set to "Yes", customers will be able to re-apply for creditsafe application. If set to "No", once creditsafe application is submitted they won't be able to retry the application.
Maximum number of retry allowed:- Enter the maximum number of retries for customers to check their credit limit.
Email Sender – Select the email sender which will be used to send out applicant verification emails
Verification Success Email Template – Select the Email template to be used for successfull applicant verification.
Verification Rejected Email Template – Select the Email template to be used for failed applicant verification.
Success Credit Limit message (not verified):- Enter the success credit limit message when credit check was successfull but not verified.
Success Credit Limit message (verified)):- Enter the success credit limit message when credit check was successfull and verified.
Failed Credit Limit Message – Enter the message that will be displayed to customer when their credit check failedbut they have retries available.
Failed Credit Limit (no retries) – Enter the message that will be displayed to customer when their credit check failed and they have no retries available.
All requests and responses with regards to creditsafe endpoints are logged into a grid. You can view the logs by going into Admin>System>CreditSafe API Logs>Credit Safe Logs.
If you further click on any of the entries it contains the information as shown in the image below:-
Our module adds certain fields against the customer to keep track of credit assignment and available credit limits. Following fields are added:-
CreditSafe Credit Reference:- Credit reference number received from creditsafe upon credit application.
Credit Limit:- The limit received from creditsafe upon succefull credit application. Maximum limit that can be used by the customer to make purchases. It does not decrease after transactions.
Credit Balance:- The limit received from creditsafe upon succefull credit application. Maximum limit that can be used by the customer to make purchases. This value get's updated based on transactions made by the customer. for eg:- if they make purchase using the credit limit then that amount will be deducted and reflected here.
Credit Limit Verified:- This toggle turns on when the customer verification is complete, either manual or automatic.
Credit Limit Retry Count:- The number of times a customer has applied for credit application.
Based on the "Approval Type" configuration described earlier, the customer's verification takes place:-
Automatic:- The customer verification is done automatically.
Manual:- When "manual" verification is selected, then it is upon the administrator to verify the customer, for eg:- asking for documents via email and verifying them in person. Once verified admin can click on the verify button or turn on the toggle in the customer page ( go to Admin>Customers>All Customers>select the customer). Once verified by using the "Verify" button, the customer get an email regarding their successful verification.
Disabled:- Customer verification is not required and upon successful application the credit limits are assigned to customer.
It allows you to track and manage adjustments made to customer credit limits based on their orders and payments. With this system, you can view and manage adjustments made to customer credit limits in a single, easy-to-use grid. Easily Keep track of adjustments made to customer credit limits. Go to Admin>Sales>Creditsafe>Transactions. The grid reflects both positive and negative adjustments i.e when a customer makes a purchase using their credit limit and when they make the payment of the invoice.
You can import transactions by either going into Admin>System>Import our by going to sales>Orders>Import from CSV. Next select the "Entity Type" as "CreditSafe Transaction Import" from the dropdown.
The format of the import file should be as shown in the image. The fields required are as follows:-
entity_id:- Enter the id of the next transaction as per your CreditSafe Transaction Grid. For eg:- if you have 1-24 transactions then you should start the list from 25..26 and so on.
payment_date:- Date & time of the payment received or deducted.
adjustment_amount:- Enter a positive or negative adjustment amount. adding a positive amount will add the amout in the customers credit balanace wheras for negative amount it will deduct the amount from credit balance.
increment_id:- Enter the order id.
customer_email:- Enter the customer email.
transaction_description:- You can add a description of the adjustment which will be reflected in the creditsafe transactions grid.
Customers can apply for creditsafe application from their My Account section using the button "Apply for Web Credit Account".
Table of Contents
Installation via app/code
Installation via Composer
General Settings
Order and Quote Anonymisation Settings
Privacy Settings
General Settings
Popup Styling
Additional Tabs
Manage Choice List
Add New Cookie Choice
Using Module
Manually Adding Code
Front-end Site View - Integrate Cookies with GTM Pro Tracking
Cookie Pop-up- Cookie Accept
Cookie Pop-up- Cookie Accept for different store views
Cookie Preferences
Check the Value of the Accepted Cookies on the Front-end
Visibility of "Accept All" Button on the Cookie Popup
Newsletter Subscription
Privacy Policy Checkbox on Registration and Checkout Page
Delete Account from My Account Section
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.
Installation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Go to Admin > Stores > Configuration > Scommerce Configuration > GDPR
Enabled - Select “Yes” or “No” to enable or disable the module.
Enable Customer Account Deletion/ Anonymisation - Set to “Yes” if you want to delete record on the frontend from my account.
Attention Message - The message shown to customers on the frontend before deleting the account.
Success Message - The message shown to customers on the frontend after deleting the account.
Email Sender - Select email sender. The email address used to send the link to the customer to delete their account and confirmation email about deletion. It also sends customer data to administrator just before deleting.
Confirmation Email Template - Select confirmation email template.
Delete Confirmation Email Template - Select template for delete confirmation email.
Enable Cookie Message -This allow you to enable or disable the module.
Block access to site until cookie policy is accepted - If set to “Yes” then customer access to site will be blocked until cookie policy is accepted. If set to “No” then just normal cookie message block will be shown until cookie policy is accepted, but the access to the site will be allowed.
Page Wrapper Css Class - Add the page wrapper Css class.
Cookie text message - Enter cookie text message, if you want to display message in cookie policy area.
Information Page - Use this page to learn about cookie settings.
Cookie link text - Text on link to information page.
Cookie text color - Color of cookie text message.
Cookie link color - Cookie of link in cookie policy area.
Cookie background color - Background color of cookie policy area.
Message Position - Select position "Top/Bottom" of the cookie notification message.
Order anonymisation after (days) - Enter the number of days to anonymize personal data in order related tables. Leave it blank, if you don’t want to anonymize any personal data automatically.
Chunk of order to anonymize – If you have a huge amount of transactions in the system, then you should limit the number of transactions to be anonymized when the cron job runs every hour.
Quote expires after (days) – Enter number of days to set personal data to NULL in sales_flat_quote table.
Enable Debugging – If set to “Yes” it will log debugging data related to quote and order anonymisation in the log file under var/log/anonymisation log.
Enable Privacy Setting – This will enable privacy agreement checkbox on pages where you collect personal data.
Privacy Setting Text – This text will appear next to privacy agreement checkbox.
Enable Newsletter – If set to “Yes” then privacy agreement checkbox will appear for the customers to confirm before submitting the newsletter subscription.
Enable Registration – If set to “Yes” then privacy agreement checkbox will appear for the customers to confirm before submitting the registration form.
Enable Contact us – If set to “Yes” then privacy agreement checkbox will appear for customers to confirm before submitting the contact us form.
Enable Checkout – If set to “Yes” then privacy agreement checkbox will appear for customers to confirm before submitting the billing form.
Go to Admin > Stores > Configuration > Scommerce Configuration > Cookie Popup
Enabled - Select “Yes” or “No” to enable or disable the module.
Modal Title - Enter name of the modal title, this will be shown on the frontend cookie popup modal. We’ve set modal title as “Cookie preferences”.
Save Choice Button Text - Enter the title of the save choice button. Click on this button will save the cookies choice. Whatever the current cookie choice is there it will save that choice.
Accept All Button Text Popup- Enter title for cookie popup accept all button.
Decline All Button Text Popup- Enter title for cookie popup Decline all button. Leave the field empty to hide this button in the cookie popup.
Accept Button Text banner- Enter title for cookie banner accept button.
Decline Button Text banner- Enter title for cookie banner Decline button. Leave the field empty to hide this button in the cookie popup.
Cookies List Header - Title of the block for the "Used by" list. Cookies name will be shown under this cookies list header. You can see "Used by" list on the frontend Cookie popup.
Cookie Settings Link Text - This link will be shown on the frontend cookies message to show Cookie Popup Settings. Click on this link will open Cookie popup.
Cookie Message Settings Link Text - Please add the cookie message link text
Use Data Layers - Select "Yes/No". If set to "Yes" then Data Layers will be used, instead of cookies for GTM. If set to "No", then it won't add Data Layers.
Show if not all accepted - Select “Yes/No”. If set to “Yes” then Cookie notice message will appear if not all cookie accepted.
Show cookie banner unless consent given - Select Yes/No. If set to "Yes" then it controls the visibility of the cookie consent banner on your website. When enabled, the banner will persistently display until the user actively consents or declines the use of cookies even when all cookies are granted by default. If disabled, the banner will be hidden when all cookies are granted by default.
Modal Border - Select "Yes", if you want to set modal border. If "Yes" then you can set border color for the settings Modal box.
Popup Border Color - Enter popup border color. We've set the popup border color white, which you can see in the screenshot.
Toggle Color – Enter Toggle color. We’ve set the toggle color. which you can see in the screenshot.
Header Background Color - Enter header background color. Background color of the Modal box title.
Header Font Color - Enter header font color.
Header Bottom Border - Select "Yes", if you want to set the bottom border. If "Yes" then bottom border of the Modal box header will be shown.
Header Bottom Border Color - Enter header bottom color. We’ve set the red header bottom border.
Footer Background Color - Enter footer background color.
Footer Font Color - Enter footer font color.
Footer Top Border - Select "Yes", if you want to set footer top border. If “Yes” then top border of the footer of the Modal Box will be shown.
Footer Top Border Color - Enter footer top border color.
Header Logo - Choose logo for the modal header. It will be shown in the left top corner in header.
Close Image - Upload close image.
Active Tab Background Color - It will highlight the selected choice text.
Number Tabs - Select "Yes", if you want number tabs on cookie modal.
Tab Header Color - Enter tab header color.
Tab Active Color - Enter active tab color.
Custom Button Style - Select "Yes", if you want to style button.
Custom Checkbox - Select "Yes", if you want to show cookie choice button.
Font Family - Enter base font family for the Modal Box. Should be string e.g. Arial. Font should be available on the site.
Accept Button Text Color - Enter text color of the "Accept" button on the Cookie Message
Accept Button Background Color - Enter Background color of the "Accept" button on the Cookie Message.
Decline Button Text Color - Enter text color of the "Decline" button on the Cookie Message.
Decline Button Background Color - Enter Background color of the "Decline" button on the Cookie Message.
Notice Height - Set min height of the Cookie Message. E.g. 80
Required cookie option text - Set to "Always Active", this text will replace checkbox for mandatory cookies
Custom CSS - Provide CSS code for custom style.
First Tab Title - Provide title of the first tab you want to display on the frontend cookie pop up. This tab will be shown first before cookie choices. Both Title and Text should be set to appears on the Modal box
First Tab Text - Enter first tab text. The text will be shown on the Modal box on click of first tab. We've set first tab as "Your Privacy ".
More Information Title - Provide more information title. This will be shown after all cookie choices as a last tab. Both title and link should be set to appears on the Modal box
More Information Link - Provide link where you want to redirect it. Click on this link will redirect you to Information page.
Manage Choice List - To create and manage cookie choices, go to Admin
Customers > Manage Cookie Choices > Manage Choice List. If you need to make some modifications in the cookie choices information, you should click “Edit” in the Action column. The grid includes the following columns: -
Cookies can be created for specific store views and these cookies are only available in that particular store view.
Add New Cookie Choice - To create a new cookie choice, click on the “Add New Cookie Choice” button from Admin > Customers > Manage Cookie Choices > Manage Choice List > Add New Cookie Choice, it redirects on "New Choice" page, by providing all the below configuration details you can create the cookie choice.
Choice Name - Enter the choice name. This is the text which represents the type of the cookie you are using under it.
Store View - Select store view.
Choice Description - Add the choice description. This description will appear on the cookie pop up when user clicks on the cookie choice name.
Cookies Created By - Add the created by details. This is just an information which will appear on the cookie pop up under "Cookies are user by" section.
Required - Select "Yes" to make cookie essential, else select "No". If set to "Yes" then the cookie choice will always be selected and you can't turn "Off" it.
GTM- Set this to "Yes" if you want to control GTM using this cookie. GTM will only be enabled when this cookie is accepted.
Set by Default - Select default status "Yes" or "No". If set to "Yes" then by default the cookie choice will be selected.
When customers check the privacy policy agreement checkbox in the process of registration then it saves the details of the customers in backend privacy policy consents at Admin > Customers > Privacy Policy Consent.
When you select action "Anonymise order" from Admin > Sales > Orders > Actions > Anonymise Order > Click on Submit button, then it anonymise customers data, which can't be reversed. Before "Submit" it asks for confirmation and displays a message popup says "Are you sure you want to anonymise selected transaction data because of this action can't be reversed?".
To see newsletter subscription records go to Admin > Marketing > Newsletter Subscription.
You can enable or disable GTM tracking using cookies. We have provided an additional check in cookie setup which confirms whether GTM should be checked alongwith the cookie or not. when this check is enabled if the customer doesent accept the cookie then this tracking won't fire. If multiple cookies have the same option enabled then if any one of the cookie is accepted GTM will fire on the store.
Go to Customers>Manage Cookie Choices then create a new cookie or edit the existing one and set GTM to 'Yes'.
This section will cover Enabling or Disabling tracking without using Google Tag Manager. You can do that by including tracking function in your code, let us learn how. If you are using any of our tracking extensions or any other third party extension and you don't want to send information to Google then you need to check for the cookie name e.g. "statistics_cookie" and this will be set to 1 for "accept" and 0 for "decline", based on cookie value it will enable or disable the tracking.
In case you are using a third party extension then you need to add the code given below. This code needs to be added where your tracking has been implemented.
Here is the function which will force your tracking not to run unless the cookie has been accepted by the customer from cookie notification message.
e.g. You can add name of your GDPR cookie, here for our GDPR extension the name of cookie key is "statistics_cookie", which we have been using in below code.
You can integrate cookies with GTM Pro by following the below steps in GTM:-
Step 1 – The very first step is to create your cookie from the admin panel. To do that please refer to the 4th Part in this guide. The key thing to remember is the name of the cookie that you create in this step.
Step 2 – The next step is to verify whether your cookie is working properly. Go on your website and accept or decline the cookie you have created in the begining. Now navigate to the Page inspector of your browser. Next go into application and then on the left navigation go to storage>cookies and then click on your website. A list of cookies will appear before you as you can see in the image. Now suppose you created a cookie named “Statistics_cookie” in the first step and have accepted it on the website then the value of this cookie will appear as 1. Vice versa if you have declined this cookie then the value will be 0.
Step 3 – Open google tag manager, go into variables section and Create a new variable named "statistics_cookie", variable type should be 1st-Party cookie and give the name of the cookie as "statistics_cookie". Keep in mind the name of the cookie should be exactly same as you have created in the admin panel. For instance, we created a cookie named “Statistics_cookie” so we have a variable named exactly same.
Step 4 – Now navigate to triggers in GTM and select a trigger and add a custom event as follows: -
From first drop-down- select variable name created in Step 1 i.e. "statistics_cookie"
From second drop-down- select equals
Third Input box- put value 1
Step 5- Associate the trigger created in Step 4 with any of the existing tags and that tag will only fire when customer accepts the cookie on your website.
Let us see how it works on the front-end.
Visit the store and go to cookie settings on the pop-up. In the cookie preferences:- -- select your cookie. In this case we have created statistics cookie. -- Next from the top right corner select the checkbox to enable the cookie and save your choice.
Next check the inspector of your browser to verify whether your cookie is enabled/disabled. If you have enabled the cookie then the value will be 1 and if it is disabled then the value will be 0. Refer to the image below.
Finally check the GTM pro to see whether the tags that we associated with your cookie have fired or not. In our case universal analytics is fired since we added the cookie settings for google analytics. Similarly if the cookie is disabled I.e value is 0 then this tag won’t be fired.
Cookies are used to improve the experience for user. Once you accept, the file is added and the cookie helps analyse web traffic or lets you know when you visit a particular site. Cookies allow web applications to respond to you as an individual.
Cookies are used to improve the experience for user. As we created different cookies for different store views we will see their behaviour on the frontend.
Accept cookie for default store view:-
Accept cookie for German Store view
You can check the value of the accepted cookies by using developer tool (F12). Here is the path to check, Press F12 > Network > Storage > Cookies > Click on site URL > Check the cookies status/value under "Value" column.
When you "accept" cookies, the value will be set to "1".
When you "decline" cookies, the value will be set to "0" .
The "Accept All" button will be shown on the cookie popup, if all cookie choices are not required and "Set by Default" for cookie choices set to "No" from Admin > Customers > Manage Cookie Choices > Manage Choice List > Select Cookie Choice > Edit >Set by Default - "Yes/No". If set to "Yes" then "Accept All" won't appear.
Once Enable Newsletter is configured from Admin > Stores > Configuration > Scommerce Configuration > GDPR > Privacy Settings > Enable Newsletter - "Yes" , then you can see the privacy agreement checkbox on the newsletter subscription. This is a mandatory option. Click on "Privacy Policy" link redirects to privacy policy page.
The privacy policy checkbox will be shown on the registration and checkout page.
You can delete the account from Front-end > My Account > Delete Account section.
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
Create SHA256 hash of contents of with the script or style tag and then use bas64 to encode this hash. It can be done all together :-
We will go the site() and create a SHA256 hash as well as the base64 encode of this hash of the contents of the style tag as shown in screengrab below:-
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
Chat GPT API Key - Enter the API key from Chat GPT ()
Gemini API Key - Enter the API key from Gemini ()
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
This section is to configure TWILIO as the SMS provider used for sending OTPs. Please visit to create an account and extract the information to be added below:-
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
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
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
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 .
API Key (RapNet):- Enter the API key provided by RapNet here. • The following key works only “localhost” domain: 8EC95570ABE6411290197CB28845A6FF
Please note - “localhost” means domain. Not IP- address like “127.0.0.1”, not other domain matched to local IP, “localhost” means domain. So this test API-key used only for local site running via “”. Not for “”, not for “”, only for t”
RapNet brings millions of dollars in diamond product to your Magento store, without the cost of owning the physical diamonds. All diamonds and attributes should be configured directly from RapNet admin panel. RapNet provides data and pricing in real time. Once the customer places the order using the ring builder the product gets automatically created in Magento catalog.
Put any value with url of the document (ex. ) in the “Has cert file” attribute for the certificate
Put any value for 360 url value for “ Sarineloupe Url“ attribute (ex. ) and 1 to “ Has Sarineloupe“ attribute.
Test URL -
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact .
In this section, you will find installation, setup and user guide for all our . If you don't find what you are looking for then you can email us at
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 .
Cookie Name - Define the cookie name. Cookie name will be used to enable/disable your relevant trackings. To explore more about Cookies, please check the section.
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
Category Canonical Tags
Product Canonical Tags
CMS Canonical Tags
No Index No Follow
Category set up for Canonical URL
Product set up for Canonical URL
CMS set up for Canonical URL
Rollback Plan
Category Canonical Tags
Product Canonical Tags
CMS Canonical Tags
Disable Compilation Mode: To check that this is disabled, go to System >Tools> Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags
Category Canonical Enable – Set it to yes, if you want canonical tag on category pages.
Exclude Current Category in Admin – Set it to yes, if you don’t want same category to appear in the drop-down selection while choosing canonical category for a category.
Append Text with Every Category URL Path – Set it to yes, if you want to append text with overridden canonical URL as well. This setting is useful when you have pagination/filtered navigation/sorting on your site.
Product Canonical Enable – Set it to yes, if you want canonical tag on product pages.
Include Category Path – Set it to yes, if you want to include category path in the canonical tag alone with product URL.
CMS Canonical Enable – Set it to yes, if you want canonical tag on cms pages.
Enable – Set it to yes, if you want to add noindex, nofollow in the head section.
Action Names – Add action names here to add noindex, nofollow in the head section for specific page. New route name needs to be added in next line. Action name can be determined using $this > getAction() > getFullActionName()
Route Names – Add route name here to add noindex, nofollow in the head section for list of pages. New route name needs to be added in next line. Route name can be determined using Mage::app() > getFrontController() > getRequest() > getRouteName()
Go to Admin > Catalog > Categories > Manage Categories > Choose Category (for which you want to set Canonical URL)
Canonical URL – Select the category from the dropdown, this selected category’s URL will be rendered for search engines to pick it up as canonical URL.
Override Canonical URL – Enter text here to be used as canonical tag URL. This will be given highest priority if entered.
For example /women.html?limit=all (without domain name)
Robots Setting – Select the robot settings from dropdown, it comes with the following options -:
No Index, No Follow
No Index, Follow
Index, No Follow
Go to Admin > Catalog > Manage Product > Choose Product (for which you want to set Canonical URL)
Override Canonical URL – Enter text here to be used as canonical tag URL. This will be given highest priority if entered.
Canonical Primary Category – Select primary category to be included in canonical URL tag.
Go to Admin > Catalog > CMS > Pages > Choose Page (for which you want to set Canonical URL)
Canonical URL – Enter text here to be used as canonical tag URL. For homepage you can enter “/”
Robots Setting – Select the robot settings from dropdown, it comes with the following options -:
No Index, No Follow
No Index, Follow
Index, No Follow
Delete the following folders from FTP
Run the following sql commands: -
Category Canonical Tags – You can enable canonical tags on the category page from Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags > Category Canonical Enable – Select – “Yes”
Product Canonical Tags – To add canonical tag on the product page, go to Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags> Product Canonical Enable – Select – “Yes”
CMS Canonical Tags – You can add canonical tag on the CMS page from Admin > Stores > Configuration > Scommerce Configuration > Canonical Tags> CMS Canonical Enable – Select – “Yes”
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
Google Friendly SEO Navigation (Fetch as Google)
Search Engine Optimization of Layered Navigation
Custom View of Layered Navigation
Disable Compilation Mode: To check that this is disabled, go to System >Tools> Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right-hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Layered Navigation
Enabled – Select “Yes” or “No” to enable or disable the module.
Search Engine Optimization of Layered Navigation - See the image below for Layered Navigation view.
Custom View of Layered Navigation – Here is the custom view of the Layered Navigation
Disable Compilation Mode: To check that this is disabled, go to System->Tools->Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right-hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System->Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change. Log out and login back in Admin.
Admin Configuration: Go to Admin ->System->Configuration->Scommerce Configuration -> Lazy Load Images -> General
Enable : Enable / Disable Module
License key : Enter License key provided by Scommerce Mage
Theme changes: If you are not using your custom theme then this module should work out of the box. But if you are using custom theme then follow the following steps -:
Check if you have the following file in your custom theme folder
/app/design/frontend/default/<custom>/template/cate gory /list.phtml
If the above file does exist in your custom theme then copy the differences from the following file -:
/app/design/frontend/default/base/template/category/list.phtml
Clear Caches: Once you are done with everything above, clear the cache to get the changes reflect on your website.
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
Compress/Optimize Product Images
Compress/Optimize Category Images
Compress/Optimize CMS Images
Google Page Speed Test Result for Desktop
Google Page Speed Test Result for Mobile
Disable Compilation Mode: To check that this is disabled, go to System >Tools > Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Optimize Images
API Key – This will be required for certain providers like Kraken.io
API Secret Key – This will be required for certain providers like Krake.io
Thumbnail images size – Provide thumbnail sizes for your product images in a comma separated format for example 50x,56x56,75x. If you are not sure the you can either check sizes under \media\cache\1\small_image folder or just simply save the configuration.
Small image sizes – Provide small images for your product images in a comma separated format for example 135x,120x120,100x. If you are not sure then you can either check sizes under \media/cache/1/image folder or just simply save the configuration.
Image sizes – Provide image sizes for your product images in a comma separated format for example 900x,988x988,750x. If you are not sure then you can either check sizes under \media\cache\1\image folder or just simply save the configuration.
Override Cache Folder Sizes – This allows you to override default cache folder i.e. 9df78eab33525d08d6e5fb8d27136e95 either completely or by size. To replace completely just add the new cache folder name for example 040ec09b1e35df139433887a97daa66f and for size it will be delimited for example 135x|040ec09b1e35df139433887a97daa66f; 125x125|17f82f742ffe127f42dca9de82fb58b1
Backup Images – Enable this feature to backup original images before compressing original file.
Debugging – This will create optimizeImages.log file under var/log folder.
You can compress product images by enabling module from Admin > Stores > Configuration > Optimize Images > Enabled – “Yes” > Compress Images while uploading – Select “Product”.
You can compress category images by enabling module from Admin > Stores > Configuration > Optimize Images > Enabled – “Yes” > Select “Category”.
You can compress CMS images by enabling module from Admin > Stores > Configuration > Optimize Images > Enabled – “Yes” > Select “CMS”.
Please follow the instructions below to install Scommerce Mage Modules via Composer:-
Step 1: Navigate to our store and login to your account. Then go to the My Account Section, on the left menu click on Composer Instructions.
Step 2: Next, run the config commands shown on the top of the page then click on the extension that you want to install. A composer require command will be revealed in the dropdown menu. Run the command.
Step 3:- Lastly run the commands given below to complete the setup.
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
Configuration Path to Set Up Primary Category
Product Page Unique URL
Search Page / Category Page Unique Catalog Product URL
Disable Compilation Mode: To check that this is disabled, go to System >Tools> Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right-hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Catalog URL
Enabled – Select “Yes” or “No” to enable or disable the module.
Remove Category Path – Select “Yes” if you want to remove category path from product URLs. By default it is “No”.
Exclude Root Categories – Exclude some root categories to appear as primary category dropdown against products.
To set primary category go to Admin > Catalog > Select Product > Primary Category. The drop down will show all the categories selected for the product from where you can select the primary category of the product.
Product Page Unique URL – You can assign primary category to a product from Admin > Catalog > Select Product > Primary Category. In the below image you can see the primary category “Home & Decor > Electronics” has been set for the product Madison LX2200.
Search Page / Category Page Unique Catalog Product URL – We have set the primary category of "Madison LX2200" product to “Home & Decor > Electronics”, and the category path remains the same when we access the product from the search or any other category, which you can see in the below image.
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
Exclude Categories from Sitemap
Exclude Products from Sitemap
Exclude CMS from Sitemap
How to Generate Sitemap
Add new Sitemap
Magento Out of the Box Functionality to set the Category Path
Product Link in Sitemap XML
Category Link in Sitemap XML
CMS Page Link in Sitemap XML
Disable Compilation Mode: To check that this is disabled, go to System >Tools> Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Sitemap
Enabled – Select “Yes” or “No” to enable or disable the module.
Include Product Image – This option allows to add main product image or main and additional product images to Google Site Map.
Exclude Categories from Sitemap – To include or exclude categories, go to Admin > Catalog > Manage Categories > Select Category (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”.
Exclude Products from Sitemap – To exclude products from sitemap, go to Admin > Catalog > Manage Products > Select Product (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”.
Exclude CMS from Sitemap – To exclude CMS pages from sitemap, go to Admin > CMS > Pages > Select CMS Page (you want to exclude from site map) > General > Exclude from Sitemap: Set to “Yes/No”.
How to Generate Sitemap – To generate the site map from the admin panel go to Admin > Catalog > Google Sitemap > Click “Generate Sitemap”.
Add new Sitemap – You can create a new site map from Admin > Catalog > Google Sitemap > Click “Add Sitemap”, it redirects to New Site Map page, and by providing all the required details you can create Site Map.
Magento Out of the Box Functionality to set the Category Path – To include category path in product URLs in sitemap.xml, go to Admin > System > Catalog > Catalog > Search Engine Optimizations > Use Categories Path for Product URLs: Set to “Yes”.
Google site map shows all the Included Products, Categories, and CMS Page links in the sitemap.xml
Product Link in Sitemap XML – You can see the product link in the Google Sitemap XML.
Category Link in Sitemap XML – You can see the category link in the Google Sitemap XML.
CMS Page Link in Sitemap XML – In the below screen grab you can see the about-us page link in the Google Sitemap XML.
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
Manage Meta Information
Add Meta Information
Disable Compilation Mode: To check that this is disabled, go to System >Tools> Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right-hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Meta Information for Any Page
Enabled – Select “Yes” or “No” to enable or disable the module.
Manage Meta Information
Meta Information
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 .
Append Text with Category URL Path – Enter text to append with canonical URL. This setting is useful when you have pagination/filtered navigation/sorting on your site. For example
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Please contact in case of any queries.
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .
Table of Contents
Disable Compilation Mode
Upload Package
Clear Caches
General Settings
HTML Selectors
Facebook OpenGraph
Attributes
Home Page Markup Code
Category Page Markup Code
Product Page Markup Code
Twitter, Facebook Open Graph Social Sharing Code
Increased and Optimized Page Ranking in Search Result
Disable Compilation Mode: To check that this is disabled, go to System >Tools> Compilation. If the compiler status is ‘Disabled’, you are ready to go. If not, simply click the ‘Disable’ button on the right hand side of the screen.
Upload Package: 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.
Clear Caches: This can be done from the admin console by navigating to the cache management page (System > Cache Management), selecting all caches, clicking ‘refresh’ from the drop-down menu, and submitting the change.
Go to Admin > Stores > Configuration > Scommerce Configuration > Rich Snippet
Enabled – Select “Yes” or “No” to enable or disable the module.
Product view wrapper – Main CSS class name for the product wrapper.
Description Attribute – CSS class name for short description.
Price Info – CSS class name for price information block including availability.
Product Price – HTML element ID for the product price.
Product Price excl. tax – HTML element ID for the product price excluding VAT or TAX.
In Stock Span – CSS class name for “in stock” span tag for showing availability.
Out of Stock span – CSS class name for “out of stock” span tag for showing availability.
Breadcrumbs Wrapper – CSS class name for breadcrumbs wrapper.
Reviews and Rating Wrapper – CSS class name for review name and rating wrapper.
Image – HTML element ID or CSS class name for product main image.
Organisation – CSS class name for div in the where log is defined.
Logo – CSS class name for anchor element of the logo.
Enable – Set “yes” to enable Facebook open graph tags.
AppId – Set Facebook app id
Sitename – Set Facebook site name
Enable – Set “yes” to enable twitter.
Sitename – Set twitter site name (@username for the website used in the card footer)
Creator – Set twitter creator name (@username for the content creator / author)
Product Title Attribute – Select product title attribute you want to send to Google, Facebook, Twitter etc.
Product Description Attribute – Select product description attribute you want to send to Google, Facebook, Twitter etc.
Category Title Attribute – Select category title attribute you want to send to Google, Facebook, Twitter, etc.
Category Description Attribute – Select category description attribute you want to send to Google, Facebook, Twitter etc.
Brand Attribute – Please select brand attribute from the dropdown.
Global Product Identifier Attribute – Select product identifier attribute from the drop-down list.
Global Product Identifier Type – Select product identifier type from the drop- down list. It could be one of the following: gtin8, gtin13, gtin14, mpn.
Home Page Markup Code – You can add structured data/markup code on homepage from Admin > Stores > Configuration > Rich Snippet > Enable – “Yes”. To test structured data, go to Structured Data Testing Tool > Provide Home Page URL > Click “Run Test”.
Category Page Markup Code – You can add markup code, breadcrumbs on category page from Admin > Stores > Configuration > Rich Snippet > Enable – “Yes”.
Product Page Markup Code – To add structured data markup code on product page, set “Enable” to “Yes” from Admin > Configuration > Rich Snippet .
Twitter Code – You can enable Twitter from Admin > Stores > Configuration> Rich Snippet > Twitter > Enable – “Yes”
Facebook Open Graph – Enable Facebook Open Graph from Admin > Stores> Configuration > Rich Snippet > Facebook Open Graph > Enable – “Yes”
Increased and Optimized Page Ranking in Search Result – In the below image you can see the increased and optimized page ranking in search results.
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 .
If you have a question related to this extension please check out our first. If you can't find the answer you are looking for then please contact .