Magento is a supported shopping cart system at Shopgate. By setting up the Shopgate plugin for your Magento, you will automatically get products, categories and reviews export, orders import, and shipping confirmation straight into your shopping cart.
In this article, you will find the instructions to set up the Shopgate plugin for your Magento.
Topics covered in this article:
- Building your mobile shop
- Understanding plugin configurations
- Updating an existing Shopgate plugin
- Frequently Asked Questions (FAQ)
- 4.1 How can I install the Shopgate plugin directly?
- 4.2 A blank page appeared after I installed the plugin. What should I do?
- 4.3 How can I stop/start the compiler in Magento?
- 4.4 An error occurred at "Authorization request". What should I do?
- 4.5 How to connect the Shopgate plugin manually?
- 4.6 How to stop showing "plugin update" notification at start-up?
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 Installing the Shopgate plugin
The Shopgate plugin for Magento can be installed in all Magento versions starting from 18.104.22.168. To install the Shopgate plugin from the Magento Connect Store, follow the steps here:
- Log in to your Magento Admin, and navigate to System → Magento Connect → Magento Connect Manager.
- 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_moduleIMPORTANT: 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.
- The page should load again, and an "Extension dependencies" table will appear. Click the Proceed button to start installing the plugin.
- Scroll down to the bottom of the window. If the plugin is installed successfully, you should see the log output below with a "Procedure completed." text in the bottom. Click the Refresh button. Now the Shopgate plugin should appear at the end of the Manage Existing Extensions list.
- That's it! The Shopgate plugin has been installed successfully. Now scroll to the top of your Magento Connect Manager, and click on Return to Admin.
1.2 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.
- First, 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 the Shopgate website.
- 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.
- 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.
- 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.
If you're seeing an error instead, read An error occurred at "Authorization request". What should I do?
- After a few seconds, you should see a big green Hooray! page. Click Configure interface to continue.
- 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.3 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:
- 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.
- You should see at least one connection to Shopgate. Navigate to Action (drop-down) > Configure on the corresponding grid row.
- 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: Basic Configuration, Mobile Website, Products Export, Orders Import, and Connection Settings.
2.1 Basic Configuration
Basic configuration provides the settings which are essential to connect your magento with Shopgate. We will comment each option in detail.
|Default Store||Here you have to define which store view is the default store view and the main reference for all module api tasks. This means anytime the Shopgate backend is communicating with the module it will reference the here defined store view as the active one. This will affect any setting which is customizable in store view scope.|
|Enable||A simple toggle to activate or deactivate the whole plugin.|
|Customer Number||A collection of digits representing your merchant account at Shopgate|
|Shop Number||Another collection of digits representing your current Shopgate shop|
|API Key||A hash string calculated from your customer number and your Url, this string is used as a key value in the authentication process between Shopgate and the magento module.|
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||An url used for the mobile version of your shop. The default is [alias].shopgate.com, an alternate could be m.[alias].com|
|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. Some product types are not fully supported like the|
|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.|
|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 properties||The module exports in front-end visible product properties on default and can include filterable properties in addition. With this field you can give a comma separate list of attribute codes which should be ignored on export.|
|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.|
|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.|
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.|
|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.|
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 and password are only used to bypass additional htaccess authentications.
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
If your shop uses a customized Shopgate plugin...
Please email Shopgate each time before updating with the following details:
3.2 Updating the plugin
Upgrading an already installed Shopgate module is most effectively done with the Magento Connect Manager. The steps are listed below:
- Login to your Magento Admin Panel, and navigate to System → Magento Connect → Magento Connect Manager.
- The Shopgate plugin should now appear in the list of Manage Existing Extensions. Click Check for Upgrades button on top of the list.
IMPORTANT: Make sure to 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 next to the Shopgate module, and click the Commit Changes button.
- 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 below with a "Procedure completed." text in the bottom. Click the Refresh button to finish the update process.
- That's it! Now your plugin has been successfully updated.
4. Frequently Asked Questions (FAQ)
4.1 How can I install the Shopgate plugin directly?
If you're experiencing difficulties installing the Shopgate plugin using the extension key, simply upload the Shopgate plugin directly to your Magento backend. To do so, follow the steps below.
- To get started, download the latest Shopgate plugin for Magento via this link: http://files.shopgate.com/plugins/magento.tgz.
- Login to your Magento Admin Panel and navigate to System → Magento Connect → Magento Connect Manager.
- Upload the Shopgate plugin directly on this page. Click Choose File, choose the Magento.tgz file you just downloaded, and click 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.
- 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.
The Shopgate plugin is now successfully installed. To start importing your products, go to Chapter 1.2: Importing products to your mobile shop
4.2 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:
- 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.
- Now you should be back at your Magento Connect Manager page. Uninstall the Shopgate plugin.
- After the log output shows a success message, click on the Refresh button to reload the page. Now your Magento should work again.
- Before you install the Shopgate plugin again, make sure to pause your Compiler if it is still running. How can I stop/start the compiler in Magento?
- Install the Shopgate plugin following the steps in Chapter 1.1.
- After the plugin has been successfully installed, restart your complier by clicking on the Run Compilation Process button.
- Now you have successfully installed the Shopgate plugin. Please follow Chapter 1.2 and 1.3 to finish building your mobile shop.
4.3 How can I stop/start the compiler in Magento?
- Navigate to System -> Tools -> Compilation.
- Pause the compiler by clicking on the Disable button.
- Clear cache in Magento. Go to System > Cache Management.
- Select Configuration, set Action to Disable on the top right, then click Submit. This will clear the cache in your Magento backend and make your shop ready to install the plugin.
- After the plugin has been successfully installed, restart your complier by clicking on the Run Compilation Process button.
4.4 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 connecting the Shopgate plugin manually
4.5 How to connect the Shopgate plugin manually?
To connect the Shopgate plugin to your Magento backend manually, follow the steps below:
- Log in to your Shopgate Admin page.
- Click on Integration from the menu bar, then select Install Interface.
- In the drop-down "Select system", start typing Magento, and select the version you use.
- A popup opens. Select "Version before 1st July 2014", and enter your shop's URL. Do NOT click Connect yet.
- 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.
- 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.6 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:
- In your Magento Admin Panel, go to System > Notifications.
- 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.