• Installing Store Locator
• Uninstalling Store Locator
• Compatibility
  
• Adding the Store Location
• Adjusting Store Locator Settings
• General Settings
• Importing Locations via CSV 

Magento 2 Store Locator is a straightforward solution enabling purchasers to find nearby physical locations of a web store by concrete address or current location distance. From the frontend area, store admins can quickly create new locations of their outlets and add the appropriate markers to Google Maps on individual store views. Additionally, they can set the map zoom, latitude, and longitude values of each created location. 

Installing Store Locator

Command Line Installation

1. Backup your web directory and store database
2. Download the Store Locator installation package
3. Upload contents of the Store Locator installation package to your store root directory
4. In SSH console of your server navigate to your store root folder:

cd path_to_the_store_root_folder

run the following command:

php bin/magento module:enable Aheadworks_StoreLocator

then:

php bin/magento setup:upgrade

after:

php bin/magento setup:static-content:deploy -f

     5. Flush store cache; log out from the backend and log in again

Composer Installation

If you are installing an extension from Aheadworks for the first time, you need to add our composer repository to your Magento store:

     1. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

Run the following command:

composer config repositories.aheadworks composerhttps://dist.aheadworks.com/

On successful execution of the command you will be able to use the composer to install the extensions.

To install the extension:

     2. Login to your ssh console and navigate to your store folder:

cd path_to_the_store_root_folder

     3. Run the following command to install the latest version of the extension:

composer require aheadworks/module-store-locator

if you need to install a specific version, run this command:

composer require aheadworks/module-store-locator:<version>

When prompted, enter Public Key (Username) and Private Key (Password):

Both Public Key (Username) and Private Key (Password) can be found in My Projects and Licenses in your personal account on our site:

     4. Enable the extension:

php -f bin/magento module:enable <Module_Name>

Next, register the extension:

bin/magento setup:upgrade

Recompile your Magento store if you are in the Production mode:

bin/magento setup:di:compile

To verify that the extension is enabled, run this command:

bin/magento module:status

Clean store cache, by running the following command:

bin/magento cache:clean

Log out and Log in the backend again.

To upgrade the extension:

     5. To update or upgrade an extension:

Download the updated extension file. Take note of the module-name and version. Export the contents to your Magento root.

If a composer package exists for the extension, run one of the following.

Update per module name:

composer update aheadworks/module-store-locator

Updater per version:

composer require aheadworks/module-store-locator:<version>

Run the following commands to upgrade, deploy, and clean the cache.

php bin/magento setup:upgrade --keep-generated
php bin/magento setup:static-content:deploy
php bin/magento cache:clean

Installing Hyvä Theme Compatibility Module

The Hyvä Compatibility Module is available only via the Aheadworks Composer repository.

Installing Hyvä-compatibility module

To install Hyvä Compatibility Module via Aheadworks Composer, run the following command:

composer require aheadworks/module-store-locator-hyva 

Uninstalling Store Locator

Since Magento introduced declarative Database you need to be very carefull when uninstalling or disabling the module.

Manual Removal

1) Run command: 

bin/magento module:uninstall --non-composer Aheadworks_StoreLocator

It will remove hide price attributes from the system (e.g. eav_entity_type table).

2) Disable extension: 

bin/magento module:disable Aheadworks_StoreLocator

3) Run setup upgrade: 

bin/magento setup:upgrade

It will remove module related tables from the system (hp_rule_entity, hp_rule_product, etc).

4) Remove module files manually: 

app/code/Aheadworks/StoreLocator

Automatic Removal (via Composer)

1) Disable extension:

bin/magento module:disable Aheadworks_StoreLocator

2) Run setup upgrade: 

bin/magento setup:upgrade

3)

php bin/magento module:uninstall Aheadworks_StoreLocator

Compatibility

The PHP version depends on your current Magento version. Please, refer to your Magento version release notes.

Introducing to Magento 2 Store Locator

Extension Overview

Store Locator is a must-have for anyone with brick and mortar shops populated into a single online store. The extension allows vendors to indicate the locations of their physical shops on an online Google Map. They can add as many spots as needed. Furthermore, vendors may supply the locations with some vital details like address, photo, description, unique name and other. Customers are able to browse the full list of locations, as well as to search for a store either by address or within the given distance.

The Store Locator extension for Magento 2 introduces its tab to the navigation menu of the store. Admins may later remove the tab with just a few clicks and make the location page accessible only via a direct link. The page can also feature a CMS block alongside the one for SEO-friendly meta information. 

Key Features

• Display your store location on an interactive map

• Use Google Maps as a default map

• Provide search by address and radius

• Mark each location with an image and a brief description

• Import locations

Adding the Store Location

Store Locator extension comes ready for work right after the installation.

The first thing you want to do is to add the location of your store to the map. To do this, navigate to Content → Store Locator by Aheadworks:

This screen is a management center of all your store locations. Whether you want to add a new location, edit a previously created one, or find a particular location by any attribute, - this is the place you are looking for.

To add new store location click the Add New Location button at the top right-hand corner of the screen.

General

The General Information section allows you to configure essential details for a store branch, including its display status, title, full physical address, and contact information. You can also assign the location to specific store views, set its display order, add a custom description, and upload visual assets like a store logo, photo, and map marker icon.

Google Maps Settings

The Google Maps Settings section allows you to configure map controls and pinpoint the exact geographic location of your store branch:

• Zoom – Specify the default map zoom level when displaying this location.

