Support Center

Connecting to Oxid

Oxid is a supported shopping cart system at Shopgate.

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

Support

Version

 

4.1 +

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, Invoice, Direct Debit, PayolutionNEW

Notes

N/A

 

In this article, you will find the instructions to set up the Shopgate plugin for your Oxid shop.

 

Topics covered in this article:

  1. Installing the Shopgate Plugin
  2. Establishing a connection
  3. Updating an existing Shopgate plugin
  4. Configuring the Plugin
  5. Frequently Asked Questions (FAQ)

 

1. Installing the Shopgate Plugin

The Shopgate plugin for Oxid can be installed in all Oxid eShops starting from version 4.2.0. Simply upload the plugin to your Oxid folder and activate it in your Oxid admin page. To do this, please follow the steps below:

1.1 Downloading the plugin

Download the plugin via this link: http://files.shopgate.com/plugins/oxid.zip and extract the contents of the zip file. (Link: how to extract a zip file?) This should give you a folder called “oxid” with two subfolders:

  • Ab_eShop_4.7 (this is for Oxid eShop version 4.7.0 and above)
  • Bis_eShop_4.6 (this is for Oxid eShop versions 4.2.0 to 4.6.x)

 

1.2 Uploading the plugin to your server

  1. Using an FTP or a similar program to copy the plugin into your Oxid eShop. Plenty of FTP programs can be found on the internet. If you don’t know which one to use, we recommend FileZilla.

  2. Once your FTP program is connected to your server, navigate to your locally extracted Shopgate plugin.

  3. Choose between the subfolders “Ab_eShop_4.7” or “Bis_eShop_4.6” according to your Oxid version.

  4. Open a subfolder of this folder called “copy_this”. Copy all contents in "copy_this" directly to the root directory of your Oxid installation on your server. Don’t close your FTP program just yet. You’ll need it again in a later step.

Now continue to set file permissions.

 

1.3 Setting file permissions

It’s necessary so set file permissions to the "temp" and "config" folders on your server.

  1. To do this, navigate to the "modules/shopgate/shopgate_library" folder on your server and select both "temp" and "config" folders. Right click on your selection and click on File permissions....



  2. Change file attributes dialog opens. Enter the numeric value “664*” into the input field. Make sure the checkbox “Recurse into subdirectories” is enabled and “Apply to all files and directories” is selected as the option. Click OK to finish the upload.
    * If you cannot save your changes or configurations, set file permissions to 777.

Now your Shopgate plugin is successfully installed and ready to be activated.

 

1.4 Activating the plugin

To activate the Shopgate plugin, log in to your Oxid admin backend and follow the instructions according to your Oxid version:

Oxid 4.4 and earlier

  1. Find the code section: Select Master Settings -> Core Settings from the menu on the left. Choose the tab System. Click Modules to expand the section.
  2. Enter this code in the text area shown above:
    marm_shopgate_article => shopgate/marm_shopgate_oxadminview
    order_main => shopgate/shopgate_order_overview
    order_overview => shopgate/shopgate_order_overview
    oxarticle => shopgate/marm_shopgate_oxarticle
    oxbasket => shopgate/shopgate_oxbasket
    oxdeliverylist => shopgate/shopgate_oxdeliverylist
    oxorder => shopgate/marm_shopgate_oxorder
    oxoutput => shopgate/marm_shopgate_oxoutput
    oxsession => shopgate/shopgate_oxsession
    oxvarianthandler => shopgate/shopgate_oxvarianthandler
    shopgate_order => shopgate/marm_shopgate_oxadminview
    shopgate_payment => shopgate/marm_shopgate_oxadminview
    shopgate_shipping => shopgate/marm_shopgate_oxadminview
  3. If some of the entries already exist, add the corresponding value to the end with an ampersand (&). For example: if "oxorder" (line 7) already exists like this:
    oxorder => invoicepdf/myorder
    add the info from "oxorder" to the end like this:
    oxorder => invoicepdf/myorder&shopgate/marm_shopgate_oxorder
  4. Now you have activated your plugin. Continue to the next step: Clearing Oxid's temporary folder

Oxid 4.5

  1. In the main menu on the left click Master Settings -> Core Settings. Click the tab System. Click the section Modules to expand it.
  2. Enter the following in the text area labeled Installed Shop Modules:
    order_main => shopgate/shopgate_order_overview
    order_overview => shopgate/shopgate_order_overview
    oxarticle => shopgate/marm_shopgate_oxarticle
    oxbasket => shopgate/shopgate_oxbasket
    oxdeliverylist => shopgate/shopgate_oxdeliverylist
    oxorder => shopgate/marm_shopgate_oxorder
    oxoutput => shopgate/marm_shopgate_oxoutput
    oxsession => shopgate/shopgate_oxsession
    oxvarianthandler => shopgate/shopgate_oxvarianthandler
  3. If some of the entries already exist, add the corresponding value to the end with an empersand (&). For example: if "oxorder" (line 7) already exists like this:
    oxorder => invoicepdf/myorder
    add the info from "oxorder" to the end like this:
    oxorder => invoicepdf/myorder&shopgate/marm_shopgate_oxorder
  4. Now you have activated your plugin. Continue to the next step: Clearing Oxid's temporary folder

Oxid 4.6 and later

  1. Click Extensions -> Modules on the main menu on the left .
  2. Click Shopgate in the list of extensions .
  3. Click on the Overview tab on the lower part of the screen, if it isn’t already open.
  4. Click the Activate button on the right to activate the Shopgate plugin.
  5. Now your plugin has been activated. Continue directly to Chapter 2 Establishing connections between the plugin and Shopgate. (You do NOT need to clear Oxid’s temporary folder.)

 

