Support Center

Connecting to Magento

Magento is a supported shopping cart system at Shopgate.

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

Support

Version

 

1.4 +

Export to Desktop Shop

Orders

 

Customer Account

Login with Desktop Shop Account
Login to Desktop Shop with Mobile Account
Customer Groups / Tier Pricing
Show Customer's Order History

 



/

Import to Mobile Shop

CSV / XML
Products
Categories
Reviews

 

/




Sync

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

 



Validate, upon Cart Changes

Coupon
Shipping Method & Price
Product Availability

 



Payments Supported

Shopgate, PayPal, Cash on Delivery, Prepayment (Magento Default & Phoenix), Invoice, BillSafe, Sofort Banking, Amazon Payments, USA ePay, Authorize.NetNEW*

Notes

Bundle/Grouped/Configurable/Simple products are available.

* Authorize.Net is currently supported in Magento Community Edition starting from version 1.5.0.1.

 

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! In this chapter, we will explain everything you need to build your mobile website and apps at Shopgate.

1.1 Getting your Magento ready

To avoid errors on recompilation and cache flush, it is highly recommended to disable compiling process and all caching while installing and updating the Shopgate plugin. This will prevent your website from becoming temporarily unavailable.

Before you install and update the Shopgate plugin, get your Magento backend ready by doing the following:

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

After you install or update the Shopgate plugin, you can enable compilation and caching again. However, make sure to flush internal cache and all external cache immediately.

 

1.2 Installing the Shopgate plugin

The Shopgate plugin for Magento can be installed in Magento versions starting from 1.4.0.0. 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 login again. Now the Magento Connect Manager will open. Paste this extension key to install the plugin: http://connect20.magentocommerce.com/community/shopgate_module
    Magento Connect version 1.x users, please paste this key instead: magento-community/shopgate_module
    IMPORTANT: Make sure to uncheck 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 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 in to your Shopgate Admin page. If you don't already have an account with Shopgate, sign up or start a free trial at www.shopgate.com

  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! Your mobile website and apps should be ready for review at Integration > Test mobile shop as soon as the import processes are finished.

Review your products, play with your designs, explore the awesome 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. Login to 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 Define the default store view and the main reference for all API tasks through the Shopgate plugin. This means the store defined here will be referred to as the active store every time the Shopgate backend communicates with the plugin. This will affect settings that are customizable in store view scope.
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 webpage (CNAME) An url used for the mobile version of your shop. The default is [alias].shopgate.com, an alternate could be m.[alias].com
Redirect Type This option defines how requests to your shop are redirected to mobile devices. There are two options available, redirect through http or through javascript. Http is preferable, cause it offers a valid redirect type through http header codes (e.g. 301 permanent redirect) and is 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 (e.g if you want to suppress redirect on Wordpress blog pages with a Wordpress module, you can enter the route “Wordpress” and it will prevent the plugin to redirect on each request to this route.
Disable redirect for specific controllers This is the equivalent to suppressing routes just for controllers (e.g. if you want to suppress the newsletter controller for subscriber you can type into the field “subscriber” and it will prevent to redirect on newsletter/subscriber/ requests)
Disable redirect for specific products In this field you can put a comma separate list of product id’s. Each id will suppress the mobile redirect on the given product’s id detail page.
Disable redirect for specific categories In this field you can put a comma separate list of category id’s. Each id will suppress the mobile redirect on the given category’s id category listing.

  

2.3 Product Export

Here you can define how to export products.

Product types to be exported A multi-select drop-down for all available product types. Note that, product type "virtual" and customized types may NOT be supported by the Shopgate plugin.
Product names to be exported Defines which product name is preferable on product’s with a parent child relation, available options are parent or child product’s name.
Keep line breaks This option is a multi-select drop-down, here you can pick any type of product description to export and set if the content should be converted with the nl2br command. In detail, any selected type of description will get his new lines converted to
tags to be shown properly on mobile devices. Your choice should depend on the way your product description is maintained.
Products description layout Pick a type of description to use on as description on mobile versions of your shop, combinations are also possible.
Export filterable attributes The Shopgate module is exporting any attribute which is visible in the front-end onto the product’s detail page. In addition you can let the module export also any filterable attribute which could be used into the layered navigation.
Ignore sub-products prices Defines what prices will be fetched on products with a parent-child relation.
Export visible sub-products If this option is activated any variation of a configurable product will be exported as standalone simple product, in addition.
Weight unit Determine the used weight unit in your shop or let the module decide automatically in conjunction with the currently configured default country.
Export variation images Define which pictures are exported by products with parent-child relations. A variety of combinations is possible.
Export variation description The same like with the pictures.
Export excluded images If this flag is activated any picture will get exported for a given product, even pictures which are marked as excluded, as long as they are bigger then 150 x 150 pixels.
Export Thumbnail images at first Defines if the picture export will list thumbnails before normal size pictures.
Source Main Product Image Choose the source of the main image of a product.
Export all stores of this website When this flag is active the module will cycle through any store group of a website and export store view comprehensive categories and products.
Attribute-code for available text Here you can choose an attribute code which represents the state of your product’s available text. Any Textfield and Select based attribute is usable. But be aware when you pick an attribute code here, that the merchant is responsible to maintain the state of the content of these attributes. The plugin won’t export a different available text when a product is out of stock.
EAN attribute code Here you can specify an attribute code to rely on export for the EAN code for products. The attribute code has to be typed into the textfield.
Filter for properties Attributes you want to ignore in your mobile shop.
Force the export of properties Attributes you want to export to your mobile shop.
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, however the current state is set in magento.
Export categories from navigation menu only All others will be exported as inactive.
Products sort order Defines in what order the products will be exported, imported and listed on mobile devices. The option “category position” should be the most natural for magento and will use the magento internal positioning of products.
Net market countries This field is used to set a shop as net market. On default countries like US or GR get treated like net markets and will export product prices as net, also the tax handling is different on net market countries. This is a feature which should be touched only in very rare cases in relation to 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 prices to show up correctly.

 

2.4 Orders Import

This section will handle order import processes.

Mark unblocked orders as “paid” Whenever an order is imported with the shipping being approved, the module can capture the order total amount and set the order state to processing. This is very useful on processing orders with payment providers which have a separate gateway to process the payment and for usual get into the shopping system when the payment has been already applied (e.g. PayPal, Klarna, credit card).
Send email to customer on new order On each order import the customer will get a order confirmation mail after import. These 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 Will communicate the shipping as approved and complete when the order state is complete and the flag is active.
Write Shopgate Custom fields into the status history as comment When enabled, your custom fields at Shopgate will be added to your order status history as comments.
Shopgate Payment Title This Textfield allows the merchant to define a payment title for any payment handled by Shopgate. This payment title is used in mails and order details.
Shopgate Shipping Carrier Title This Textfield allows the merchant to define a shipping title for any shipping handled by Shopgate. This shipping title is used in mails and order details.
Add only the simple Product to order When enabled, only simple products will be added to an order. Configurable or other types of products will be ignored.

  

2.5 Connection Settings

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

Shopgate server This option allows to pick 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

 

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. Login to 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 complier by clicking the Run Compilation Process button.

 

4.2 How to disable or flush 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. Login to 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 http://files.shopgate.com/plugins/magento.tgz and upload it manually by clicking Choose File then Upload.
    Important: When installing or updating your plugin, make sure to uncheck 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 "your-magento-shop-name.com/downloader" 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 at 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 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.



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

Comments