# User Experience Extensions
# Magento 2 Product 360 view
### Installation and User Guide for Magento 2 Product 360 view extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Product360 view*](#bkmrk-configuration-settin)
- *General Settings*
- *360 view settings*
3. *[Add 360 View Images to a Product](#bkmrk-add-360-view-images-)*
4. [*Frontend*](#bkmrk-frontend)
### Installation
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Product 360 view
Go to **Admin > Stores > Configuration > Scommerce Configuration > Product 360 view**
#### General Settings
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-52.png)
#### 360 View Settings
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-53.png)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-54.png)
### **Add 360 View Images to a Product**
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:-
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-55.png)
### **Frontend**
#### 360 View
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-29-1.png)
#### 360 View Full Screen Image
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-30-1.png)
If you have a question related to this extension please check out our [**FAQ Section** ](https://www.scommerce-mage.com/magento-2-product-360-view.html#customfaq)first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 FAQ
### Installation and User Guide for Magento 2 FAQ Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for FAQ* ](#bkmrk-configuration-settin)
- *General Settings*
- *Manage FAQ's*
- *Manage FAQ Category*
3. [*Front-end Site view*](#bkmrk-front-end-site-view)[ ](https://docs.scommerce-mage.com/magento-2-faq.md#bookmark7)
- *FAQ Categories*
- *FAQ Product*
### Installation [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for FAQ [](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration > FAQ**
#### General Settings [](#bkmrk--2)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-39.jpg)
**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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-56.png)
**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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-57.png)
**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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-58.png)
**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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-59.png)
**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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-40.jpg)
**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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-60.png)
**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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-61.png)
**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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-62.png)
### Front-end Site view [](#bkmrk--12)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-41.jpg)
- **FAQ Product -** Select "Yes" for **"** Enable FAQ for Products" from **Admin > Stores > Configuration > Scommerce Configuration > FAQ**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-42.jpg)**
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-faq.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Cancel Order by Customer on the Frontend
### Installation and User guide for Magento 2 Cancel Order by Customer on the Frontend Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Cancel Order* ](#bkmrk-configuration-settin)
- *General Settings*
3. [*Front-end Site View for Order Cancellation from My Account Section* ](#bkmrk-front-end-site-view-)
- *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 [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Cancel Order [](#bkmrk--2)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Cancel Order**
#### General Settings [](#bkmrk--3)
- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- **License Key -** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-43.jpg)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-44.jpg)
### Front-end Site View for Order Cancellation from My Account Section [](#bkmrk--6)
- **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.**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-63.png)**
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-64.png)
- **Notification Message for Cancel Order -** After the order cancellation it shows notification message on the front-end.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-45.jpg)
- **Cancel Order status (Cancelled) -** When you cancel the order then it automatically updates the order status from Pending to Cancelled.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-65.png)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-46.jpg)
- **Guest Form -** The guest user can cancel order by submitting the Orders and Returns form. Here is the link to access the form [Orders and Returns](http://demo2.scommerce-mage.co.uk/sales/guest/form/). The form will have the following fields: -
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-66.png)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-47.jpg)
- **Cancel Order Successfully -** Once the order is cancelled, it displays the successful cancellation message.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-67.png)
If you have a question related to this extension please check out our[ **FAQ section**](https://www.scommerce-mage.com/magento-2-cancel-order.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Previously Ordered Products
### Installation and User Guide for Magento 2 Reorder Previous Products Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Reorder Previous Products* ](#bkmrk-configuration-settin)
- *General Settings*
3. *[Hide One or Multiple Columns from the Previous Purchases Grid](#bkmrk-hide-one-or-multiple)*
4. [*Front-end Site view* ](#bkmrk-front-end-siteview)
- *Previous Purchase Grid*
- *Hide Columns in the Previous Purchase Grid*
- *Add One or Multiple Products to Cart Directly From the Grid*
### Installation [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Reorder Previous Products [](#bkmrk--1)
#### Go to Admin> Stores> Configuration> Scommerce Configuration> Global Site Tag (gtag.js)
#### General Settings [](#bkmrk--2)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **Hidden Columns –** You can hide one or multiple columns from the previous purchases grid. The columns that can be hidden are listed below:-
- #### Thumbnail
- **Qty**(Quantity)
- #### Last Order Date
- #### Last Order Number
- #### Last Order Price(Ex. tax)
- #### Last Order Price(Incl. tax)
- #### Current Product Price
- #### Number of Orders
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-48.jpg)
### Hide One or Multiple Columns from the Previous Purchases Grid [](#bkmrk--4)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-49.jpg)
### Front-end Siteview [](#bkmrk--6)
#### Previous Purchase Grid [](#bkmrk--7)
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:-
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-68.png)
#### Hide Columns in the Previous Purchase Grid [](#bkmrk--9)
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).
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-50.jpg)
#### Add One or Multiple Products to Cart Directly from the Grid [](#bkmrk--11)
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.
If you have a question related to this extension please check out our [**FAQ section**](https://www.scommerce-mage.com/magento2-reorder-previous-products.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Product Shelf Life
### Installation and User Guide for Magento 2 Product Shelf life Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Product Shelf Life Expiration* ](#bkmrk-configuration-settin)
- *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*
3. [*API - Application Programming Interface* ](#bkmrk-api---application-pr)
- *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 [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Product Shelf Life Expiration [](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Product Shelf Life Expiration**
#### General Settings [](#bkmrk--2)
- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- **License Key –**Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-51.jpg)
### Batch Settings [](#bkmrk--4)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-52.jpg)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-53.jpg)
#### Product Batches Grid [](#bkmrk--7)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-69.png)
- **Add Sources at Product Level -**You can add product source from **Admin > Catalog > Select Products >** Click **"Assign Sources">** Select **"Source">** Click **"Done"** .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-70.png)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-54.jpg)
- **Un-Associate / Delete Product Batch -**Toun-associate and delete product batch, go to**Admin > Product Batches> Select Batch > Edit >**Click **"Un-Associate with Product''** and for **Delete** click on **"Delete"** button**.**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-55.jpg)**
#### Product Batches at Product Level [](#bkmrk--12)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-71.png)
#### Add Specific Batch to Product [](#bkmrk--14)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-72.png)
- **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:-
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/f36image-31-1.png)
- **Batch Details on the Order View Page -**To view theproduct batch related details, go to **Admin > Sales > Order > Select Order > View**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-73.png)
#### Deleting or Un- Associating a Product Batch [](#bkmrk--18)
- **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.
#### Note:- If an order has been shipped then you won't be able to delete that product batch. You will see an error.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/XhSimage-32-1.png)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-33-1.png)
#### Note:- If an order has been shipped then you won't be able to delete that product batch. You will see an error.
- **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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/H8Vimage-35-1.png)
#### Import / Export Product Batches [](#bkmrk--22)
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**.**
#### Import Settings
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-56.jpg)
**CSV File Format for Import -** CSV file will have batch\_code, batch\_qty, batch\_status, batch\_expiry, product\_sku and source\_inventory.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-74.png)
#### Export Settings
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/VqUimage-36-1.png)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-05/image-75.png)
### API - Application Programming Interface [](#bkmrk--27)
#### Authentication Token [](#bkmrk--28)
#### auth\_token can be received using the following: -
**You would need credentials to your store with admin rights Parameters:-**.Admin credentials
- Username
- Password
**POST URL:-** [http://baseurl/index.php/rest/V1/integration/admin/token](http://baseurl/index.php/rest/V1/integration/admin/token) Content-Type: application/json
{
"username": "admin", "password": "admin"
}
#### Creating a Batch using API [](#bkmrk--29)
#### Parameters:-
- Authorization token received from the above step
- Batch code
- Batch quantity
- Batch status
- Batch expiry
- Product SKU
**POSTURL:-**[http://baseurl/index.php/rest/V1/productbatches/createbatch](http://baseurl/index.php/rest/V1/productbatches/createbatch) Content-Type: application/json
Authorization: Bearer {{auth\_token}}
{
"batch\_code": "batchcode\_001", "batch\_qty": "10",
"batch\_status": "1",
"batch\_expiry": "2020-12-06", "product\_sku": "MH0001"
}
#### Retrieve all Batches using API [](#bkmrk--30)
#### Parameters:-
Authorization token
**GET URL:-**[http://baseurl/index.php/rest/V1/productbatches/getcollection](http://baseurl/index.php/rest/V1/productbatches/getcollection) Content-Type: application/json
Authorization: Bearer {{auth\_token}}
#### Retrieve Date of Batch using ID 1 Using API: - [](#bkmrk--31)
#### Parameters: -
- Authorization token
- Batch ID in URL
**GET URL:-**[http://baseurl/index.php/rest/V1/productbatches/getbatch?batchId=1](http://baseurl/index.php/rest/V1/productbatches/getbatch?batchId=1) Content-Type: application/json
Authorization: Bearer {{auth\_token}}
#### Delete Batch with ID 1 Using API: - [](#bkmrk--32)
#### Parameters: -
- Authorization token
- Batch ID
**PUT URL: -** [http://baseurl/index.php/rest/V1/productbatches/deletebatch](http://baseurl/index.php/rest/V1/productbatches/deletebatch) Content-Type: application/json
Authorization: Bearer {{auth\_token}}
{
"batchId": 1
}
If you have a question related to this extension please check out our[ **FAQ Section**](https://www.scommerce-mage.com/magento-2-product-shelf-life.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Social Login
### Installation and User Guide for Magento 2 Social Login Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Social Login* ](#bkmrk-configuration-settin)
- *General Settings*
- *Facebook*
- *Google*
- *Create Facebook App Id*
- *Create Google App Id*
3. [*Front-end Site View* ](#bkmrk-front-end-site-view)
- *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 [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory. ```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Social Login [](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Social Login**
#### General Settings [](#bkmrk--2)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **License Key –** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/L12image-84.jpg)
#### Facebook [](#bkmrk--4)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **Facebook App Id –** Enter your Facebook App Id. To create App Id, check [Facebook Developer](https://developers.facebook.com/apps).
- **Facebook App Secret –** Enter your Facebook App secret.
- **Valid OAuth redirect URLs –** Enter the redirect URLs.
- **Sort Order –** Enter the sort order for display.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/FjJimage-85.jpg)
#### Google [](#bkmrk--6)
- **Enabled –** Select "Yes" or "No" to enable or disable the module.
- **Client Id –** Enter your Google Client Id. To create Client Id, check [Google App](https://cloud.google.com/console/project).
- **Client Secret –** Enter your Secret Id.
- **Redirect Urls –** Enter the redirect urls.
- **Sort Order –** Sort order for display.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/ykQimage-86.jpg)
- **Create Facebook App Id -** To create Faceook app Id go to [**Facebook Developers**](https://developers.facebook.com/apps), login as a developer and choose "Create App" in the "My Apps" drop-down.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/GLgimage-87.jpg)
Specify the "Display Name" and "Contact Email" for your app. After that, click the "Create App ID".
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/X35image-88.jpg)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/bxyimage-89.jpg)
Click on the "Add Platform" button to choose the platform for your social apps.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/Qzdimage-64-1.png)
After clicking on the Add Platform button you will see the grid with various platform types. Please select Web.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/qkHimage-90.jpg)
After specifying the platform type, insert your website URL and click on the "Save Changes" button.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/YtLimage-65-1.png)
Enable the "Client OAuth Login" from **Facebook Login > Settings** and provide the "Valid OAuth Redirect URLs".
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/Fgaimage-91.jpg)
To apply the configuration, change the Status from "In development" to "Live".
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-92.jpg)
Insert your Facebook App Id and Secret Key in Facebook settings and Save the configuration.
**Create Google App Id –** To create Google App go to [**Google App**.](https://cloud.google.com/console/project) Click on the "CREATE PROJECT" button and configure your app settings.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/VtNimage-93.jpg)
Specify your "Project name", the project ID will be generated automatically.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/zADimage-94.jpg)
Go to the Credentials tab and create a client ID to integrate your website with Google.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/3YDimage-95.jpg)
Insert your website URL in the required field. In the field "Authorized Redirect URLs" add redirect website URL. Then, press the Create button.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/x4Nimage-96.jpg)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/8WLimage-97.jpg)
### Front-end Site View [](#bkmrk--21)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/ygTimage-98.jpg)
After successful login, it redirects to My Account page.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/Ocaimage-99.jpg)
- **Social Login Options on the Registration Page**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/Iu1image-100.jpg)**
- **Social Login Options on the Checkout Page**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t172105-084.jpg)**
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-social-login.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)\*\*.
# Magento 2 VAT Exemption
### Installation and User Guide for Magento 2 Vat Exemption Extension
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Vat Exemption* ](#bkmrk-configuration-settin)
- *General Settings*
- *Vat Exempt Settings*
3. [*VAT Exempt - Reasons* ](#bkmrk-vat-exempt---reasons)
- *Create New Reason*
4. [*Admin Order View Page* ](#bkmrk-admin-order-view-pag)
- *Declaration Statement on Order View Page*
- *VAT Exemption Details on Order View Page*
- *VAT Exemption Option for Admin Orders*
5. [*Enable VAT Exemption for Products* ](#bkmrk-enable-vat-exemption)
- *Include or Exclude Product*
6. [*Front-end Site View* ](#bkmrk-front-end-site-view)
- *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 [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory. ```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Vat Exemption [](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Vat Exempt Settings**
#### General Settings
- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- **License Key -** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t174914-001.jpg)
#### Vat Exempt Settings [](#bkmrk--3)
- **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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t174951-324.png)
- **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
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175028-898.png)
### VAT Exempt - Reasons [](#bkmrk--6)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175101-583.jpg)
- **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
### Admin Order View Page [](#bkmrk--8)
- **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**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175141-096.jpg)
- **VAT Exemption Details on Order View Page -** In the screen grab you can see the Vat exempted amount under **''Order Totals'' section**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175230-921.png)
- **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".**
**[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175302-017.jpg)**
### Enable VAT Exemption for Products [](#bkmrk--12)
- **Include or Exclude Product -** To include/exclude store products for the VAT exemption, go to **Catalog > Product > Select Product > Edit > VAT Exempt - ''Yes/No''**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175347-474.jpg)
### Front-end Site View [](#bkmrk--14)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175432-463.jpg)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175432-463.jpg)
- **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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175614-760.jpg)
- **VAT Exempt Discount -** You can see the exempted amount on the checkout page under **''Order Summary''** section.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175706-922.jpg)
- **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)).
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t175749-872.png)
- **VAT Exempt Discount on the Front-end -** You can view the VAT exemption information on the front-end under **''My Orders''** section.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/A7iimage-66-1.png)
#### VAT Exempt Declaration Statement on the Front-end - My Account - [](#bkmrk--21)
You can see the VAT exempt declaration statement under **My Account > My Order section**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-10t180017-998.jpg)
If you have a question related to this extension please check out our [**FAQ section**](https://www.scommerce-mage.com/magento-2-vat-exemption.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Substitute Products
### Installation and User Guide for Magento 2 Substitute Products Extension
****Table of Contents****
1. [**Installation**](#bkmrk-installation)
- **Installation via app/code**
- **Installation via Composer**
2. [\_Configuration Settings for Substitute Products](#bkmrk-configuration-settin)
- **General Settings**
- **Changes Required Using Custom Product Attribute Set**
3. [\_Assigning Substitute Products](#bkmrk-assigning-substitute)
- **Add Substitute Products**
- **Order Placed with Substitute Product**
4. [**Front-End View**](#bkmrk-front-end-view)
### Installation
- ****Installation via app/code:**** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- ****Installation via Composer:**** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Substitute Products
Go to ****Admin > Stores > Configuration > Scommerce Configuration >Substitute Products****
#### General Settings
- ****Enabled -**** Select "Yes" or "No" to enable or disable the module.
- \*\*License Key –\*\*Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t142758-746.jpg)
#### Changes Required Using Custom Product Attribute Set
****If you are using custom product attribute set and not the default attribute then this step must be performed to see the Substitute Products option at the product level.****
****Cause:**** This issue occurs when the necessary product attribute, `is_substitute_products_enabled`, has not been correctly assigned within its attribute set. For the extension's interface to work correctly, this attribute ****must**** be placed inside a specific group named "Substitute Products."
****Solution:****
1. ****Navigate to Attribute Sets:**** Go to `Stores > Attributes > Attribute Set` in your Magento admin panel.
2. ****Select the Correct Attribute Set:**** Find and click on the attribute set that is used by the products you are trying to link (e.g., `custom_attribute_set`, `Default`, etc.).
3. ****Create the "Substitute Products" Group:****
- On the Attribute Set edit page, click the ****Add New**** button under the "Groups" column.
- In the popup, enter `Substitute Products` as the group name and click ****OK****.
4. ****Assign the Attribute to the New Group:****
- Locate the `is_substitute_products_enabled` attribute in the "Unassigned Attributes" column on the right.
- Drag and drop this attribute into the newly created ****"Substitute Products"**** group in the central column.
5. ****Save the Attribute Set:**** Click the ****Save**** button at the top right of the page.
6. ****Clear Caches:**** After saving, it is always a good practice to clear your Magento caches by running `php bin/magento cache:flush`.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-10/image.png)
Once you have completed these steps, return to the product edit page. The "Substitute Products" interface will now function as expected, allowing you to add multiple SKUs and save your changes correctly.
****Note:-**** If you are not seeing the substitute product option under products or are not able to add more than one substitute products or save the SKUs that you enter then this step must be followed.
### Assigning Substitute Products
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.
#### Add Substitute Products
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: -
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t142849-136.png)
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.
#### Order Placed With Subsitute Products
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t142946-668.jpg)
### Front-End View
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t143022-256.jpg)
If you have a question related to this extension please check out our [****FAQ Section****](https://www.scommerce-mage.com/magento2-substitute-products.html#customfaq) first. If you can't find the answer you are looking for then please contact [****support@scommerce-mage.com****](mailto:core@scommerce-mage.com)****.****
# Magento 2 Product Reviews
### Installation and User Guide for Magento 2 Product Reviews
**Table of Contents**
1. [*Installation* ](#bkmrk-installation)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Product Reviews*](#bkmrk-configuration-settin)
- *General Settings*
3. *[Creating New Review Sliders](#bkmrk-creating-new-review-)*
4. [*Adding Review Slider*](#bkmrk-adding-review-slider)
- *Category Page*
- *CMS Pages*
5. [*Front-End View*](#bkmrk-front-end-view)
- *Email Field in Review Form*
- *Reviews on CMS Pages*
- *Reviews on Category Pages*
### Installation [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory. ```php
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Substitute Products [](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration >Substitute Products**
#### General Settings [](#bkmrk--18)
- **Enabled -** Select "Yes" or "No" to enable or disable the module.
- \*\*License Key –\*\*Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. If you require license keys for dev/staging sites then please email us at .
- \*\*Email Field Enabled -\*\*Set "Yes" to enable the email field in the product review form and set "No" to disable the email field.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144254-431.png)
### Creating New Review Sliders [](#bkmrk--8)
- Go to 'Marketing'->'Product Review Slider'
- Click on 'Add New Slider'
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144331-991.png)
- In 'slider information' fill the title then go to 'product reviews'. and you will be able to see approved reviews.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144417-543.png)
- Select as many reviews as you want and click on 'Save Slider' or 'Save and Continue Edit'
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144500-170.png)
- You can add this review slider to any category page, CMS page and CMS block
### Adding Review Sliders [](#bkmrk--8)
#### Category Page [](#bkmrk--18)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144528-916.png)
#### CMS Pages [](#bkmrk--18)
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.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144559-458.png)
- Click on Insert Widget. Select the Widget type and widget option.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144628-530.png)
- Save and clear the caches.
***Note:-** Similary you add product reviews slider in Blocks using widgets.*
### Front-End View
#### Email Field in Review Form [](#bkmrk--18)
Once Email field is enabled from the configuration this field is visible in the Product review form:
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144716-768.png)
#### Reviews on CMS Pages [](#bkmrk--18)
We had assigned product reviews slider to the What's New Page the review slider can be seen on the product page.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t144749-433.png)
#### Reviews on Category Pages [](#bkmrk--18)
Go to the frontend to that category and reviews will be seen at the bottom of the page.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-06/image-2025-06-11t145130-370.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-product-reviews.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**
# Magento 2 Advanced Store Locator
### Installation and User Guide for Magento 2 Advanced Store Locator
**Table of Contents**
1. [*Installation* ](https://docs.scommerce-mage.com/magento-2-advanced-store-locator.md#bookmark0)
- *Installation via app/code*
- *Installation via Composer*
2. [*Configuration Settings for Advanced Store Locator*](https://docs.scommerce-mage.com/magento-2-advanced-store-locator.md#bookmark3)
- *General Settings*
3. [*Store Locator Region Management (Admin)*](https://docs.scommerce-mage.com/magento-2-advanced-store-locator.md#bookmark6)
- *Accessing Region Management*
- *Creating a New Region*
- *Editing Existing Regions*
- *Deleting a Region*
4. [*Store Management & Region Association (Admin)*](https://docs.scommerce-mage.com/magento-2-advanced-store-locator.md#id-2.-store-management-and-region-association-admin)
- *Accessing Store Management*
- *Creating a New Store*
- *Editing Existing Stores*
- *Deleting a Store*
5. [*Store List Display on Frontend (Customer)*](https://docs.scommerce-mage.com/magento-2-advanced-store-locator.md#id-3.-store-list-display-on-frontend-customer)
- *Viewing Stores Within a Selected Region*
- *Viewing All Stores (Without Region Selection)*
6. [*Store Detail View (Customer)*](https://docs.scommerce-mage.com/magento-2-advanced-store-locator.md#id-4.-store-detail-view-customer)
- *Accessing Store Detail View*
- *Understanding the Layout*
- *Detailed Store Information*
### Installation [](#bkmrk-)
- **Installation via app/code:** Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
```
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
```
- **Installation via Composer:** Please follow the guide provided in the below link to complete the installation via composer.
[https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer](https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer)
### Configuration Settings for Advanced Store Locator [](#bkmrk--1)
Go to **Admin > Stores > Configuration > Scommerce Configuration > Store Locator**
#### General Settings [](#bkmrk--2)
- **Enabled -** Select “Yes” or “No” to enable or disable the module.
- **License Key -** Please add the license for the extension which is provided in the order confirmation email. Please note license keys are site URL specific. Please go to *Admin > Stores > Configuration > Scommerce Configuration > Core* and click on "Verify" to verify the license key.
- **Items Per Page -** Add the number of items to be displayed per page
- **Enabled -** Enter the Google Maps API key to fetch the map for each store
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-236.png)
### Store Locator Region Management (Admin) [](#bkmrk--3)
This section outlines how administrators can create, edit, and delete regions to categorize your store locations effectively.
#### **1.1. Accessing Region Management**
To begin managing your store locator regions:
1. Navigate to **Admin > Stores >** **Scommerce Store Locator** in your Magento 2 Admin sidebar.
2. From the menu, select **Store Regions**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-237.png)
#### **1.2. Creating a New Region**
Follow these steps to add a new region to your store locator:
- On the Store Regions grid page, click the **Add New Region** button in the top-right corner.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-264.png)
- You will be redirected to the New Region page. Fill in the following details:
- **Active:** Toggle to activate or deactivate the region.
- **Region Name:** Enter a unique name for your region (e.g., "North America," "Europe," "Asia Pacific"). This field is **required**.
- **Description:** (Optional) Provide a brief description for the region. This can be used for internal reference.
- **Region Image:** (Optional) Upload an image to represent the region. This might be displayed on the frontend depending on your theme and future enhancements.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-239.png)
- Click **Save Region** to create the new region. A success message will appear, and you will be redirected back to the Region Management grid.
#### **1.3. Editing Existing Regions**
To view or modify details of an existing region:
- From the Region Management grid, locate the region you wish to edit.
- In the **Actions** column for that region, click **Edit.**
- Clicking **Edit** will open the region details page where you can modify any of the fields (Region Name, Description, Image).
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-266.png)
- After making any changes, click **Save Region** to apply your updates.
#### **1.4. Deleting a Region**
You can remove regions from your system, provided no stores are currently assigned to them:
- From the Region Management grid, locate the region you wish to delete.
- In the **Actions** column for that region, click **Delete**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-265.png)
- Alternatively you can also edit the region and then use the "Delete" button at the top.
- A confirmation pop-up will appear. Click **OK** to confirm the deletion.
- **Important:** A region can only be deleted if no stores are associated with it. If stores are assigned, you will need to reassign or delete those stores first.
- Once a region is successfully deleted, it will be removed from the grid and will no longer appear as an option for store categorization or on the front-end store locator navigation.
- You can also Mass delete regions using following steps:
- Select checkboxes next to messages.
- From the **Actions** dropdown, choose **"Delete"**.
- Confirm by clicking **"OK"** in the popup.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-267.png)
#### **1.5. Mass Action to Activate/Deactivate/Delete Regions**
Go to **Admin>Stores>Scommerce Store Locator>Store Regions** select the regions that you want to **Deactivate/Activate/Delete**. Next click on the mast action button and then select the action as shown below:-
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/7MAimage-267.png)
#### **1.6. Import Regions**
Go to Admin>System>Data Transfer>Import.
From the Entity Type dropdown select "Scommerce Store Locator Regions"
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-278.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-280.png)
select the import file and other settings as needed then
```
// Sample Import File
Name,Description, Image
Greater London,"The metropolitan area surrounding London, known for its diverse neighborhoods and vibrant commercial activity.", “greater-london.jpg“
West Midlands,"A central region in England known for its industrial heritage and growing retail hubs.", “west-midland.jpg“
North West,"Encompasses major cities like Manchester and Liverpool, with a mix of urban and suburban retail locations.", “north-west.jpg“
```
### **2. Store Management & Region Association (Admin)**
This section describes how administrators can create, manage, and associate individual store locations with the regions you've defined.
#### **2.1. Accessing Store Management**
To manage your store locations:
1. Navigate to **Admin > Stores >** **Scommerce Store Locator** in your Magento 2 Admin sidebar.
2. From the menu, select **Store Locations**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-243.png)
#### **2.2. Creating a New Store**
Follow these steps to add a new store location:
- On the Store Locations grid page, click the **Add New Store** button in the top-right corner.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-244.png)
- You will be redirected to the New Store page. Fill in the following details:
- **Active:** Toggle to activate or deactivate the region.
- **Store Title:** (Required) Enter the name of the store (e.g., "Main Street Branch").
- **Store Address:** (Required) Provide the full physical address of the store. This will be used for the Google Map display on the frontend.
- **Region Selection:** (Optional) Select an existing region from the dropdown menu to associate this store with. This dropdown will populate with regions created in the "Region Management" section.
- **Phone:** (Optional) Enter the store's contact number.
- **Email:** (Optional) Provide the store's email address.
- **Working Hours:** (Optional) Describe the store's operating hours (e.g., "Mon-Fri: 9 AM - 6 PM, Sat: 10 AM - 4 PM").
- **Days Open:** (Optional) List the days the store is open (e.g., "Monday - Saturday").
- **Description:** (Optional) Any other relevant information about the store (e.g., "Free Parking Available," "Wheelchair Accessible" , "Short Description").
- **Latitude:** Enter lattitude of the store location
- **Longitude:** Enter longitude of the store location
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-255.png)
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-256.png)
- Click **Save Store** to create the new store. A success message will appear, and you will be redirected back to the Store Management grid.
#### **2.3. Editing Existing Stores**
To modify details of an existing store, including its assigned region:
- From the Store Locations grid, locate the store you wish to edit. The grid displays **ID, Title, Address, Region, Phone, Email, Active, Created, and Actions**.
- In the **Actions** column for that store, click **Edit**
- Clicking **Edit** will open the store details page where you can modify any of the fields, including the **Region Selection**.
- Clicking **View** will open the store details page in a read-only mode.
- After making any changes, click **Save Store** to apply your updates.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-257.png)
#### **2.4. Deleting a Store**
To remove a store location from your system:
- From the Store Management grid, locate the store you wish to delete.
- In the **Actions** column for that store, click **Delete**.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-258.png)
- Alternatively you can also edit the store and then use the "Delete" button at the top.
- A confirmation pop-up will appear. Click **OK** to confirm the deletion.
- Once a store is successfully deleted, it will be removed from the grid and will no longer appear on the front-end Store Locator. Deleting a store only removes that specific store and does not affect other stores within the same region.
- You can also Mass delete regions using following steps:
- Select checkboxes next to messages.
- From the **Actions** dropdown, choose **"Delete"**.
- Confirm by clicking **"OK"** in the popup.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-259.png)
#### **2.5. Mass Action to Activate/Deactivate/Delete Store Locations**
Go to **Admin>Stores>Scommerce Store Locator>Store Locations** select the stores that you want to **Deactivate/Activate/Delete**. Next click on the mast action button and then select the action as shown below:-
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-281.png)
#### **2.6. Import Stores**
Go to Admin>System>Data Transfer>Import.
From the Entity Type dropdown select "Scommerce Store Locator Stores"
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-282.png)
select the import file and other settings as needed then
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-283.png)
```
// Sample Import File
Name,Address,Description,Region,Email,Phone,Working Hours,Longitude,Latitude,Days Open
London Central Store,"221B Baker Street, London NW1 6XE","Flagship store near Regent's Park",Greater London,central@storeuk.com,+44 20 7946 0011,"Mon–Sat: 9am–7pm",-0.1586,51.5237,"Monday–Saturday"
Croydon Outlet,"45 High Street, Croydon CR0 1QD","Discount outlet with parking",Greater London,croydon@storeuk.com,+44 20 8760 1122,"Mon–Fri: 10am–6pm",-0.1004,51.3762,"Monday–Friday"
Stratford Hub,"Westfield Stratford City, London E20","Modern store in shopping centre",Greater London,stratford@storeuk.com,+44 20 8221 3344,"Daily: 10am–8pm",-0.0064,51.5430,"All week"
Birmingham City Store,"12 New Street, Birmingham B2 4RQ","High-traffic location near Bullring",West Midlands,birmingham@storeuk.com,+44 121 633 4455,"Mon–Sat: 9am–6pm",-1.8998,52.4797,"Monday–Saturday"
Coventry Retail Point,"88 Broadgate, Coventry CV1 1NB","Family-friendly store with café",West Midlands,coventry@storeuk.com,+44 24 7655 9988,"Tue–Sun: 10am–5pm",-1.5105,52.4081,"Tuesday–Sunday"
Manchester Arndale,"18 Market Street, Manchester M4 3AT","Located in the heart of the city",North West,manchester@storeuk.com,+44 161 832 7788,"Daily: 9am–8pm",-2.2417,53.4839,"All week"
Liverpool One Branch,"Paradise Street, Liverpool L1 8JQ","Stylish store with seasonal offers",North West,liverpool@storeuk.com,+44 151 707 2233,"Mon–Sat: 10am–7pm",-2.9840,53.4045,"Monday–Saturday"
Preston Suburban Spot,"5 Fishergate, Preston PR1 2NJ","Quiet location with easy access",North West,preston@storeuk.com,+44 1772 555 900,"Wed–Sun: 11am–5pm",-2.7034,53.7590,"Wednesday–Sunday"
```
### **3. Store List Display on Frontend (Customer)**
This section describes how customers will interact with the Store Locator on your website's front-end.
#### **3.1. Viewing Stores Within a Selected Region**
Customers can easily find stores by filtering them by region:
1. Navigate to the Store Locator page on the front-end (typically via a link in the header or footer). **{root\_path}/storelocator**.
2. On the left-hand side of the page, a navigation panel displays a list of available regions.
3. Click on any **region name** from this list.
4. The main content area will refresh to display only the stores associated with the selected region.
5. Each store entry will show:
- A small **Google Map** snippet based on the store's address.
- The **Store Name**.
- The **Store Address**.
6. **Pagination:** If there are many stores within a selected region, they will be paginated. Stores are sorted alphabetically by default. You can navigate through the results using the "Next" and "Previous" controls.
7. **No Stores in Region Message:** If a selected region currently has no stores assigned, a message will be displayed: *“There are currently no stores available in this region. Please check back later or select another region from the list."*
*[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-285.png)*
#### **3.2. Viewing All Stores (Without Region Selection)**
The Store Locator also allows customers to view all stores without initially filtering by region:
1. Navigate to the Store Locator page (without selecting a specific region). This typically happens when a user clicks on a general "Stores" or "Store Locator" link.
2. **Layout Adaptation:**
- If **no stores** in the system have an associated region, the layout will automatically be **full width**, as there's no need for the left-hand region navigation.
- If **at least one store** is linked to a region, the available regions will still be displayed in the **left-hand navigation** panel, even when viewing all stores.
3. The main content area will display a list of all available stores.
4. Each store entry will show:
- A small **Google Map** snippet based on the store's address.
- The **Store Name**.
- The **Store Address**.
5. **Pagination:** Stores are paginated and sorted alphabetically. The pagination threshold can be configured by the admin in the module's backend settings. Users can navigate through paginated results using "Next" and "Previous" controls.
6. **No Stores Message:** If there are currently no stores in the system, a message will be displayed: *“There are currently no stores available. Please check back later."*
*[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-284.png)*
### **4. Store Detail View (Customer)**
This workflow describes how customers can access and view detailed information for a specific store.
#### **4.1. Accessing Store Detail View**
1. From any store list display (either filtered by region or showing all stores), click on the **name of a specific store** or an associated "View Details" link.
#### **4.2. Understanding the Layout**
- **Region List Visibility:** The presence of the region list on the left-hand navigation on the store detail page is determined by a **configuration setting in the admin panel**. Your administrator will decide whether this list is shown or hidden.
- **Layout Adaptation:**
- If **no stores** in the system have an associated region, the store detail page will automatically be **full width**.
- If **at least one store** is linked to a region, the available regions will be displayed in the **left-hand navigation** based on the aforementioned configuration.
#### **4.3. Detailed Store Information**
The store detail view provides comprehensive information about the selected store, including:
- **Large Google Map:** A larger, more prominent Google Map showing the precise location of the store based on its address.
- **Show Directions:** Clicking on this button takes you to the map (link) where people can view the directions to the store.
- **Store Name and Full Address:** Clearly displayed for easy identification.
- **Telephone Number:** For direct contact.
- **Email:** For direct email communication.
- **Days Open:** The specific days the store is open.
- **Working Hours:** Detailed operating hours.
- **Additional Store Details:** Any extra information provided by the admin.
- **Region:** (If applicable) The region to which the store is assigned, providing geographical context.
- **Back Button:** A button to go back to the list of stores page.
#### **4.4. Navigating Back**
To return to the store listing:
1. Click the **"Back to Stores" link or button**. This will navigate you back to the previous store listing page, whether it was filtered by region or showing all stores.
[](https://docs.scommerce-mage.com/uploads/images/gallery/2025-08/image-286.png)
If you have a question related to this extension please check out our [**FAQ Section**](https://www.scommerce-mage.com/magento-2-advanced-store-locator.html#customfaq) first. If you can't find the answer you are looking for then please contact [**support@scommerce-mage.com**](mailto:core@scommerce-mage.com)**.**