Magento 2 Dealer Locator Quick Start Guide
Looking for Dealer Locator? View the full Dealer Locator page to explore features, configuration options, and pricing.
This is the quick start guide for the Dealer Locator. In about five minutes you'll have a working "Find a dealer" page: we switch the module on, pick a map provider, add your first dealers and check the page on your storefront. We use OpenStreetMap here because it works without an API key, so you can see results straight away; switching to Google Maps later is a matter of two keys. If you just installed the module and want to see it working before fine-tuning anything, start here. Everything you set up in these steps can be changed later without losing your dealers.
Get the Dealer Locator running in 5 minutes.
Prerequisites
- Module installed
- Cache cleared
- A few dealer addresses at hand (or the sample file from the import page)
Step 1: Enable the Module
Navigate to: Stores → Configuration → Magmodules → Dealer Locator → General
Configure:
- Enabled: Yes
Step 2: Choose a Map Provider
Navigate to: Stores → Configuration → Magmodules → Dealer Locator → Map & Geocoding
Configure:
- Map Provider: OpenStreetMap (free, no API key)
That's all you need for now. Prefer Google Maps? Choose it here and fill in the Google Maps Browser API Key and the Google Geocoding Server API Key; the configuration guide explains which restrictions each key needs.
Save the configuration.
Step 3: Add Your Dealers
Navigate to: Content → Dealer Locator → Dealers
The quickest way to see results is the sample file:
- Click Download Sample CSV. It contains four fictional dealers at real public addresses in the Netherlands, Belgium and Germany.
- Click Import CSV, choose the file and click Import. Leave the options as they are.
- The report shows "Created: 4". The module looked up the map coordinates from the addresses and created the product categories from the file. One sample dealer is inactive, so the storefront shows three.
Or add a dealer by hand with Add New Dealer: fill in a code, name, address and country, and leave latitude and longitude empty. After saving, the message shows the coordinates that were found.
Step 4: Check the Page
Open your store at /dealers, for example https://example.com/dealers.
You should see:
- The dealers in a list, with a map next to it (on mobile: List and Map tabs)
- Search for "Utrecht": the list is now sorted by distance, nearest first
- Click Show on map at a dealer: the map zooms to it and opens its details
Tip: Want the page on another address, such as /stores or /service/dealers? Change the URL Key under Page & SEO.
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team
For a complete overview of features and configuration options, see Dealer Locator.