Magento 2 Advanced Store Locator
Installation and User Guide for Magento 2 Advanced Store Locator
Table of Contents
Installation via app/code
Installation via Composer
Configuration Settings for Advanced Store Locator
General Settings
Store Locator Region Management (Admin)
Accessing Region Management
Creating a New Region
Editing Existing Regions
Deleting a Region
Store Management & Region Association (Admin)
Accessing Store Management
Creating a New Store
Editing Existing Stores
Deleting a Store
Store List Display on Frontend (Customer)
Viewing Stores Within a Selected Region
Viewing All Stores (Without Region Selection)
Accessing Store Detail View
Understanding the Layout
Detailed Store Information
Installation
Installation via app/code: Upload the content of the module to your root folder. This will not overwrite the existing Magento folder or files, only the new contents will be added. After the successful upload of the package, run below commands on Magento 2 root directory.
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deployInstallation via Composer: Please follow the guide provided in the below link to complete the installation via composer.
Configuration Settings for Advanced Store Locator
Go to Admin > Stores > Configuration > Scommerce Configuration > Store Locator
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. 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
Store Locator Region Management (Admin)
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:
Navigate to Admin > Stores > Scommerce Store Locator in your Magento 2 Admin sidebar.
From the menu, select Store Regions.
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.
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.
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).
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.
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.
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:
Navigate to Admin > Stores > Scommerce Store Locator in your Magento 2 Admin sidebar.
From the menu, select Store Locations.
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.
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").
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.
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.
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.
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:
Navigate to the Store Locator page on the front-end (typically via a link in the header or footer). {root_path}/storelocator.
On the left-hand side of the page, a navigation panel displays a list of available regions.
Click on any region name from this list.
The main content area will refresh to display only the stores associated with the selected region.
Each store entry will show:
A small Google Map snippet based on the store's address.
The Store Name.
The Store Address.
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.
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."
3.2. Viewing All Stores (Without Region Selection)
The Store Locator also allows customers to view all stores without initially filtering by region:
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.
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.
The main content area will display a list of all available stores.
Each store entry will show:
A small Google Map snippet based on the store's address.
The Store Name.
The Store Address.
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.
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."
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
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.
Store Name and Full Address: Clearly displayed for easy identification.
Telephone Number: For direct contact.
Email: For direct email communication.
Open and Close Times: Detailed operating hours.
Days Open: The specific days the store is open.
Additional Store Details: Any extra information provided by the admin.
Region: (If applicable) The region to which the store is assigned, providing geographical context.
4.4. Navigating Back
To return to the store listing:
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.
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 [email protected].
Last updated
Was this helpful?