Installation



Before installing the extension, please make sure to Backup your web directory and store database


You will require to install MageDelight Base Extension first. If it is not installed then please download it from https://www.magedelight.com/pub/extensions/magedelight-base.zip and unzip the package file into the root folder of your Magento 2 installation.

Root Directory is - "app/code/magedelight/#YourExtensionName#"

  • Unzip the extension package file into the root folder of your Magento 2 installation.
  • Connect to SSH console of your server:
    • Navigate to the root folder of your Magento 2 setup

    • Run command as per below sequence,

      php bin/magento setup:upgrade

      php bin/magento setup:di:compile

      php bin/magento setup:static-content:deploy

      php bin/magento cache:clean

  • log out from the backend and log in again


If you are using Magento 2.3 or later then you do not need to activate license. Extension will be activated with silent activation mechanism and does not require activation keys to be entered manually.   


Backend Configuration (Admin side)

  • Enable Store locator: Enable/Disable the store Locator extension
  • Menu Link Title: Store locator page link title
  • Display Menu Link: To show store locator link on Top Link or Top Navigation menu
  • Access to Guest Customer: Set access limit to allows store locator to guest customer or not
  • Default Store Image: You can upload default image to be shown, if particular store don’t have uploaded store image
  • Show Stores on Product Page: Select "Yes" to to display list of stores on product details page.

  • Google Map API Key: Defined Google map API key.

  • Map Marker Image: To upload Google map marker image if needs to show specific image. Else default Google map marker image would be used.

  • Map Style: Select Google Map Style/Theme to display map on store front.

  • Default Radius for Search: To define default radius of distance to be cover while searching store on Google Map.

  • Maximum Radius for Search: Set maximum radius limit user can search store from his current location

  • Distance Unit: Distance unit while search on Google map. Options can be Kilometers or Miles.

  • Page Title: Define Store locator page title

  • Page URL: Define Store locator page URL

  • Page URL suffix: Store locator page URL suffix
  • Meta Description: To define Meta description for store locator page

  • Meta data: To define Meta data for store locator page

  • Export: Click on "Export CSV" button to export existing stores data to CSV file. You can use same file to import store.
  • Import: Upload CSV file to import stores from CSV file. You can get sample CSV file by exporting CSV file.

Backend Functionality

Store Management



  • Status: To Enable/Disable the store
  • Store Name: Define store name
  • Store Email: Specify store email
  • Store View: Select store view, you can select multiple store views for same store.
  • URL Key: Define SEO friendly URL key for store details page. If not defined, it would be auto generated from store name


  • Website URL: Store website URL if have any
  • Facebook URL: Facebook page to show link on store details page
  • Twitter URL: Twitter URL to show link on store details page
  • Store Description: Describe store details to be shown on store detail page


  • Address: Define store address details with city, state, country, zip code. Based on given address, store will be located on Google map
  • Telephone: You can add multiple phone number for store
  • Longitude & latitude: Its value will be automatically set based on the store locate on Google map. However you can edit if needed
  • Store Image: upload store image/icon


  • Upload images for store galerry. You can upload multiple images at same time.


  • Select products available at store. You can select multiple products.


  • Meta data: You can define Meta title, Meta keywords and Meta description for SEO purpose for each store detail page at frontend.


  • Time Schedule: Here you can define the stores working days and working time of the store. You can define working time for each week day or even set close time too. As shown with below image


  • Select tags and its value to be displayed on store front.

Holiday Management

  • Manage Holiday: You can manage holidays for each individual store or all stores. You can create holiday for one day or vacation period for multiple days. Refer below image,


  • Status: Enable/Disabled holiday.
  • Holiday Name: Define as per your need.
  • Store: All Stores/Selected stores. You can have holiday for all store or select multiple stores.
  • From Date: Select holiday start date.
  • To Date: Select holiday end date.
  • Repeat Yearly: If you check this check box, particular holiday will repeat every year on same date. For example you can define 1st Jan New Year holiday, and mark this day to repeat every year.

Tag Management

  • Grid to manage all tags with filter options.


  • Tag Label: Provide label for the tag.
  • Input Type for Tag: Select input tue for the tag, it can be dropdown, multiselect or text.
  • Tag Code: Provide code for tag to identify it.
  • Required: Select "Yes" to make this tag value mandetory.


  • Provide values for the tag.


  • Provide tag label for stores.

Frontend Functionality

Once you configured the extension and create stores, the store will be listed on store locator page. The store locator link will be displayed on top links or with top menu, based on how it configured. Store locator page will be look like,

Search Store

You can search nearest store with store search feature, user can use radius from to find nearest store from his current location. As shown with below location. You can search store using tags, too.

It also helps to find direction from your current location or from particular location to particular store. Refer below image,

That also supports street view of store, as show with below image

Street view

Store page

Store page will contain details of particular store with store description, address. You can also have the direction finder supported by map. It also includes working days, time details and upcoming holiday list


Developer Account

The three API's you have to enable in Google API Key for the correct work of the extension,

  1. Maps JavaScript API
  2. Places API
  3. Direction API

To configure these settings, please follow the link, https://console.cloud.google.com/apis/library/places-backend.googleapis.com

API


Please use SWAGGER to get detailed information of parameters.

https://storelocator.m2.demo.magedelight.com/swagger

rest/V1/magedelight-storelocator/

Get store locator view: storelocator/search


Sample Data

{
searchCriteria[filter_groups][0][filters][0][field]:storename
searchCriteria[filter_groups][0][filters][0][value]:"Bob Store"
}


Get store locator view by id: storelocator/:storelocatorId

Sample Data

{
storelocatorId:1
}


Save store locator: storelocator

Sample Data

{
"storelocator":{
"storelocator_id":"10",
"storename":"Roni's Store",
"url_key":"roni-store",
"storeemail":"roni@gmail.com",
"address":"Via Goffredo Mameli 34",
"city":"Roma",
"region":"Roma",
"region_id":767,
"country_id":"IT",
"zipcode":16345,
"longitude":12.467860,
"latitude":41.887540,
"telephone":3387819740
}
}


Delete store locator: storelocator/:storelocatorId

Sample Data

{
storelocatorId:2
}

Demo

Click here to visit frontend.

Click here to visit backend admin panel.

FAQs

Click here to visit FAQs.

Support

Click here to raise a support ticket using your MageDelight account.

Additional Services

Click here to get the customized solution for this extension.


Thank you for choosing MageDelight!


  • No labels
© 2024 MageDelight. All Rights Reserved. MageDelight.com is an initiative by Krish TechnoLabs.