Authentication to the Online Shop
Here you will find all the information you need for the initial setup of the Shopware API Connector.
1. Initial Setup
As soon as the Shopware 6 API Connector is installed on your Business Central system, the connection to the online shop can be established.
You will notice that a new tab has been added to Business Central. When you select the "Shopware" tab, a submenu opens:
After you select the "Configuration" tab, the menu opens in which you can both establish the connection to Shopware and define many additional settings. To edit them, you must switch to edit mode, which you will find at the top center of the window (the pencil icon):
You can then edit all settings.
1.1 Initial Configuration
The following information, which you will find under "Shopware Information", is required for the initial setup:
Web Shop Code A code used internally by Business Central that uniquely identifies your shop.
Web Shop Name A descriptive name for your online shop.
Website URL The URL of your Shopware shop, including https://
API Module Path As a rule, the path ends in /api
Integration Access Here you define how the connection between Business Central and Shopware is established. YES A "Shopware Access Key ID" and a "Shopware Secret Access Key" are required. NO You need a "Shopware User Name" as well as the corresponding "Shopware User Password" with administrator permissions.
Enable Developer Log YES Only required if errors occur during sync, for example because data does not reach the shop or arrives incorrectly. The developer log shows exactly which API calls are made and where errors occur.
Enable Determines whether the shop is active (YES) or not (NO). This setting is particularly relevant for multi-shop scenarios (COMING SOON).
If you would like to use the integration access instead of a user name and password, you can create it in the Shopware back end:
Settings Users & permissions select an administrator create a new access key under "Integrations".
1.2 Establishing the Connection
You can then run a connection test. Click "Test Connection". If all data has been entered correctly, a success message appears.
If an error message appears, there can be several causes.
Check whether all fields have been filled in correctly.
Try a different Shopware administrator user or a different version of the "Integration Access".
Check whether your server permits the connection. Special server configurations are a common cause of failed connections between Business Central and Shopware.
If your shop is still under development, make sure that no password protection is active.
2. Initial Download
The initial download transfers all relevant data from Shopware to Business Central and is required in order to map the values between the two systems correctly.
You are still in the Shopware configuration. Before the initial download is possible, two important values must be filled in. You will find them under "Inventory Configuration":
Parent Category ID
Image Folder ID
2.1 Parent Category ID
The "Parent Category ID" determines which categories are imported from Shopware and where newly created categories are added. You will find the ID in Shopware. To do so, switch to the back end of your Shopware shop.
Under the "Catalogues" "Categories" tab, select the category that you want to define as the parent category. As a rule, this is the top level, or "Home".
Select this category.
In the URL you will now find a long ID consisting of letters and numbers between two slashes. Copy it and paste this ID into Business Central.
2.2 Image Folder ID
Proceed in a similar way for the "Image Folder ID". First switch to the back end of your Shopware shop.
Under the "Content" "Media" tab, select the folder in which the product images are to be stored. As a rule, this is the "Product Media" folder.
In the URL you will now find a long ID consisting of letters and numbers between two slashes. Copy it and paste this ID into Business Central.
2.3 Starting the Initial Download
Everything is now prepared for the initial download. Scroll back up, still in the "Shopware Configuration". There you will find the "Shopware Initial Download" tab, which you use to start it.
