Support Center

Connecting to OpenCart




OpenCart is available as a shopping cart system at Shopgate.

By setting up Shopgate plugin in your OpenCart shop, you will get these wonderful features straight into your mobile shop and apps:


Supported Version Import to OpenCart

up to 2.2.0

Sync Export to Shopgate Mobile Shop

Delivery Status "Shipped"
Order Status "Canceled"
Stock Quantity, on Product Detail Page


Customer Account Validate, upon Cart Changes

Login with Desktop Shop Account
Login to Desktop Shop with Mobile Account
Customer Groups / Tier Pricing
Show Desktop Orders on Mobile


Shipping Method
Payment MethodNew feature!
Product Availability

Supported Payments Notes
Cash On Delivery, Klarna

New feature! The payment validation feature allows you to offer specific payment options to targeted carts and customers. The availability of this feature depends on your Magento settings. To enable this feature, please contact Shopgate Support.


In this article, you will find everything you need to set up the Shopgate plugin for your OpenCart shop. For extra instructions on JooCart integration, please read Connecting to JooCart.


Topics covered in this article:

  1. Installing the Shopgate Plugin
  2. Establishing connections
  3. Updating an existing Shopgate plugin
  4. Understanding the plugin configurations
  5. Frequently Asked Questions (FAQ)


1. Installing the Shopgate plugin

The Shopgate plugin for OpenCart can be installed in OpenCart version 1.3 and newer. To do this, please follow the steps here:

1.1 Putting your shop in Maintenance Mode

To prevent your shop from crashing while installing and updating the Shopgate plugin, please make sure to put your shop in Maintenance Mode beforehand.


 To do so, log into your OpenCart backend

  1. Navigate to System > Settings and click on Edit 

  2. When the Settings page opens, switch to the Server tab and set "Maintenance Mode" to Yes


1.2 Downloading the plugin

Download the latest plugin file "" via this link and unzip the content.


1.3 Uploading the plugin to OpenCart

For OpenCart version 2.0:

Please use the new Opencart Extension Installer to upload the Shopgate plugin.
Please make sure your FTP credentials are entered and enabled in your Settings.
  1. Login to your OpenCart Admin Backend.
  2. On the menu bar, select  >> Extension Installer.

  3. In the Extension Installer, click Upload and select the zip file you just downloaded. The Shopgate plugin will be uploaded automatically.

  4. Click Continue to finish uploading the plugin to your OpenCart backend.

  5. Your Shopgate plugin has been installed when you see this text.

For OpenCart version pre-2.0:

Please upload the Shopgate plugin via the FTP tool

JooCart users:

Please click instructions for JooCart to complete one more step before you proceed.


1.4 Activating the plugin in your OpenCart backend

1. Go to  >> Modules.


2. Find Shopgate in the List and click  Install.

3. Your Shopgate plugin is uploaded when a success text shows on top of the Modules page.

4. Now click  to open the Settings page.

5. Your Shopgate plugin settings page will look like this:

Leave this page open - we will explain how to find the required info in the next chapter.


1.5 Redirecting customers to mobile website



For OpenCart version 2.0:

  1. Navigate to System > Design > Layouts.

  2. In the Layout List, look for Home, Category, and Products.

  3. Click on  to edit layout Home.

  4. Now add a new module by clicking  at the bottom of the Edit page (2nd screenshot) 

  5. Set Module to Shopgate, Position to Content Top, and Sort Order to -1. Click Save on top.

  6. Repeat step 3 & 4 to add the Shopgate module to layouts Category and Products.

  7. After a "Shopgate Module" has been added to all 3 layouts (Home, CategoryProduct), all mobile visitors will be redirected to your mobile shop.

Now your plugin is ready to be connected.


For OpenCart version pre-2.0:

  1. Edit 2 source files on your FTP server, according to the instructions on the right.

  2. After this is done, all mobile visitors will be redirected to your mobile shop.

Now your plugin is ready to be connected.

----------------------------------- part 1 -----------------------------------

  • Open file /catalog/controller/common/header.php
  • Copy and paste 'module/shopgate' right after this line:
    $this->children = array(
  • Save file.

----------------------------------- part 2 -----------------------------------

  • Open file /catalog/view/theme/(current theme or default)/template/common/header.tpl
  • If exists, open the file /catalog/view/theme/(current theme or default)/template/common/header_home.tpl
  • Copy and paste <?php echo $shopgate; ?> right after this line in both files:
    NOTE: If this line cannot be found in your version, simply paste <?php echo $shopgate; ?> at the top of both files.
    <title><?php echo $title; ?></title>
    <?php echo $shopgate; ?>
  • Save file.


That's it! Now you have successfully installed the Shopgate plugin.

"Maintenance Mode" can now be set back to No.


2. Establishing connections between the plugin and Shopgate

After the Shopgate plugin has been installed successfully, 2 simple tasks need to be done to connect your mobile shop at Shopgate to your shop's backend: to enter API credentials in your shop's backend, and to enter your shop's URL in your Shopgate's admin page.

2.1 Getting API credentials

  1. Log in to your Shopgate Admin page.
  2. Click on Integration from the menu bar, then select Install Interface.
  3. In the drop-down labeled Select system, start typing OpenCart, and select it from the search result.
  4. A popup opens. Look for Customer number, Shop number, API key, and Alias under 2. Configure. These are the API credentials the plugin needs to authenticate at the Shopgate backend. Leave this page open - we will come back to enter the URL (explained in 2.2 Establishing connection)
  5. Copy Customer number, Shop number, API key, Alias, and CName (optional), and paste them individually onto the plugin configuration page you left open from the last chapter. Click Save.
    The rest of the options can be configured later. This is explained in Chapter 4. Configuring the Plugin).


