Display an advanced Google Map in your Magento front-end to help customers locate their nearest store. Export and import physical store addresses into your Google Places account.
Drive more offline sales showing all the places where you sell on a Store Locator for Magento 2
Display all your points of sale in the Google Map available from the store locator and create specific pages for each store.
Display all your stores on a Google map
Geolocation — Display the nearest store thanks to geolocation.
Get directions — Show directions to all your stores from any location.
Unit systems — Choose to display distance in miles or kilometers.
Enjoy easy and quick configuration
Google Map — Enable or disable the Google Map.
Store information — Display store details and additional information.
Images — Add images to your stores.
Opening hours — Configure opening and lunch hours for each day of the week.
Days off — Configure holidays and days off for each store.
Deeply customize each store
Custom attributes Create custom attributes for your stores and add the placeholders in your templates.
Display customization Edit the display of each store using variables and CSS code.
Create specific pages for each store
Create a unique page for each one of your offline stores and customize the content for each page as you want.
Use a cross-device tool
Fully responsive — The extension is designed to be responsive on all devices to o ffer an optimized mobile experience.
Multi-store and multi-website — You can define a specific configuration for each Magento store and website.
Export and import all your stores
Gain considerable time importing all your stores to Magento and easily download a CSV file that includes all information about the sources you've just created or imported.
MSI Stock Status
Provide more info about your stores in the stock status messages
Add any useful information concerning your stores in your stocks grid and stock status messages with MSI Stock Status: image, business hours, days off, link to the store page...
Are you interested in MSI Stock Status?
See More details
Check the demo
Click & Collect
Offer your customers the best of both world: Buy Online, Collect in Store
Allow your customers to collect their orders in any of your stores using Click & Collect.
Are you interested in Click & Collect ?
See More details
Check the demo
Content
How to use Store Locator for Magento 2
According to Google, a great part of retail sales are influenced by the web, but the majority is made in shops from local retailers to the big chains.
The Store Locator extension for Magento 2 will increase awareness of all your stores by allowing you to highlight them on a customized Google Map which is then placed on any page of your website.
This map uses HTML5 code which helps the customer by providing, on the same web page, their current position, and a route map to their nearest store.
Specific information relative to each store location can be easily customized from the Magento 2 back-office. For example, opening times, postal, and website addresses.
That extension enhances the Multi Stock Inventory module from Magento 2 and is fully integrated with the suite by providing additional features.
STEP 1: Manage your locations
First of all, you need to create your store locations by adding new sources. For this, go to: Stores › Inventory › Sources
Add New Source
With Store Locator, you can manage as many sources as you want from the backend of Magento 2.
To configure your sources, click on ADD NEW SOURCE.
So that a source can be created, it must have:
a name
a code
a store view
a customer group
longitude and latitude coordinates
a URL key
a country
a postcode
Other information is additional, however, we recommend you to fill in a maximum of fields to be able to reuse them in the Google Map display.
General
Name This is the name that appears on the front-office of your website in Google Maps. It can be a shop sign or help to localize the store.
USA Washington Store
Code (internal use) This is a unique identification code used in the back-office of Magento 2 for each store. This code is also used by Google Addresses to identify stores if data files are exported to a Google Places account.
Is enabled The Default Source must be enabled. A default source is required for single-source merchants and product migration.
Store View A source must be linked to at least one store view to be displayed for customers in Google Maps.
Customer Groups You must then select the customer group(s) that will be able to see the store.
Store Location
Latitude & Longitude This information is essential to allow the store to be displayed in Google Maps.
Find the coordinates with Google Map You can find this information with Google Maps directly by dragging the red cursor.
Store Locator settings
Is visible on Store Locator page YES/NO
Default order of display When customer doesn't allow geolocation, then the default order of display is used.
Image Browse/Drag the image for the store. This is the image associated with the store such as the shop front, the logo etc... The image appears in the information section when a customer selects this particular store. The image can be a .jpeg, .gif or .jpg file.
Use default description template The default description template is defined in: Stores › Configuration › Wyomind › Store Locator
Description You can also define a description for that particular store. The description appears in the information section when a customer selects this particular store. HTML and CSS codes are supported. See available variables
Variables available for the store descriptions:
{{code}} The store's code
{{name}} The store's name
{{phone}} The store's phone number
{{email}} The store's email address
{{address_1}}, {{address_2}}, {{city}}, {{state}}, {{country}}, {{zipcode}} The store's address
{{business_hours}} The store's opening hours
{{days_off}} The store's days off
{{image}} The store's image
{{link}} Link to the store's page
{{google_map}} The Google map with the targeted store Note that you can't use the Google map variable in the description template of the Store Locator.
You'll be able to access the store page from: https://www.yourstore.com/italy-store
Use default Page template The default page template is defined in: Stores › Configuration › Wyomind › Store Locator
Page Content You can also define a page template for that particular store. HTML and CSS code are supported. See available variables
Variables available for the page content:
{{code}} The store's code
{{name}} The store's name
{{phone}} The store's phone number
{{email}} The store's email address
{{address_1}}, {{address_2}}, {{city}}, {{state}}, {{country}}, {{zipcode}} The store's address
{{business_hours}} The store's opening hours
{{days_off}} The store's days off
{{image}} The store's image
{{link}} Link to the store's page
{{google_map}} The Google map with the targeted store Note that you can't use the Google map variable in the description template of the Store Locator.
Hours The opening hours can be shown for each store. You can set lunch hours as well.
Days off You can list all the days off. Each date must be on a new line formatted as follows:
YYYY-MM-DD
For example, if the store is closed on the 1st of January 2019, you can write:
2019-01-01
Note that you can also add hours off. Each date and hour must be on a new line formatted as follows:
yyyy-mm-dd HH:ii-HH:ii
For example, if the store is closed on the 24th of December 2020 from 4:30PM to 8:00PM, you can write:
2020-12-24 16:30-20:00
Contact Info
Contact name Name of the contact of the store.
Email It is the email to contact the store.
Phone Telephone number of the store.
Fax Fax number of the store.
Address Data
All the details specified in Address Data appear in the information section when a customer selects a particular store. You must fill in:
Country The country allows customers to filter the store search results.
State/Province The state code is essential if data files are exported to a Google Places account.
City
Street
Street (additional)
Postcode
Additional Data
For each store, you can define your own attributes in order to customize the store page as you want.
For this, go to: Stores › Inventory › Source Attributes
Click on ADD A NEW ATTRIBUTE.
This works the same way as product attributes.
The attribute can be:
text: simple input
textarea: multi-line input
wysiwyg: HTML input
Once saved, a notification displays, and the attribute is listed in the grid.
Once created, the attributes will be displayed in the Additional Data tab of each source.
Then, they can be used in the description template for the Store Locator and in the template for the store page.
Import and export a CSV file
Import
To import a CSV file, click on IMPORT A CSV FILE. You can then click on CHOOSE FILE to upload your file in Magento 2.
Your file must be a CSV file. Values must be separated by tabulations and enclosed by quotation marks.
Once you have chosen your file, click on IMPORT FILE.
A message is displayed and notifies that the sources have been imported in: Stores › Inventory › Sources
Export
To export a CSV file, it is quite easy, you need to click on EXPORT A CSV FILE, and you will be able to download a CSV file that includes all information about the sources you've just created or imported.
Configure the display of your sources
In order to edit the display of your sources in the Google map, go to: Stores › Settings › Configuration › Wyomind › Store Locator
Store Locator page URL It is the URL of the Store Locator page.
Store Locator page title It is the title of the Store Locator page.
Number of nearest locations to display Note that 0 means unlimited.
Display the distance from the customer location to the store in the store title You can add the distance to the store from the customer location.
Display the duration from the customer location to the store in the store title You can add the time it takes from the customer location to go to the store.
Unit systems for the distance Choose between Metric or Imperial.
Edit the store description template
You can change the display of your stores and even add some PHP code.
For example, let's say you want to display the phone number in red. You'll just need to add in the Store description template field:
Now the Store Locator map must be displayed on the CMS page you have chosen.
Customize the Store Locator map
The template which allows the Store Locator map to display is easy to modify with basic PHP and HTML skills.
The Store Locator template is found, by default, in: app/code/Wyomind/Storelocator/view/frontend/storelocator.phtml
All the CSS styles and associated images required to display the Store Locator map are in: app/code/Wyomind/Storelocator/view/frontend/web
To translate the words on the Store Locator map you can either use the on-line Magento translation tool or copy and translate the translation files available in: app/code/Wyomind/Storelocator/i18n/en_US.csv
FAQ
Pre-sales informations
Magento versions supported by Store Locator
This extension works with Magento Community Edition and also Magento Enterprise Edition. To know if Store Locator is compatible with your Magento version, please check the Compatibility tab.
Magento Open Source vs Magento Commerce vs Magento Commerce Cloud
Magento offers three variations of its product.
As their names have changed over the past few years, here is a recap:
Magento Open Source: previously Magento Community Edition (CE), is a free and non-hosted e-commerce platform.
Magento Commerce: previously Magento Enterprise (EE), is the paid version of Magento and offers support services.
Magento Commerce Cloud: is the paid version of Magento and offers support and hosting services.
Point Of Sale vs Store Locator
You can use Point Of Sale on any version of Magento 2.
However, if you are using the Magento MSI module available from Magento 2.3, you must use the Store Locator extension.
What Magento Multi Source Inventory is
Since version 2.3, Magento includes new and expanded features for Inventory Management. These new features help to manage product quantities, source locations, configurations, and shipments.
Among Inventory Management features, you will find:
Different configurations for single and multiple sources management
Stocks for tracking available aggregated quantities through assigned sources
Shipment matching algorithms: Magento provides 2 algorithms based on the source priority and the distance priority that recommends how to fulfill partial and full shipments.
Magento Inventory Management introduces new terminology:
Sources Represent physical sites where the available products are stocked and shipped from. It can be warehouses, stores, wholesalers...
Source Item It is a source for a given product.
Stocks One stock can be linked to several websites and sources.
Sales Channels Refers to a website. It can only be linked to one stock.
Salable Quantity It is the total virtual inventory that can be sold from a website.
Reservations It is the number of products reserved and deducted from the salable quantity when customers add products to cart and pass their order. When an order is shipped, the quantity of reservations is reset and deducted from the quantities of the inventories of the appropriate sources.
Points of sale limitation on the Google map
There are some limitations with the Google Shopping API that allows to calculate the directions. Only the 24 closest locations can be calculated but all the points of sale will be displayed anyway in your Magento 2 online store.
License and domains
License validity
A license is valid for an unlimited period of time on one single installation
If you're using more than one installation, you will have to buy a separate license for each instance.
if you're running several domains on a same installation, you will need only one license for all of them.
Although your license doesn’t have a limited period of validity, your Support & Upgrade period does. By purchasing a module, you’ll be granted a 12-month support period for free. Passed this period, you will have to pay for a new one (see FAQ: Extend your Support period)
Domains pre-registration
You can pre-register your live domain to your license in advance.
Thanks to this option, you'll be able to get the module ready to use on your domain before it goes live.
To pre-register your production domain:
Go to: mY account › Licenses & DOwnloads
Click on the Settings icon next to the module you want your domain to pre-register on.
Click on the link at the bottom of the page saying: Do you want to pre-register your domain in order to be ready to go live?
Finally, enter your domain name and click on pre-register now .
Testing environments
One license is valid for an unlimited period of time on one installation only. However, it is possible to extend or transfer your license in 2 cases:
If you would like to add your testing environments to your license. In that case, it is possible to extend your license to an unlimited number of domains for free. For mywebsite-staging.com or mywebsite-dev.com
If you want to transfer your license to another live domain. In that case, the Support & Upgrade period for your license must still be active.
To be able to use Store Locator on both your production and testing environments, follow the instructions below:
Install Store Locator on your environment. (see FAQ: Modules installation in Magento or in WooCommerce)
Activate the license. (see FAQ: Licenses activation in Magento or in WooCommerce)
Also, if you are managing a large amount of domains, please contact us so that we can automatically whitelist these domains.
Modules versioning and download
Extensions download
In order to download Store Locator, log into your Wyomind account:
Go to: my account › Licenses & downloads
Click on the settings icon next to Store Locator.
A new window opens.
Click on the download icon.
Only the latest extension version released within your Support & Upgrade period is available. In order to get the very latest extension version make sure your Support & Upgrade plan is up to date.
Modules upgrade
When purchasing a module from wyomind.com, you benefit from 12 months of upgrade. Within this period you can at any time download the latest version of the module directly from your account.
To upgrade Store Locator, follow the steps below:
Go to: my account › Licenses & Downloads
Click on the settings icon next to Store Locator.
Click on the download icon.
Install the new version of Store Locator in your Magento admin or your WooCommerce back-office.
Modules Installation/Uninstallation
Extensions manual installation
You can install Store Locator manually.
Download Store Locator (zip file) on: mY ACCOUNT › Licenses & Downloads Refer to the FAQ: Extensions download
Once Store Locator is downloaded, open the folder and unzip it.
Copy the content of the unzipped folder and paste all files and directories in your Magento 2 root directory.
In your Command Line Interface, execute:
bin/magento setup:upgrade
If you are using a production mode, execute also:
bin/magento setup:static-content:deploy
bin/magento setup:di:compile
Extensions installation via Composer
You can install Store Locator using Composer software in two cases:
if you purchased Store Locator on Magento Marketplace.
if you purchased Store Locator on Wyomind.com AND requested access to our repository: repo.wyomind.com
Add to your composer configuration our repository:
Extensions activation from the back-office of Magento
Once Store Locator is installed, you have to activate the license. For previous versions, you can activate the license from your back-office:
Go to your Magento admin panel. A message pops up at the top of the page.
If the message doesn't appear then you must check that:
1. The Adminhtml_Notifications and Wyomind_Core modules are well enabled. 2. The HTML output of the Adminhtml_Notifications and Wyomind_Core modules are not disabled in: storesconfigurationadvanced advanced 3. The encryption key well exists in app/etc/env.php:
Copy your activation key in: Stores › Configuration › Wyomind › Your extension
You can find your activation key in 2 different places: - In the confirmation email that you received after purchasing Store Locator. - In your Wyomind account: My account › Licenses & downloads Select Store Locator and click on .
A new page opens where you'll find your activation key (see below).
In your Magento admin go to: Stores › Configuration › Wyomind › Your extension
Paste the activation key in the Activation Key field and choose between the automatic (yes) or the manual (no) activation method: - By choosing Yes, the connection to Wyomind license server will be automatic. - By choosing No, you will have to log on to Wyomind license server yourself.
Click on Save config .
A message appears at the top of your admin panel. Click on that link: Activate it now!
Copy and paste the license code in theLicense code field from your admin or simply click on Activate now!
Finally, refresh your cache, log out and log in back straight after, to complete the installation.
Add another domain to your license
To activate the license on another domain (test, staging...):
Once the extension is installed on the new domain, copy your activation key in: Stores › Configuration › Wyomind › Your extension
After having saved the configuration, a notification appears. Click on Add this domain to my license.
A transfer request will then be sent to our team within an hour. Once the request is taken care of, you will receive a confirmation email. If your transfer request is accepted, you can use Store Locator on both environments at the same time.
Note that the order in which you activate your license on your domains does not matter. You can start with your staging/dev/local environment or with your live domain, the process will be the same.
Also, if you have loads of staging domains, or if you are an agency managing load of domains for your customers, please contact us so that we can automatically whitelist these domains.
Extensions activation from the CLI
Once Store Locator is installed, you have to activate the license.
For this, you can use the below command line (change the Activation key with the corresponding value):
You will first need to create a new project with a name, an organization and a location.
To that project you will have to link some API's by clicking on Enable APIs and services .
From the library you will be able to add the services you want.
In order to use Store Locator, you will need to enable the below APIs by clicking on Enable :
- Maps JavaScript API
- Geocoding API
- Distance Matrix API
- Directions API
When enabled, you'll be able to see the traffic, errors and latency for each API.
You should see all the enabled APIs from the APIs section.
From APIs & Services › Credentials, you will be able to create credentials. Click on Create credentials and then choose API key.
You'll also have the possibility to restrict your API key by websites, applications, IP addresses...
Once restricted or not, the API key will be listed among the credentials.
The final step for this to work is to link your account to a billing account from the Billing section.
User's reviews
R
RayRay
Ecommerce Agency · United States · User for 6 years
★★★★★
Store locator better than advertised! Great tool for our ecom site and amazing support
we bought the store locator tool for our client. The took worked amazing and the support team got back to us quickly with installing and questions about setup. strongly recommend. What we loved most is the featuers and how well it works on mobile. Given that mobile is the future, we look forward to using more extensions from here for future projects. I strongly recommend them!
B
Brian
Marketing Agency · Canada · User for 6 years
★★★★★
Great Extension and Support
We've looked around for a Magento Cloud extension that actually works and we found it here at Wyomind. The support is also fantastic as well. I'm already looking through their list of extensions to find if there is anything else we can use on our site.
D
Dhcaster
Ecommerce Agency · United States · User for 6 years
★★★★★
Great Extension - Great Service
Great extension, but even better support. The team at wyomind has gone out of their way with helping us get this extension work exactly like we would like it to and they are very easy to work with. Keep up the great work!
Magento 2 Compatibility
Supported by our master extension versions
2.4.8
2.4.7
2.4.6
2.4.5
2.4.4
2.4.3
2.4.2
2.4.1
2.4
2.3.7
2.3.6
2.3.5
2.3.4
2.3.3
2.3.2
2.3.1
2.3
Changelog
5.3.1
Compatibility
PHP 8.4 and 8.5 compatibility.
Magento 2.3 compatibility of the store locator and store pages.
Bug fix
Translations containing an apostrophe no longer break the store locator script.
Improvement
Magento 2 coding standard compliance (escaped output in templates).
5.3.0
Improvement
Added the db_schema_whitelist.json file (declarative schema)
5.2.0
Improvement
Added the db_schema_whitelist.json file (declarative schema)
5.1.0
5.0.5
5.0.4
Compatibility
php 8.1 compatibility for MSI sources back-office saving
5.0.3
Bug fix
Fix property initialization in a constructor class
5.0.2
Bug fix
Fix property initialization in a constructor class
5.0.1
Bug fix
Fix property initialization in a constructor class
5.0.0
Initial release for the master version
4.0.4 legacy
Compatibility
php 8.1 compatibility for MSI sources back-office saving
4.0.3 legacy
Bug fix
Fix property initialization in a constructor class
4.0.2 legacy
Bug fix
Fix property initialization in a constructor class
4.0.1 legacy
Bug fix
Fix property initialization in a constructor class
4.0.0 legacy
Initial release for the legacy version
3.1.0
Bug fix
Source details pages and store locator pages were still visible even if the sources were disabled or the enable/disable configuration option was disabled in the main extension's configuration page.
3.0.0
Compatibility
Compatibility with Magento v2.4.6 + PHP v8.2
2.7.5
Code improvement
Jquery syntax updated with $(...).val("....") instead of $(...);attr("value",'"...")
2.7.4
Bug fix
Ability to configure the extension at the storeview scope level.
2.7.3
Improvement
Plugin Wyomind_StoreLocator_Plugin_ApiSourceRepository_InterfaceSave has been moved to the adminhtml area
2.7.2
Bug fix
Fix the display of the HTML content from Page Builder
2.7.1
Improvement
Better compatibility with Magento Enterprise Edition
2.6.12
HTML code rendering supported in the page builder for the configuration of a source description
2.6.11
Fix for editing blocks in the page builder for the backend source form
2.6.10
Minor fix on code
2.6.9
Compatibility
Compatibility with PHP 8.1
2.6.8
Fix for compatibility with PHP 8.1
2.6.7
Addition of source custom attributes in the source export file
2.6.6
Fix for a bug in the display of the store locator
2.6.5
Application of the store view/customer group filters on the recovery of sources by MSI Stock Status
2.6.4
Minor fix
2.6.3
Fix for redirecting to the store pages if there is no corresponding source
2.6.2
Fix for a check on a variable
2.6.1
Improvement
Redirection to the store locator page for the source pages in the frontend when the source does not have a store view selected in its configuration