Legacy module
The module described in this article has been marked as a legacy module. This means the following:
-
We don't create new features for this module or fix any bugs.
-
The module is not available anymore in Xentral instances (demo or licensed) created after 28-Sep-2022. If you as a new user have special requirements that could only be fulfilled by this module, please contact our customer support team to discuss a solution.
For more information, see also Why is Xentral deprecating some modules and what does this mean for you?
With this interface you can connect Xentral to Gambio to import orders from there into Xentral and manage your items sold in the store in Xentral. The connection is done via an API interface (store importer).
Note
Currently we support a rudimentary feature set for the Gambio Importer. A connection to Gambio Cloud is not possible. At the moment only the order import is possible, an article creation and stock number comparison is not possible.
-
Pick up orders from Gambio
-
Change order status on shipment in Gambio incl. message tracking number
-
Transfer items one by one from Xentral to Gambio or from Gambio to Xentral (currently not possible for variants 06/21)
-
Transfer article categories as well as article properties from Xentral to Gambio (currently not possible for variants 06/21)
-
Transfer stock figures as well as pseudo stock figures to Gambio (currently not possible for variants 06/21)
In the Gambio backend, you can create an API user. In this way, you create and get access to the credentials - user, password and API URL - that you will later need to define for the configuration of the Xentral connection. You can get credentials from your web hosting service provider.
Under Administration → Shop interface → Overview → NEW you can select the Gambio Shop.
Note
Until version 21.1 it's via Administration → Online Shops → NEW.
Under Details → Interface you can then enter the corresponding data from the from the Gambio backend.
If Xentral reports that there are no orders in the store although there should be you can check the following points:
-
Logon data incorrect
The importer does not report back that the credentials are incorrect. If a login in the Gambioshop as admin is possible, it is to be assumed that the data is correct.
-
Missing logfiles folder
During the installation of Gambio for some reason, no logfiles folder was created. This can be created later, best via FTP. Since Gambio tries to log on via the API in the log file in this folder, an error occurs which causes the login to fail. The response XML contains in this case no SessionID and the wording:
...ErrorException'. with message 'file_put_contents(/var/www/vhosts/webshop.com/httpdocs/logfiles/xml.log): failed to open stream: No such file or directory in /var/www/vhosts/webshop.com/httpdocs/system/classes/gambio_xml/...
When you open the Gambio connection in Xentral, you will see the Details > Connection tab.
Settings:
-
Designation → Name freely selectable for the shop (will be displayed e.g. in the product and in the import menu)
-
Active → Check the box to make the interface active. You can set interfaces that are no longer needed to inactive
-
Project →Link the shop to a particular project. In the project, you can define the logistics-related settings.
-
Fetching mode → For Gambio, you can define the fetching to happen for a specific status.
-
Import mode → Define if orders are to be imported manually (when you trigger it) or automatically
-
Demo (for testing) → The order status will not be changed, no articles or stock numbers will be transferred
-
Manually (via import center) → Orders are only imported when you click the Fetch orders button
-
Automatically (as specified by a process starter) → The orders will automatically be fetched from the shop. For this, the process starter shopimporter must be active.
-
-
Only 1 order per request → Only 1 order per request is transferred from the store
-
Orders in intermediate table → When picking up the orders, the orders are not created directly, but first stored in an intermediate table for review. Here you can decide which orders should be created and which should be imported later.
-
Limit the number of retrieved orders → The number of retrieved orders is limited here, 0 means that a maximum of 100 orders are retrieved.
-
Logging in the logfile → Creates entries in the logfile when activated. This makes it easier to find the cause in case of an error afterwards
-
User → The user who has access to the API must be entered here. Usually an administrator
-
Password → The password for the API user must be entered here.
-
API Url → https://ihreshopurl/api.php/v2 (Please pay attention to http or https)
-
Move article to appropriate category → Relevant for article export Xentral → Shop. If not set a collective category will be used in Gambio.
-
ID Tax Class Normal → Tax classes according to Gambio setting.
-
ID Tax class Reduced → Tax classes according to Gambio setting.
-
ID Tax class Exempt → Tax classes according to Gambio setting.
-
Status name order open → The name of the status in the store to represent open orders.
-
ID Order in process → Here you have to enter the ID, to which Gambio sets the order to the status "in process".
-
ID Order completed → Here you have to enter the ID, to which Gambio sets the order to the status "completed"
-
Database path → You can get this information from your web hosting provider
-
Datebase name → You can get this information from your web hosting provider
-
Database user → You can get this information from your web hosting provider
-
Database password → You can get this information from your web hosting provider
-
Connect via ODBC → In case you want to establish the connection via ODBC
-
Deviating ODBC connector → You get this information out of the ODBC settings. Connections between Xentral database and shop can be encrypted.
Actions:
-
Check connection → Here you can check the correct connection to Gambio.
Please note that the connection will not work if the store is in maintenance mode.
-
Fetch orders → Fetches all orders from the store that match the settings. The button must be pressed only in manual import mode.
Note
You should also make sure that the status messages for "Order open", "Order in process" and "Order ready" are unique. You should not use the same status in several places.
-
Shop import intermediate table → Jumps to the intermediate table of orders from the shop. The intermediate table is filled only in manual import mode and if the 'Orders in intermediate table' option is enabled.
In the intermediate table, in the left column, you select between Import, Trash, and Later:
-
Import: The order is imported directly
-
Trash: Order is put into the trash bin and cannot be imported again.
-
Later: order can be imported at a later time.
-
-
Pick up item list → Imports items from your Gambio store to xentral. Store items that were already in xentral will be updated, missing items will be created. The items will be gradually fetched by the Item Import process starter after the action is executed.
Other tabs:
For more information about settings in the other tabs, please refer to Online shops.
For the Free fields tab, be aware that every product in Gambio might need to have information in the Essential Features field. You can fill in this information during the product export from Xentral to Gambio: After you have created a corresponding free field with products, you can use this free field during the free field mapping of the shop connection to map onto the field checkoutinformation. Below you will find more information about the Essential Features.
Important
Subshop (subshop mapping) and Group mapping are not available for Gambio.
Importing jobs from the store to Xentral is described in this article.
The following information of an item can be transferred to Gambio:
-
Essential Characteristics → A free field can be created in the article in Xentral, the content of which will be transferred to the Gambio "Key features" field (checkout information). Gambio (instructions below).
-
Manufacturer → Manufacturer of the item. Is newly created in the store if specified in the article, but does not yet exist in the store.
-
Manufacturer link → Manufacturer link of the article. For German and English the same link is transferred here.
-
Item image alternative description → Comes from the image description in Xentral. The same text is transferred here for German and English.
Gambio may require each item to have information in the "Key Features" field. To populate this field through the article export from Xentral to Gambio you can create a free field in the store interface and map it to the checkout information field.
-
Create a free field in the article and fill it with the information that should be in the "essential characteristics" in the Gambio. If you want to show a different store, create an English translation of the free field as well.
-
Map the free field in the store interface under "Free fields" to the "checkoutinformation" from Gambio.
-
In Gambio, the content of the free field now appears under "key features" of the article.
General information about stock number sync and order import is available in the following help center article: Online shops
Be aware that the capabilities of the various shop connections with Xentral differ widely. The shop matrix provides detailed information about the capabilities of each shop connection. It is available under Shops and Marketplaces > Shop functions.
For some features of the Gambio interface a direct connection to the shop's database, because the REST API of Gambio does not provide these functions.
A database connection is required for the following functions:
-
Article export: Transfer article properties
-
Article export: Transfer variant articles in correct variant structure
-
Order import: article number for variants
-
Order import: Customizer data for articles
-
Order import: transaction number
To connect your store database with Xentral you can do it in two ways
-
Open the database to the outside: The Gambio Shop database can be opened for external access. If the database of the store is accessible from the outside, or is located in the same network as Xentral, the database access can be realized via board means. For this purpose it is sufficient to maintain the fields for database access accordingly.
-
Encrypted access to the database via ODBC: If the store database is not directly accessible from the Xentral system, or if it is not possible or desired to open the database to the outside, a connection via an ODBC connector can be established instead. In addition to the the database access data, the path to the ODBC connector must be entered, which is to be used.
When the data has been entered and saved, you can ensure that the database connection is correct by clicking on "Check connection" to make sure that the database connection can be established correctly.
If your system is installed on the Xentral Cloud, all you need to do to use the ODBC connector is to activate the checkbox "Connect via ODBC". The connector is already stored on the cloud for all installations.
If the Xentral installation is not hosted on the cloud, the ODB connector may need to be may installed manually. In addition, the local path to the driver in the importer settings. Here you can find instructions for an exemplary procedure: https://putokaz.wordpress.com/2018/02/12/how-to-install-the-mysql-odbc-driver-on-ubuntu-16-04-or-linux-mint-18-x/
After the settings have been saved, you can check whether the connector is working by clicking on "Check connection" to check if the connector is working. Any error messages from the Connector are passed on directly by the Importer.
All orders with order status "1" (in the standard system this is "open") are collected via the API. This is "open" / as of 12/2016). The table for the statuses in Gambio can be found here: orders_status
If orders are imported from the Gambio store with the payment method PayPal, please note the following:
When importing a store order, the following transaction number is also transferred. (depending on the settings of the store one of the two number types can be transferred to the field "Transaction" to Xentral):
-
PayPal: Transaction number (Transaction ID) -> Normal PayPal account without PayPalPlus -> the regular transaction number will be transferred, this will be mapped to the account statement. (in the bank statement the transaction number will also appear)
-
PayPal Plus: PAYID → PayPalPlus account → The PAYID (instead of the regular transaction number), which is then mapped to the bank statement. The account statement contains the transaction number, Xentral fetches the PAYID in parallel. the PAYID via the bank connection, so that this number guarantees a successful payment mapping).