• Latitude & Longitude – Enter the precise geographical coordinates manually, or click Find Store on Map to automatically calculate them using the store address configured in General Information.

• Interactive Map Preview – Pan and view the generated pin position directly within the admin panel to ensure accurate location placement on the frontend map interface.

Opening Hours

The Opening Hours section allows you to define standard working hours and set up custom schedules for holidays or special events:

• Regular Hours – Configure operating hours for each day of the week by specifying Open Time and Close Time, or select the Closed or 24 Hours checkboxes for non-standard schedules.

• Special / Holiday Hours – Click Add Special Hours to set specific dates (e.g., holidays) with custom operating hours or mark the store as Closed.

Search Engine Optimization

The Search Engine Optimization section enables you to manage metadata and structured data for better search engine indexing and local SEO visibility:

• Meta Title – Specify the title tag for the store page (maximum 60 characters recommended).

• Meta Description – Enter a brief summary of the store location for search engine results (maximum 160 characters recommended).

• Meta Keywords – Add relevant comma-separated keywords to aid indexation.

• Meta Robots – Choose indexing instructions (e.g., INDEX, FOLLOW) for search engine crawlers.

• Schema.org Business Type – Select the precise structured data category (such as LocalBusiness, Store, or ClothingStore) to help search engines display rich snippet information for this store location.

Features & Services

The Features & Services section allows you to assign specific amenities and available services (e.g., In-store Pickup, Wheelchair Accessible, Fitting Rooms) to the store location.

If no options are available, create and manage the global list of features navigating to Stores > Configuration > Aheadworks Extensions > Store Locator > Features & Services.

Location Page Content

The Location Page Content section provides a WYSIWYG editor to create custom landing page content for the store location:

• Content: Enter formatted text, images, widgets, or custom HTML to display additional information on the dedicated store location page (e.g., parking instructions, directions, or current promotions).

• Show / Hide Editor: Toggle the WYSIWYG editor to switch between rich text editing and raw HTML code.

Adjusting Store Locator Settings

You have added the location of a store and definitely want to look through it. It is now high time to proceed to the Store Locator settings screen to learn how to do it.

Stores → Configuration → aheadworks extensions → Store Locator

General Settings

The extension is enabled by default after the installation, however, the Extension's URL to Top Menu option that brings the Store Locator section to the frontend navigation menu is disabled.

Let's go through the settings available and what they do:

• Enable Store Locator Page - allows enabling/disabling the extension and the Store Locator frontend page in particular;

• Address format - specify any order in which the address fields appear;

• Title - defines the Store Locator page title;

• URL Key - defines the links the Store Locator page will be accessible by;

• Google Maps API Key -  this API key is required to use the Google Maps API, even within Google's free usage limits. This setting is most relevant for stores with high traffic (25K+ map loads per day), but all stores must enter a valid API key to enable map features;

• API Version - choose the Google Maps API version to use:

• Extension's URL to Top Menu - allows adding the Store Locator page link to the top category menu at the frontend;

• Header CMS Block - allows displaying any CMS block at the Store Locator page;

• Display 'Find My Location' Button - set to Yes to allow customers to auto-detect their current geolocation via browser permissions.

yourstore.com/store-locations

Once you have applied all the settings changes and decided on where at the Top Menu you want the Extension's URL displayed you may want to proceed to Search and SEO settings:

Stores → Configuration → aheadWorks extensions → Store Locator

Search and SEO settings

Search settings let you enhance customer's search experience:

• Search Radius - allows defining a set of search radii available for customers;

• Default Search Radius - defines the search radius set by default at the Store Locator page;

• Default Search Measurement - miles/kilometers.

SEO

• Meta Keywords: Enter target keywords for the main Store Locator page.

• Meta Description: Add a summary description of the Store Locator page for search engine results.

• Business Type: Choose a global Schema.org structured data type (e.g., LocalBusiness, Store, ClothingStore) to apply to locations by default.

Features & Services List: Click Add to create and manage the master list of available store amenities (e.g., In-store Pickup, Wheelchair Accessible). You can upload custom icons (jpg, jpeg, png, webp) and define feature names to be displayed on store pages.

Importing Locations via CSV 

In case if you want to add multiple store locations at once, you can take advantage of the provided import functionality. This functionality is integrated into the native Magento Data Import section located at System → Data Transfer → Import.

The Entity Type section contains the Aheadworks Store Locator - Locations option, which, if selected, enables an import configuration form with two configuration blocks, Import Behavior and File to Import.

System → Data Transfer → Import → Aheadworks Store Locator - Locations

Import Behavior

The Import Behavior set contains the following options:

• Import Behavior. The box contains two options: Add Locations and Delete Locations and Add Locations. If the first option is selected, the functionality adds new locations to existing ones. If the second option is chosen, the module will replace previous locations with the new ones;
• Stop on Error / Skip Error Entries. You can choose either to stop the import process each time an error is detected or skip errors and continue importing;
• Allowed Errors Count. Defines the number of errors to cease the import process;
• Field Separator. The symbol that separates fields;
• Multiple Value Separator. The symbol that separates multiple values;
• Fields Enclosure. Tick the button in case if you upload files containing spreadsheets.

File to Import

The File to Import configuration section contains the following options:

• Select File to Import. The option allows you to select a CSV file to be imported.

• Images File Directory. Using this option you can set a path to images in the imported file. For example, if the images are stored in the store_root/pub/media/import/aw folder, the path is going to be aw/image.png.

Product Page