2.2 Connecting your shop to Shopgate

  1. Go back to the pop-up window at your Shopgate merchant page (step 4). Enter your shop's URL to the text field at 3. Enter URL. Click connect to establish the interface.
  2. If a connection is made successfully, a popup shown below will open. Make sure to set all services to ON. Click Save.
  3. Congratulations! Now you should see the progress bar running, and the Shopgate backend automatically filling your mobile shop with your products. Depending on how many products you have, the import process can take anywhere from a few minutes to a few hours. You can always check the status of the imports. If no status bar is shown, it means either the import is finished, or no import is running at the moment.

    Welcome to the mobile world :)


3. Updating an existing Shopgate plugin

3.1 Checking for custom adaption

Before updating your Shopgate plugin to a newer version, make sure to check if your shop uses a customized version of the Shopgate plugin. If this is the case, a generic plugin update will NOT work for your shop.

To check if your plugin is customized...

You are using a customized version if

  • you have contacted Shopgate for making a 3rd party plugin to work in your mobile shop, or adding a special feature/function
  • Shopgate has sent you an adapted version of plugin
  • the plugin file you installed has "adaption" in the name

If your shop uses a customized Shopgate plugin...

Please email Shopgate each time before updating with the following details:


3.2 Updating the plugin

To update an existing Shopgate plugin, follow Chapter 1 Installing the Shopgate Plugin.

For OpenCart version before 2.0, please follow the steps below:

  1. Follow chapter 1.1 to put your shop in Maintenance Mode.
  2. To update a customized Shopgate plugin, download and unzip the file you received in the email.
    To update a generic Shopgate plugin, follow chapters 1.2 to download the latest version and unzip it.
  3. Open the unzipped file in your FTP program. You will see 3 sub-folders: admin, catalog, and shopgate.
  4. Update the Shopgate folder by dragging it to your shop folder on the FTP server. The old Shopgate folder on your FTP server will be overwritten.
  5. Update folders Admin and Catalog by copying files to your FTP server one by one:

    1. Click on Admin or Catalog (local folder) to open it.
    2. Starting with the first item, your task is to open a folder all the way until file(s) are revealed.
    3. Find the exact same file(s) in your shop folder on FTP server.
    4. Now select the file(s) in the local folder and drag it to the same folder on FTP server to update this file. The old file on your FTP server will be overwritten.
    5. Delete any old "Shopgate" files in Admin and Catalog (sub)folders that are no longer in use in the newer version of plugin.
    6. Now repeat the steps until ALL files in Admin and Catalog have been updated on your FTP server.
  6. Now you can set "Maintenance Mode" to No. This will complete the update.

IMPORTANT: If you have just updated your Shopgate plugin from a version older than 2.9.5, please make sure to configure your Customer number, Shop number, API key, Alias, and CName again following the instructions from Chapter 2.1. If you have updated from a Shopgate plugin version newer than 2.9.5, your plugin configurations should remain the same.

That's it! Now your Shopgate plugin has been successfully updated.


4. Understanding the plugin configurations

Here you can find detailed explanations to all configuration fields provided on the configuration page of the plugin.

Store Select the store you want to connect to Shopgate if there is more than one store.
Status You can enable or disable the plugin here.
Customer number Your customer number provided by Shopgate.
Shop number Your shop number provided by Shopgate.
API Key This is the "password" that the plugin uses to communicate with the Shopgate Merchant API in a secure channel.
CName Set a mobile URL under your own domain here. For example, use "" instead of the default Shopgate URL ""
Alias Your shop's alias, provided by Shopgate. Do not use special characters or spaces.
Merchant API Mode Set to "Live" to use your mobile shop. If you want to test the service, select "test mode".
Encoding The encoding type that is used in your OpenCart database. We recommend UTF-8.
Comment detail level Select how much information should be entered into the comment section when import orders.
Order status "shipping blocked" Choose a status from the drop-down to match the order status between your mobile shop and your webshop.
Order status "shipping not blocked"
Order status shipped""
Order status "canceled"


5. Frequently Asked Questions (FAQ)

5.1 My mobile shop became unavailable after I updated the Shopgate plugin. What should I do?

If you have not updated your Shopgate plugin for a while, it's possible that your plugin configurations cannot be updated properly to the newest version. This is easy to fix.

Simply go to your OpenCart backend and find the Shopgate plugin. Click the [Edit] Button to open the Settings page. Now enter your Customer number, Shop number, API key, Alias, and CName again following the instructions from Chapter 2.1.

Afterwards, refresh your shop and everything should be working again.


5.2 How to upload the Shopgate plugin via the FTP tool?

For OpenCart version before 2.0, you will need an FTP client tool to upload your Shopgate plugin. Plenty of FTP programs can be found on the internet. FileZilla is used in the example below. (How to install and use FileZilla?)

Now follow the steps below to upload the Shopgate plugin:

  1. Connect your FTP program to your server
  2. Navigate to the unzipped Shopgate plugin in your local directory (left).
  3. Select ALL files in your Shopgate plugin local folder
  4. Drag them into your shopping cart system folder on the FTP server (right).
  5. Upload will start immediately.

Now please proceed to activate the plugin in your OpenCart backend

JooCart users, please click instructions for JooCart to complete one more step before you proceed to activate the plugin in your OpenCart backend


5.3 Where can I enter my FTP credentials?


To enter your FTP server credentials, follow the steps here:

  1. In your OpenCart account, go to Settings then click the Edit button.

  2. On the Settings page, switch to the FTP tab.

  3. Enter your credentials here and enable FTP. Click Save.


Now you have entered and enabled your FTP server in your OpenCart.