Note
Xentral is compatible with all Shopware versions lower than 6.5.
With this interface you can connect Xentral to Shopware 6 to import orders from there to Xentral and manage your products sold in the shop in Xentral. The connection is realized via an API interface (Shopimporter).
-
Import orders from Shopware
-
Change order status on shipping incl. reporting tracking number to Shopware
-
Transfer payment status of orders to Shopware
-
Invoices to import orders transferred to Shopware
-
Export products incl. product data and images from Xentral to Shopware also targeted to specific sales channels of Shopware 6
-
Export product properties and free fields from Xentral to Shopware
-
Synchronization of current stock figures in case of stock changes
-
Transfer cross-selling links from product to Shopware
-
Transfer product units to Shopware
-
Transfer Search Engine Optimization (SEO) paths to Shopware
You can create invoices and delivery notes in Xentral with your own number range. The documents are automatically created and sent in the shipping process or printed on the shipping printer.
First, you have to create a user for the importer in Shopware under Settings → System → Users & Rights. It is possible to use an already existing user, but a separate user specifically for the interface to Xentral is strongly recommended.
At Administration → Shop interface → Overview → NEW you create a new shop and select the Shopware 6 module.
Note
Until version 21.1 it's via Administration → Settings → Online Shops / Marketplaces → NEW.
After you have selected Shopware 6, you can enter the necessary data for the connection of the two systems in the next step.
-
Username → username of the user in Shopware, created for the interface
-
Password → Password of the user in Shopware created for the interface was created
-
Store API URL → Shop URL + /api, e.g. http://www.meinshop.de/api
There is a difference if you use Shopware 6 Cloud, because here no user names are assigned. Here, the email address is the username.
Important:
-
In the field "Password" you enter the actual password of the user, not the API Key. The API Integration Key (API access key) from Shopware 6 can be created if necessary, but for the connection you always have to use user name and password.
-
Depending on whether the URL of the store begins with http:// or https://, the complete URL must be entered correctly. The API interface may not fully redirect from https:// to http:// or vice versa.
As soon as the data has been entered, you can test the connection by clicking the Check connection button. If the connection is successful, you will receive the message "Connection: success" or the ID and the name of the Shopware subshop.
To get started as quickly as possible, only a few settings and actions are required. What is necessary for a quick start with order import, stock number reconciliation and confirmation tracking numbers you can find out here.
This section explains the possible settings in the shop interface.
When you open the settings of the Shopware 6 interface, you will first land in the tab Details → Interface.
Settings:
-
Designation→ Name freely selectable for the shop (will be e.g. displayed in the product and in the import menu)
-
Active→ Check to make the interface active is active. You can set interfaces that are no longer needed to inactive.
-
Project→ Linking the shop to a project. In the project you can set the logistics settings
-
Pickup mode→ Shopify lets you pick up here from a certain pick up date
-
Import mode→ Defines whether the orders from the shop should be imported manually (by pressing a button) or automatically.
-
Demo (for testing) → The order status in the store not switched, no products or stock numbers transferred
-
Manual (with import center) → The orders are only picked up when the button Pick up orders is clicked
-
Automatically (via process starter) → The orders are picked up automatically by the shop. For this purpose, the process starter Shopimporter is required
-
-
Only 1 order per request→ Only 1 order is transferred per request from the shop
-
Orders in intermediate table→ When picking up the orders are not created directly but are first stored in an intermediate table. Here you can decide which orders should be created and which should be imported later.
-
Limit number of pickup → Possibility to limit incoming orders at once. If there is nothing (0) in it, the default limit of of 100
-
Logging in the logfile→ By setting the check mark you activate the log file and the information will be logged.
-
Store version >= 6.4.0 → Set this check mark if the version of your Shopware store is 6.4.0 or higher (this hook is only present in Xentral as of version 21.1)
-
User name → User name of the user in Shopware that was created for the interface
-
Password → Password of the user in Shopware created for the interface was created
-
Store API URL → Shop URL + /api, e.g. http://www.meinshop.de/api
-
Standard manufacturer → For the transfer of a product to Shopware, a manufacturer must also be transferred. If you have not entered a product, the importer will fall back to the manufacturer set here. By default, the manufacturer is set to "No manufacturer information" to indicate that there is no information.
-
Create manufacturer for article export→ If a manufacturer used by Xentral does not yet exist when exporting products to Shopware 6. it will be created. Otherwise, the respective manufacturer is mapped to Shopware.
-
Name of the default price group→ For the transfer of a product, a price group must be transferred. You can set the price group to be used in the shop here.
-
Xentral item properties→ You can decide whether the product properties from Xentral are created as additional fields or not transferred to Shopware.
-
Xentral article free fields→ You can decide whether the product free fields from Xentral are created as properties in Shopware or not transferred
-
Default visibility→ Sales channel name from Shopware. All products that are transferred to Shopware, but are not assigned to a specific property, are added to the default sales channel. Again, you need to be case sensitive. You can also enter multiple sales channels here, separated by commas, so that products are added to all channels by default.
-
Media folder for item images→ The folder for product images from the Shopware Shop
-
Order status to be picked up→ Xentral picks up orders that have this status in Shopware. Possible values here are open; in_progress; completed or cancelled
-
Restrict to delivery status→ Xentral only picks up orders that have the order status set in Shopware under "Order status to be picked up" status and also have this delivery status. Possible values here are open; shipped_partially; shipped; returned; returned_partially or cancelled.
-
Narrow down to payment status→ Xentral only picks up orders that have the status set in Shopware under "Order status to be picked up" and also has this payment status. Possible values here are open; paid;authorized; paid_partially; refunded; refunded_partially; reminded or cancelled. Multiple values are also allowed for the field, which are to be separated with a ";".
-
Limit to Sales Channel→ Here you can limit the importer to a specific sales channel. The ID of the sales channel by clicking on the button Check connection
-
-
Pick up number of orders→ The number of orders that are fetched from Shopware when clicking Fetch Orders.
Action:
-
Check connection→ Checks the connection between both systems
-
Pick up orders→ Pick up the orders from your store.
-
Shopimport intermediate table→ Jumps to the intermediate table of the orders from the store. The intermediate table is only filled in manual import mode and if the 'Orders in intermediate table' option is enabled.
In the intermediate table you can choose in the left column between "Import", "Trash" and "Later".
-
Import: Job is imported directly
-
Garbage: Job ends up in the garbage and cannot be imported a second time.
-
Later: Job can be imported at a later time
-
-
Transfer item tree→ Transfers the item tree from Xentral to the Shopware 6 store
-
Import old orders→ Old orders are loaded into the intermediate table, where you can decide whether the requests should be imported
You can learn more about the use of the individual actions in the section Workflows.
Information about this tab can be found here.
Information about this tab can be found here.
Information about this tab can be found here.
Free fields of a product can be transferred from Xentral to Shopware 6, if you define the additional fields in the products under "Free fields" yourself. For this option to be available, you must first create the free fields in Shopware.
The first step requires a custom field set.
In the next step you create the actual custom fields. Via the button "New additional field" you can create a new additional field.
The technical name is especially important here, because it will be needed later for the mapping.
Afterwards you can use the Free Fields tab to create a free field in Xentral to export it to Shopware.
-
Free field Xentral → Selection of the free field via drop-down menu
-
Name in store → Name of text field in shop (Technical name)
With a click on Save you create a new free field.
In the product master under parameters and free fields you can then fill the free field with a value.
The free field will be shown as follows in the shop after the product export:
Information about this tab can be found here.
Information about this tab can be found here.
In order for a price group to be transferred from Xentral to Shopware, the group must have the correct mapping to a price rule in Shopware. The name of the price rule you have to transfer 1:1 from Shopware. Xentral cannot create price rules through a product export, you have to create them in Shopware. Then you can create a price on this price group in the master data of a product and it will be exported to Shopware as a price (belonging to a price rule).
Note
Currently only EUR prices can be transferred.
A correct mapping of price groups from Xentral to price rules in Shopware 6 could look like this:
-
In the Groups module of Xentral you create two price groups.
-
In the shop interface the price groups in the "Group Mapping" tab are mapped to Shopware price rules. You have to use the exact name of the price rule in Shopware.
For comparison the pricing rules in Shopware look like this:
-
At Administration → Online-Shops / Marketplaces → Shopware 6 → Settings you have to check the box "Transfer scale prices".
You can learn more about using Smarty in this help center article: Smarty at Shopimporter.
Information about this tab can be found here.
It is possible to import procuts from the shop to Xentral.
When transferring products to Xentral, various data is imported.
This data is available for parent and variant products:
-
Product description
-
Product number, if this is set
-
Standard UK price
-
Pseudo price
-
Active/Inactive
-
Remaining quantity/sale
-
Sales tax
-
Manufacturer number
-
EAN
Note
No external numbers are needed for the product if the product numbers / SKUs are identical to the product numbers in Shopware.
This data is only available for parent articles:
-
Description
-
Weight
-
Manufacturer
-
Features
-
Free field, if the mapping is set
-
Images
-
Variants
Certain information is transferred with every import, i.e. regardless of the settings and whether the product already exists.
The following data are always transferred:
-
EAN
-
Pseudo prices
-
Active/Inactive
The remaining data is only imported for newly created products if it is specified in the importer settings that existing products should be overwritten.
The product import from Shopware 6 is to be seen as a basis for an product base only. Depending on your needs, you would have to enrich the product import accordingly via the import/export center.
A general guide on how to import products from an online shop to Xentral can be found here.
The following process starter is required to import the products: Artikelimport/getarticles. This may still need to be activated in the process starter module.
How to export products from Xentral to Shopware 6, you will learn here.
Note
In order to transfer translations into other languages to Shopware, e.g. for article names and article descriptions, you must have already created the language you want to translate to in Shopware. This can be done in Shopware in the menu Settings → Languages.
In Shopware 6 you can divide products into different sales channels in order to channel and categorize sales. To transfer products from Xentral directly into a specific sales channel of Shopware 6, you can use the product properties.
In the product under "Properties" you can create a property that must be called shopware6_sales_channel. In the value you have to specify the exact name of the sales channel to which the product should be added after export to Shopware. Please note that the name is case-sensitive.
All products that are transferred to Shopware but are not assigned by property to a sales channel are added to the default sales channel.
You can define this in the interface itself in the field "Default visibility". The name of the sales channel has to be the same as in Shopware. Please note that the name is case sensitive. With comma separated you can enter multiple sales channels here, so that products are added by default to all entered channels.
In the Crossselling app from Xentral you can link similar products or accessories. This can be done in the app itself or in the tab Crossselling in the master data of a product.
These links are exported with the product export to Shopware 6 so that the correct similar and accessory products are suggested to the end customer. In Shopware 6 you can create and name cross-selling groups for this purpose. During product export from Xentral to Shopware all assignments in the transferred products will always be deleted and completely reset. During product export the cross-selling assignment must therefore be present, because it is always refilled.
You can find this assignment in Shopware in the product under "Cross Selling" (Xentral Assignment here is a placeholder for the name of the crossselling group).
The cross-selling groups that Xentral creates in Shopware 6 are static. Accessories links are always called "Accessories" and similar products are always called "Similar". If by chance crossselling groups were already named exactly like this in Shopware, you have to rename them so that there are no conflicts during product export.
Important
In order for the cross-selling links to be transferred correctly, the assigned products must already exist in Shopware 6 and have a valid product number. If you want to export completely new products, which do not yet exist in the shop, with cross-selling links to Shopware, it is recommended that you first transfer these products completely to Shopware first and then in Xentral to create the cross-selling links for the products. Afterwards you can perform another product export.
How you can synchronize the stock figures, you can learn here.
Importing orders from online stores is described in this article.
By default Xentral imports orders with the status "open" from Shopware. 6. Another status can be picked up, if needed. You can specify that Xentral should only import orders with a certain delivery or payment status. Last but not least you can define to which status the orders should be in Shopware 6 after they have been picked up from Xentral and after they have been processed in Xentral. Cancellations can also be be reported back and set to a specific status in Shopware 6.
-
Order status to be picked up → Xentral picks up orders that have this status in Shopware. Possible values are open; in_progress; completed or cancelled
-
Restrict to delivery status → Xentral only picks up orders that have the status set in Shopware under "Order status to be picked up" and also have this delivery status, possible values are open; shipped_partially; shipped; returned; returned_partially or cancelled.
-
Limit to payment status → Xentral will only pick up orders that have the status set in Shopware under "Order status to be picked up" and also have this payment status, possible values are open; paid;authorized; paid_partially; refunded; refunded_partially; reminded or cancelled.
Warning
The statuses "for pickup" and "in process" should never be identical, otherwise the system will import the same order over and over again.
Xentral picks up all orders in the "open" order status and then sets the order status "in process" - after the goods are shipped the order status is changed to "Completely shipped". The payment status is only changed from "Open" to "Paid in full".
The only exception is in case of cancellations, i.e. when the order is cancelled before it is transferred to the warehouse, for example. Here the order status is changed to "Canceled".
Note
Currently the payment status is only reported back to the shop when the invoice for it has been created and not when the payment status has received a green payment light.
With the completion of an order in Xentral, e.g. when printing the shipping label in the shipping center, the order status in the shop is set to "completed". This also triggers the invoice for the order created by Xentral to be transferred to the shop as a PDF to the shop. You can find the invoice in the order in Shopware 6 under "Receipts".
Note
The invoice can only be transferred to the shop if it already exists at the time the order is completed. If you have configured a logistics process that an invoice document has not yet been created by Xentral when the order is completed, the invoice cannot be uploaded to Shopware. If necessary, you can still export an invoice to Shopware afterward if the action "Report store status" (action menu) is executed in the corresponding order. (action menu).
Shopware cannot transfer a COD fee separately to Xentral. Shopware has to add the C.O.D. charge to the shipping flat rate via the rule builder.
In Xentral the C.O.D. fee is then calculated from the shipping costs using the stored C.O.D. article (Shopware 6 Interface > Settings) and shown in the order as shipping costs and C.O.D. fee splitted.
From Xentral products and their properties can be transferred to Shopware 6. In the Properties tab in the master data of a product (Master data → Product → *Select product* → Properties) you can create new properties as well as translations of the properties.
It is possible to transfer several values for one property. If there are several values for a property, these must be maintained as follows.
Via "new property" you can create a new property. So that properties are transferred, it is sufficient to create a new property for products and then export it to Shopware.
Note
The delivery time will be deleted in Shopware 6 if it is left blank in Xentral.
The replenishment time can also be maintained via the properties of the product. The variable for this is "shopware6_restock_time".
In addition to the replenishment time, minimum purchase, maximum purchase and staggering can also be transferred with the following variables:
-
Minimum purchase: shopware6_min_purchase
-
Maximum purchase: shopware6_max_purchase
-
Staggering: shopware6_purchase_steps
The variable is linked to the product properties in Xentral and will only be overridden if the user explicitly creates the property in the product master data.
In Shopware products have several units, such as the unit of measurement, the sales unit, the packaging unit etc. These units can be created in Xentral as properties to fill them during the product export to Shopware. The properties must be named as follows to be assigned to the units from Shopware:
-
shopware6_unit → Unit of measurement
-
shopware6_purchase_unit → Sales unit
-
shopware6_reference_unit → Basic unit
-
shopware6_pack_unit → Packaging unit
-
shopware6_pack_unit_plural → Packaging unit plural
The entered value fills the unit in Shopware. Alternatively possible is a free field mapping in the free fields tab in the shop interface.
Product units in Xentral transfer by default to the "Unit of measurement" field of Shopware. This can be overridden with properties or a free field mapping. Then the value of the property corresponding to the Xentral unit goes into the set field.
For the "unit of measurement" there is a special feature to consider: So that it can be easily found the corresponding unit must be created in Xentral. For example "liter" it looks like this: The abbreviation of the unit must be in the "Unit" field, not the full name. This is important so that the unit is assigned to the unit in Shopware when the product is exported and is not newly created.
In Shopware 6 you can create "SEO paths" in products. These represent SEO-optimized URLs, so that the product is better found in online search engines. Per sales channel a product can have its own SEO path. These SEO paths can also be created in Xentral in the product so that they will be transferred to Shopware.
For this a property with the name "shopware6_seo_url" is created in Xentral in the product. The value stored in this property is transferred as SEO path to Shopware. If a sales channel-specific SEO path is to be transferred, the name of the sales channel must be added after a hyphen in the name of the property. e.g. "shopware6_seo_url|sales channel name". If multiple sales channel-specific SEO paths are created as properties, all of them will be transferred to Shopware.
If you create a general SEO path as well as sales channel-specific SEO paths, the specific SEO paths will be exported to the relevant sales channels. The general valid one will be exported to all other sales channels exported.
Alternatively, you can create a free field with the name "shopware6_seo_url" and to the corresponding field in Shopware 6. This can be done in the shop interface in the free fields tab.
It can happen that the payments are no longer matched by PayPal, i.e. they have a different transaction number (tracking ID) in Shopware than in PayPal. This is due to the fact that there are two types of numbers in PayPal, from which the new number is used in Shopware 6. This number can not be resolved via the old API.
You can solve the problem by entering the new access data for the PayPal API in the PayPal connection. The corresponding instructions for the PayPalPlus API are here.
The meta description can be max. 255 characters long in Shopware 6. If your meta description in Xentral is longer than these 255 characters, only the first 255 characters will be transferred. The rest is simply cut.
The shipping costs are automatically imported to Xentral as well. In Shopware you can set the shipping costs from a certain purchase amount to free of charge. After Xentral the orders with shipping costs will be imported normally with a postage item and its price. Postage free orders are imported with the postage item, but this item is listed with 0,00 EUR, so the order is postage-free for the customer.