Support Center

Connecting to Magento



Shopgate supports Magento as a shopping cart system.

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

Supported Version Import to Magento

1.4 +

Sync Export to Shopgate Mobile Shop

Delivery Status "Shipped"
Order Status "Canceled"
Stock Quantity, on Product Detail Page
Product Tax Classes, Rates & Rules

Related Products, Upsell & Cross-sell

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 Method
Product Availability

Supported Payments Other Supported Features

Magento native: PayPal, PayPal PLUS, Prepayment (BankPayment), Cash on deliveryInvoice, Authorize.NET

3rd-party: Shopgate Payments, Prepayment (BankPayment by Phoenix), BillSafe1 (by Netresearch), Sofort Banking (by SOFORT AG), Amazon Payments (by Creativestyle), USA ePay, PayOne2, Authorize.Net (CIM by ParadoxLabs), Payolution, ChargeItPro

1. Added support for Magento version
2. An invoice is created automatically for all orders. For PayPal orders, an invoice is created regardless of payment status.

  • NEW Shopgate Rules: a new Condition for your Shopping Cart Price Rule
  • Payment validation allows you to offer specific payments to targeted carts and customers. Please contact Shopgate Support to enable this feature.
  • Info from the Shopgate custom fields (2nd phone number, birthday, etc.) is exported in order details in your Magento backend.
  • bundle, group, configurable, and simple products
  • Catalog price rule
  • Group pricing for simple and configurable products


In this article, you will find everything you need to set up the Shopgate plugin for your Magento shop.


Topics covered in this article:

  1. Building your mobile shop
  2. Understanding plugin configurations
  3. Updating an existing Shopgate plugin
  4. Frequently Asked Questions (FAQ)


1. Building your mobile shop

Building your Magento mobile shop with Shopgate is simple and fast!

1.1 Getting your Magento ready

Get your Magento backend ready by doing the following. This will prevent your website from becoming temporarily unavailable.

installing or updating the Shopgate plugin

Disable Magento compilation, if enabled
 Disable Magento internal caching, if enabled
 Disable all external caching (e.g. Varnish, APC, ZendCache), if used

installing or updating the Shopgate plugin

Enable Magento compilation
 Enable and flush Magento internal caching
 Flush all external caching immediately


1.2 Installing the Shopgate plugin

The Shopgate plugin for Magento can be installed in Magento versions starting from To install the Shopgate plugin, follow the steps here:

  1. Log in to your Magento Admin, and navigate to System → Magento Connect → Magento Connect Manager.

  2. You will be prompted to log in again. Now the Magento Connect Manager will open. Paste this extension key to install the plugin:
    Magento Connect version 1.x users, please paste this key instead: Magento-community/shopgate_module
    IMPORTANT: Make sure to uncheck the option "Put store on the maintenance mode while installing/upgrading/backup creation".

    * If the extension key doesn't work, an alternative method is provided at the end of this article.

  3. The page will re-load and an "Extension dependencies" table will appear. Click Proceed. Now the Shopgate plugin will start to install.

  4. If the plugin is installed successfully, you should see the log output and "Procedure completed." text at the bottom of the page. Click Refresh to reveal the Shopgate plugin in the Manage Existing Extensions list.

  5. After the plugin has been successfully installed, flush the internal cache and all external cache (e.g. Varnish, APC, ZendCache). You can also enable your compiler again if needed.

  6. That's it! The Shopgate plugin has been installed successfully. Now return to your Magento backend by clicking Return to Admin at the top of the page.
NOTE: When installing the Shopgate plugin using Magento Connect Manager, plugin folders may be set to 777 (world-writable permissions) by Magento during the installation process.


1.3 Importing products to your mobile shop

After the Shopgate plugin has been installed, you are only a few clicks away from having a functional mobile shop! Follow the easy steps below to get started.

  1. First of all, log into your Shopgate Admin page.

  2. Come back to your Magento Admin Panel. You should now see Shopgate listed as a new menu entry. Navigate to Shopgate > Manage Connections to set up the plugin.
    IMPORTANT: If there is any issue loading the plugin page, try logging out and logging in again.

  3. If you don't already have a connection created to Shopgate, you will be asked to Establish a new Connection to Shopgate. Choose your default Store View, and click on button Connect to Shopgate.

  4. You will now be redirected to "Authorization Request" at Shopgate. Leave all options to ON to access all the features listed. Select a mobile shop if you have more than one shop at Shopgate. Click Authorize.

  5. After a few seconds, you should see a big green Hooray! page. Click Configure interface to continue.

  6. That's it! An import will start immediately and the progress bar will be running. This means that the Shopgate backend is automatically filling your mobile shop with your products! Once the progress bar disappears, you should have your mobile website finished.


