Support Center

Connecting to X-Cart

Follow

 

X-Cart is available as a shopping cart system at Shopgate.

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

 

Support

Version

 

5.1 +

Import to X-Cart

Orders

 

Customer Account

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

 



✘ / ✘

Export to Shopgate Mobile Shop

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

N/A

Notes

If you use X-Cart version 5.0 or lower, please contact X-Cart for support.

 

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

 

Topics covered in this article:

  1. Installing the Shopgate Plugin
  2. Establishing connection between the plugin and the Shopgate system
  3. Updating an existing Shopgate plugin
  4. Configuring the Plugin

 

1. Installing the Shopgate plugin

The installation of Shopgate's integration module for your X-Cart 5 shop may require some adjustments to your system. If you have any questions or experience installation obstacles, please contact X-Cart support team.

To install the Shopgate plugin for your X-Cart shop, please follow the steps below:

  1. Log in to your X-Cart admin page.

  2. Select Extensions > Marketplace from the top right drop-down.



  3. You will see the Shopgate plugin listed on Modules Marketplace page. Click on the Shopgate plugin to go to installation page.



  4. Check the Install checkbox, and click on Install modules.



  5. Agree to the Modules license agreement, and click on Install add-on. This will start the installation. Wait for it to finish.



  6. That's it! Now the Shopgate plugin has been successfully installed.



To configure the plugin, click on Settings next to the Shopgate logo to open the "Shopgate - Mobile Commerce" module settings. Sign up at Shopgate for free by clicking the sign up button at the bottom of the page. For existing Shopgate users, click Connect my Shopgate with X-Cart. Leave this page open - we will explain how to find the required info in the next chapters.

 

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, type X-Cart and select it.



  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, and Alias, and paste them individually onto the plugin configuration page you left open from the last chapter.
    Copy the URL at the bottom of the page to a text editing file - you will need this in the next step.
    The rest of the options can be configured later. This is explained in Chapter 4. Configuring the Plugin). Click Submit.

 

2.2 Connecting your shop to Shopgate

  1. Go back to the pop-up window at your Shopgate merchant page (step 4). Paste the URL copied from the last step to the text field under 3. Enter URL. Click connect to establish the interface.



  2. If a connection is made successfully, a popup shown below will open. Here you will be able to assign jobs for your first connection. We recommend to leave all assignments to ON at this time. 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 

  1. If the update is available for your Shopgate module you should see a green rectangle area with the available new version. Click "Update module".



  2. You will be taken to the "Update your version" page. On this page you will see all modules that have new version available and can be updated. Click "Install updates" to proceed with the next step.



  3. On the page confirm the update by clicking "Continue". After that X-Cart will download update packages from the marketplace. This can take some time. After packages are downloaded you will be redirected to the next page.

  4. Save the links that are listed on the page because you will need them in case update script gets interrupted or update fails for some other reason. After you click "Install updates" button X-Cart will finalize the installation and re-generate the X-Cart cache files.

  5. After all is finished you will be redirected to the admin area of your X-Cart store.

 

4. Configuring the plugin

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



Customer number

Your customer number which is presented to you every time that you create an interface in the Shopgate merchant area.

Shop number

The shop number of your mobile store, provided by Shopgate.

API key

This is the “password” that the plugin uses to be able to communicate with the Shopgate-MerchantAPI on a secure channel.

Server type

Select the type of the Shopgate server that you want to use (live or playground).

Encoding

The encoding type that is used in your X-Cart store.

 

4.1 Products export options

Export language Choose the language the products should be exported in.
Currency for export Choose the currency your products should be exported in.
Fallback Manufacturer

Default manufacturer name for products that do not have manufacturer configured.

Weight units for Shopgate export

Weight units that will be used when product is exported to Shopgate. If current store unit is different form selected weight unit then automatic conversion will be used.

Membership restriction for Shopgate export

In X-Cart you can assign membership level to products and customize access to products and categories for customers based on their membership level.

Since Shopgate does not have such functionality you can choose membership level for products and categories that you want export to Shopgate in order to restrict access to catalog elements you do not want to be available to all customers in Shopgate.

Available text for in stock products

Text that will be displayed on the product page for products that are in stock. Please do not leave blank.

Available text for out of stock products

Text that will be displayed on the product page for products that are out of stock. Please do not leave blank.

 

4.2 Mobile Redirect-related options

Use default mobile skin

Uncheck this box to redirect mobile users to your mobile website. Select this option only if you have your own customized mobile skin, or you're only using Shopgate mobile apps.

CNAME

A CNAME is a subdomain of your own domain that points to your mobile website. Usually that’s something like m.myawesomeshop.com. You’ll have to configure this on your server.

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.

 

4.3 ShopGate API entry point

Shopgate API entry point URL

This URL is used to connect your X-Cart shop backend to Shopgate's API.

Comments