1.5 Clearing Oxid’s temporary folder

Oxid versions 4.5 and earlier users, please remember to clear the temporary folder in Oxid before you proceed.

  1. Now go back to your FTP program and locate a folder called "tmp" in your Oxid installation.

  2. If there is a file named ".htaccess", select all files except ".htaccess" inside the folder "tmp" and hit delete. Otherwise, delete all files inside the folder "tmp".



  3. Now you have cleared the temporary folder successfully.

 

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 dropdown labeled Select system, search for OXID eSales, and select a version depending on your shop edition. (CE = Community Edition, PE = Professional Edition, EE = Enterprise Edition)



  4. A popup opens. Under 2. Configure, you'll see the API credentials the plugin needs to authenticate with the Shopgate backend. Leave this page open for the next step 2.2 Establishing connection



  5. Open your Oxid admin backend in another tab or window of your browser (if you don’t already have it open from installing the plugin). In the main menu on the left, click on Master Settings -> Core Settings, and then on the tab called Shopgate. Expand the sections called Basic Configuration and Mobile website by clicking on them. Fill in the fields Shopgate Customer Number, Shop Number, Shopgate API Key, and Alias with the values from your Shopgate merchant backend. There are some other settings on this page, but you don’t need to configure them for now. Click save.

 

2.2 Connecting your shop to Shopgate

  1. Go back to the pop-up window at your Shopgate merchant page (step 4).

  2. Under 3. Enter URL, enter the URL of your shop, ideally starting with “https://”. For example: https://www.MyAwesomeShop.com

  3. Click Connect to establish the interface.



  4. If a connection is made successfully, a popup shown below will open. Here you will be able to assign jobs for your first connection. Leave all assignments to ON to access all the available services. Click Save.



  5. That's it! Now the Shopgate backend will automatically start to import product data via the newly established interface.

 

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 previously installed Shopgate plugin to the latest version, follow the steps here:

  1. Deactivate the old plugin first. (Oxid version 4.6 and later ONLY)

    In your Oxid Admin area, navigate to Extensions > Module, then select Shopgate from the list. Go to the Overview tab, and click on Deactivate button to deactivate the old Shopgate plugin.


  2. Download the latest plugin.
    To update a generic Shopgate plugin, download the newest plugin as described in Chapter 1.1. 
    To update a customized Shopgate plugin, download the newest plugin we send to you in the email.

  3. Install and activate the plugin following Chapter 1.2 - 1.5

That's it! Now you have successfully updated your Shopgate plugin. 

 

4. Configuring the Plugin in Oxid

To find the setting for your Shopgate plugin, please click Master Settings -> Core Settings in the main menu on the left, then on the tab labelled Shopgate.

4.1 Basic settings

Configure your Shopgate credentials used to connect to the Shopgate system.

Shopgate Customer Number Your customer number at Shopgate.
Shopgate Shop Number Your shop’s number at Shopgate.
Shopgate API Key Your API key assigned by Shopgate.

 

4.2 Mobile Website

Set up your mobile website and redirect.

Alias The alias is the subdomain of shopgate.com, e.g. myshop.shopgate.com, where your mobile website can be found. This is used as a fallback if no CNAME is configured.
CNAME A CNAME is a subdomain of your own domain that points to your mobile website. For example, a CNAME could look like "m.myshop.com". To configure a CNAME, please log on to your server hosting website. For more information, please read our help article Adding a CNAME record in your domain host
Language A comma-separated list of ISO 639-1 (e.g. en, de, fr) that should be redirected to your mobile website. Leave this blank to redirect all languages.
Type Redirect users via HTTP-Header if possible - it’s fastest and best for search engines. If you experience trouble using HTTP-Header redirect, try JavaScript.

 

5. Frequently Asked Questions (FAQ)

5.1 A "system health check" notice appeared after I installed the Shopgate plugin. What should I do?

As shown in the graphics below, the collations of some fields are incorrect.

To fix this, please navigate to Service > Tools to execute the following SQL commands.

  • For systems that work with ISO:
    ALTER TABLE `oxordershopgate` CHANGE `OXID` `OXID` CHAR( 32 ) CHARACTER SET latin1 COLLATE latin1_general_ci NOT NULL;
    ALTER TABLE `oxordershopgate` CHANGE `OXORDERID` `OXORDERID` CHAR( 32 ) CHARACTER SET latin1 COLLATE latin1_general_ci NOT NULL;
    ALTER TABLE `oxordershopgate` CHANGE `order_number` `order_number` VARCHAR( 20 ) CHARACTER SET latin1 COLLATE latin1_general_ci NOT NULL;
  • For systems that work with UTF-8:
    ALTER TABLE `oxordershopgate` CHANGE `OXID` `OXID` CHAR( 32 ) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;
    ALTER TABLE `oxordershopgate` CHANGE `OXORDERID` `OXORDERID` CHAR( 32 ) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;
    ALTER TABLE `oxordershopgate` CHANGE `order_number` `order_number` VARCHAR( 20 ) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL;

 

5.2 How do I know if my OXID system works with UTF-8 or ISO?

Navigate to Service > Systeminfo. You should find a table that contains iUtfMode .

In the column on the right side of your page you can see the number 0 or 1.

  • If you see the number 1 in this column, your system works with UTF-8.
  • If you see the number 0 in this column, your system works with ISO.

Comments