1.4 Reviewing your mobile shop

Now you have done everything you need to build your mobile shop! You can preview your apps and mobile website as soon as the import process is finished.

Verify your products, play with your designs, explore the tools and features, and set your shop live!

Now welcome to the mobile world :)



2. Understanding plugin configurations

In this chapter, we will explain all the options you have to configure the Shopgate plugin in your Magento backend.

To locate the Shopgate plugin Configuration, follow the steps here:

  1. Log into your Magento Admin Panel, and navigate to Shopgate > Manage Connections. If there is any issue loading the plugin page, try logging out and logging in again.

  2. You should see at least one connection to Shopgate. Navigate to Action (drop-down) > Configure on the corresponding grid row.
  3. You will be directed to the Configuration page for the Shopgate module. If you have installed the Shopgate plugin and imported your products (Chapter 1), some information should already be pre-filled for you.


To understand your options to configure the Shopgate plugin in details, continue to read the following 5 sections:

2.1 Basic Configuration

Choose your default store, enable the Shopgate plugin, and establish a connection.

Default Store This is the default store for the website scope you are in. This is the store that will be the default for imports and other vital checks.
Enable A simple toggle to activate or deactivate the whole plugin.
Shopgate Link Click on the button to "Establish connection". If this step has been completed, you will see "Connection successful" message.


The following options are available to Shopgate plugin versions below 2.9.16

Customer Number Your Customer Number at Shopgate. Where can I find my Shopgate Customer Number?
Shop Number Your Shop Number at Shopgate. Where can I find my Shopgate Shop Number?
API Key Your API Key generated at Shopgate. This key is used in the authentication process between Shopgate and the Magento module. Where can I find my Shopgate API Key?


2.2 Mobile Website

This section offers settings to influence redirecting from your shop to mobile devices through Shopgate.

Shop alias A descriptive name for the shop
Custom URL to mobile web page (CNAME) A URL used for the mobile version of your shop. The default is [alias], an alternate could be m.[alias].com
Redirect Type This option defines how URL requests to your shop are redirected to mobile devices. There are two options available, redirect through HTTP or through JavaScript. HTTP is preferable because it is more descriptive of why it is redirecting and therefore more SEO friendly.
Disable redirect for specific routes If you want to suppress the mobile redirect for a specific route, you can enter the routes name here in a comma separate list and the route won’t trigger a mobile redirect. For example, if you don’t want your home page and other CMS pages to not be routed to the mobile URL, you can write "cms" in this field.
Disable redirect for specific controllers This is the equivalent to suppressing routes except this is for controllers (e.g. if you want to suppress the newsletter controller for the subscriber page, you can type "subscriber" into this field and it will prevent the redirect on newsletter/subscriber/ requests)
Disable redirect for specific products In this field you can put a comma-separated list of product ids. For every product ID provided, it will suppress the redirect action to mobile shop on that product's page.
Disable redirect for specific categories In this field you can put a comma-separated list of category ids. For every category ID provided, it will suppress the redirect action to mobile shop on that category's page.
Map CMS Pages for redirect This feature allows mapping a Magento CMS page to a CMS page created in your Shopgate Admin. Provide the URL key used by the CMS page in Shopgate.


2.3 Product Export

Here you can define how to export products.

