Installation

After downloading the add-on, it is installed using standard CS-Cart tools, on the page Administrator Panel → Add-ons→ Downloaded add-ons→ Gear button → Manual installation (For CS-Cart version later than 4.18.1)

Click Download, in the window that appears, select the add-on file, then Download and install.

Preliminary steps

1. Go to https://sypexgeo.net and register.

   

2. After registration, you will receive 30,000 free requests that are updated monthly. If necessary, you can purchase additional requests. 3. In your personal account, you will receive an API key. Here you can also track the remaining requests and purchase additional ones.

⚠️ When purchasing additional requests, you must select the REST API item.

Setup

1. After installation, go to its settings. To do this, follow these steps: Administrator Panel → Add-ons→ Downloaded add-ons→ Geolocation from SypexGeo → Settings and activate the necessary parameters:

   

   • API Key:

     Enter the API key you received earlier in the field to activate the add-on.

   • Hide pop-up:

     Check the box to hide the pop-up window for confirming the selection of a specific city in the “MS: Customer location” block

2. To display the add-on's work on the storefront, go to Administrative Panel → Web-site → Themes → Layouts.

3. Select the required place on the site and add one of the following blocks:

   • MS: Customer location – displays the buyer's city, as well as a list for selection.
   • MS: City Info – displays additional text and a link to the selected city.

💡 The pop-up window can be disabled in the add-on settings.

Working with cities

The add-on supports working with both manually created cities and automatically created ones. It also integrates perfectly with the “Cities” add-on from CS-Cart, ensuring seamless interaction.

To set up cities manually:

1. Follow these steps: Administrator panel → Settings → Geolocation from SypexGeo. Cities.

2. On this page, you can add location information or create your own cities. It has the following settings:

   • City – displays the buyer’s city, created by you or automatically.

   • Additional text – explanation of the city. Here you can enter information about the availability of stores, delivery features or the absence of stores. You can use any html tags in this field.

   • Link – substitute another domain\subdomain for this city, for example https://admsterdam.site.com or https://site.com/amsterdam (it is important to add http:// or https://). The current request parameters will be saved.

   • Show additional text in the notification after selecting a city – when you select this city, a notification with the item “Additional text” will be displayed

   • Show additional text in a separate block – you can place a block with city information anywhere on the site. If the checkbox is selected, “Additional text” of this city will be displayed in the “MS: City Information” block.

   • Show city in the selection list – display the city in the city selection block. If the checkbox is selected, “City” will be displayed in the list of cities in the “MS: Customer location” block.

   • Delete - activate this checkbox if you want this city to be deleted when you click the Save button.

     

These settings are also present in the “Cities” table from CS-Cart.

3. After completing these settings, click the Save button for the changes to become active.

   

As a result, a pop-up window will appear with an automatically determined city, and the activated blocks will be displayed on the showcase