Table of contents
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.
Interface features
- 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)
Connection
Create new store
Under Administration → Shop interface → Overview → NEW you can select the Gambio Shop.
Note: Until version 21.1 it's via Administration → Online Shops → NEW.
Enter interface data
Under Details → Interface you can then enter the corresponding data from the from the Gambio backend.
Settings for store or marketplace
- Logging to the log file: When working with the store interface, stores store data in a log for troubleshooting purposes.
- 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"
Check connection
Please note that the connection will not work if the store is in maintenance mode.
Transfer orders to Xentral
Importing jobs from the store to Xentral is described in this article.
Export articles to Gambio
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.
Transfer essential features
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.
Export of article properties
In Xentral item properties can be transferred to Gambio, for this purpose Xentral needs the database access data of the Gambio store, because the Gambio API does not support this function.
The database path must be specified without http: and without port.
Establish database connection to Gambio (for technicians)
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:- Item export: Properties transfer
- 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 1. 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. 2. 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.
Technical Documentation
Status of orders
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
Import PayPal payments
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).
Troubleshooting
If Xentral reports that there are no orders in the store, although there should be some 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/...