Product types to be exported A multi-select drop-down for all product types that we support exporting. Note that product type "virtual" and other custom types are not supported at this time.
Product names to be exported Defines which product name to use when exporting products that have a parent/child relationship. For example, if you select the parent’s name then all children of a specific product will have the name of its parent.
Keep line breaks This is a converter of line breaks (when you clicking “enter” in the description text fields) to HTML break tags (<br />). Depending on how you maintain your descriptions, you may or may not want to select these.
Products description layout The attribute to use when displaying a description on the product page. You can also use a custom attribute if you provide the proper attribute code.
Export filterable attributes The Shopgate module exports any attribute which is visible on the product’s detail page. In addition, you can let the module export any filterable attribute which is visible in the layered navigation.
Ignore sub-products prices Defines what prices will be fetched on products with a parent-child relation.
Weight unit Determine the used weight unit in your shop or let the module figure it out based on the configured default country.
Export variation images Allows exporting images of parent products and children products. You can also choose the order they will be exported in and therefore displayed. For example, choosing "Both (sub-products first)” will show sub-product images first and then parent images on product pages.
Export variation description Allows exporting descriptions of parent products and children products. You can also choose the order they will be exported in and therefore displayed. For example, choosing "Both (parents first)” will show the parent description followed by the sub-product description on product pages.
Export excluded images If “yes”, the pictures that are marked as “excluded” in Magento will get exported. Pictures must be 150x150 pixels or more for this to happen.
Export images with low resolution [NEW FIELD] Allow export of images that are below 150x150 in pixel resolution
Source Main Product Image Choose which image will be the main image showing up in category view and as the first image on the product detail page.
Export all stores of this website If "No" is selected, only data from the default store selected previously will be exported. Otherwise, all products and categories of all stores within this website scope will be exported.
Attribute-code for available text If left unselected, the default "out of stock/in stock" text will be used. A backorder label will also be used if enabled within the default Magento configuration. You can, however, use a different attribute that would be of type select, text or date to provide the “in-stock” like notification to the customer.
EAN attribute code Here you can specify an attribute code that is used as the EAN field.
UPC attribute code [NEW FIELD] Here you can specify an attribute code that is used as the UPC field.
Filter for properties Attributes you don’t want to be exported to your mobile shop.
Force the export of properties Attributes you want to be exported to your mobile shop. You can only force to export attributes from the attribute set the product is based on (attributes will also only appear on the product edit page in the Magento backend if they are connected to the attribute set).
Export hidden categories This field can contain a comma-separated list of category ID's which will be forced to be exported and set as active in the mobile shop.
Export categories from navigation menu only If set to “Yes", only categories that were marked to be included in Navigation Menu will be exported. You can find this setting under Manage Categories > General Information tab.
Products sort order Setting for sort order of products inside of categories
Net market countries This field is used to set a shop as “net" market. The website stores will get treated like a "net" market and will export product prices as “net", moreover the tax handling is different for these stores. This feature should be touched only in rare cases by Shopgate integration managers.
Use Article Price Index in Product Export Use price index to speed up your product import. However, make sure to keep the index up-to-date for the update prices to be displayed on mobile. This is a setting under Index Management > Product Prices


2.4 Orders Import

This section will handle order import processes.orders_import_english.png

Mark unblocked orders as “paid” An unblocked order is the one whose shipment is not blocked. If set to ‘Yes', whenever an unblocked order is imported, the module can capture the order total amount and set the order state to processing. This is very useful for payment providers which have a separate gateway to process the payment and there is no need to verify order payment on import (e.g. PayPal, Klarna, credit card).
Send an email to customer on new order On each order import the customer will get an order confirmation mail after import. This flag should be used in conjunction with the 'send confirmation mail' flag in the Shopgate merchant area.
Confirm shipping to Shopgate if order state is complete If set to ‘Yes’ the plugin will communicate that the shipping is approved and complete to the shopgate merchant panel when a Magento order state becomes ‘complete'
Write Shopgate Custom fields into the status history as a comment when enabled, your custom fields at Shopgate will be added to the status history comment section on every order import.
Shopgate Payment Title This text field allows the merchant to define a payment title for any payment handled by Shopgate. This payment title is used in emails and order details.
Apply Shopping Cart Price Rules to mobile orders  This allows the customer to enable Shopping Cart Rules on mobile site's cart page.
Add only the simple Product to order When enabled, only simple products will be added to an order on import. Configurable or other types of products will be ignored.
Use shipping prices from Shopgate Forces the shipping method to be 'shopgate_fix' and therefore rewrites calculated shipping prices with Shopgate’s shipping price.
Use product prices from Shopgate Activate this option to set special discounted price for your mobile website and apps.


2.5 Connection Settings

This tab is responsible for the routing to the Shopgate’s merchant API.

Shopgate server This option allows picking a predefined URL to communicate with the merchant API of Shopgate.
API URL This field is used only when the “Shopgate server” flag is set to “custom” and is only useful for debugging purposes.
.htaccess user
.htaccess user and password are only used to bypass additional htaccess authentications.
.htaccess password


2.6 Shopgate Order Status

This configuration is under System > Configuration > Sales > Payment Methods. The sections allow configuring order statuses of imported orders.

Shopgate > New order Status This field allows configuration of the status of new orders which are set to be processed by Shopgate within the Merchant admin panel.
Mobile Payment (Shopgate) > New Order Status This field is the default fallback of all new order imports that have no payment mapping defined in Magento. For example, if we do not support a particular payment module this will be the status used for the order import.



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 a customized Shopgate plugin, follow chapter 4.3 to install the latest plugin (you received in the email) manually.

To update a generic Shopgate plugin, follow the steps here:

  1. Log into your Magento Admin Panel. Get your Magento backend ready by disabling cache and compiling process. This will prevent your shop from being temporarily unavailable to your customers.

  2. Navigate to System → Magento Connect → Magento Connect Manager.

  3. The Shopgate plugin should now appear in the list of Manage Existing Extensions. Click Check for Upgrades button on top of the list.

  4. Uncheck option "Put store on the maintenance mode while installing/upgrading/backup creation". Select a newer version of the Shopgate plugin from the drop-down, and click Commit Changes.

  5. Once again you will see the log output running through update commands at the bottom of the page. If the plugin is updated successfully, you should see the log output with a "Procedure completed." text at the bottom. Click Refresh button to finish the update process.

  6. Flush internal cache and all external cache immediately. You can enable your compiler now if used.

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



4. Frequently Asked Questions (FAQ)

4.1 How to disable / enable the compiler in Magento?

  1. Navigate to System -> Tools -> Compilation.

  2. Disable Magento compiler: Before installing or updating the Shopgate plugin, disable the Magento compiler by clicking the Disable button.

  3. Enable Magento compiler: After the plugin has been successfully installed, restart your compiler by clicking the Run Compilation Process button.


4.2 How to disable or flush the internal cache in Magento?

  1. Go to System > Cache Management.

  2. To disable Magento cache: Select Configuration, set Action to Disable on the top right, then click Submit.

  3. To flush Magento cache: Click button "Flush Cache Storage".


4.3 How can I install the Shopgate plugin manually?

If you're experiencing difficulties installing the Shopgate plugin using the extension key, simply upload the Shopgate plugin manually to your Magento backend. To do so, follow the steps below.

  1. Log into your Magento Admin Panel. Get your Magento backend ready by disabling cache and compiling process. This will prevent your shop from being temporarily unavailable to your customers.

  2. Navigate to SystemMagento ConnectMagento Connect Manager.

  3. Download the latest Shopgate plugin at and upload it manually by clicking Choose File then Upload.
    Important: When installing or updating your plugin, make sure to uncheck the option "Put store on the maintenance mode while installing/upgrading/backup creation." to avoid any downtime in your desktop shop.

  4. Scroll down to the bottom of the page, and wait for the log output to show "Procedure completed" text. Click Refresh to finish the installation process.

  5. Flush internal cache and all external cache immediately. You can enable your Magento compiler now if used.

The Shopgate plugin is now successfully installed. Now follow chapter 1.3 to import products to your mobile shop


4.4 A blank page appeared after I installed the plugin. What should I do?

If you see a blank page after you clicked on the Install button for Shopgate plugin, it is possible that the compiler in your Magento backend was running at the time. Don't panic! Simply follow the steps below to revert the issue:

  1. Go back to your Magento Connect Manager by clicking on the Back Arrow on your browser. If this is not possible, type "" in your browser's address field.

  2. Now you should be back at your Magento Connect Manager page. Uninstall the Shopgate plugin.

  3. After the log output shows a success message, click on Refresh button to reload the page. Now your Magento should work again.

  4. Now follow chapter 1 to build your mobile shop.


4.5 An error occurred at "Authorization request". What should I do?

If an error message appeared on the "Authorization request" screen, check if your shop's URL is entered correctly. To do so, follow the instruction here: How to update my Shop URL for the plugin connection

If the error still occurs, try to connect the Shopgate plugin manually


4.6 How to connect the Shopgate plugin manually?

To connect the Shopgate plugin to your Magento backend manually, follow the steps below:

  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 "Select system", start typing Magento, and select the version you use.

  4. A popup opens. Select "Version before 1st July 2014", and enter your shop's URL. Do NOT click Connect yet.

  5. Copy the Customer number, Shop number, API key, Alias, and CNAME (if applicable) in the pop-up above and paste them in your Magento backend (System > Config > Shopgate). Click Save.

  6. Go back to your Shopgate Admin page, and click Connect.

That's it! Now you have successfully installed and connected your Shopgate plugin manually.


4.7 How to show/hide filters and properties in a mobile shop?

Filters and properties of your products can be shown or hidden in your mobile shop. To do so, go to the Shopgate plugin Configuration page in your Magento backend. Find the section Products Export, and look for options "Filter for properties" and "Force the export of properties".

  • Filters and properties selected (highlighted) in "Filter for properties" will be hidden in your mobile shop.
  • Filters and properties selected (highlighted) in "Force the export of properties" will be shown in your mobile shop.


4.8 How to stop showing "plugin update" notification at start-up?

Starting from Shopgate plugin version 2.9.7, we will inform you of an update in your Magento backend. A notification will show when you log in to your Magento.

If you don't want to see this notification each time you log in to your Magento, follow the steps below:

  1. In your Magento Admin Panel, go to System > Notifications.

  2. Find the notification that you want to stop showing, and click "Mark as Read" in the Actions column.

That's it! Now you have disabled this notification at start-up.


4.9 Where can I find the "Shopgate Rules" for Shopping Cart Price Rule?

You can find the "Shopgate Rules" under Promotions > Shopping Cart Price Rules > Conditions.

Currently, you can choose the Cart Type from mobile site, iPhone app, iPad app, android app, and android tablet.