Shopware 6 Setup
Central setup page for the Shopware 6 Connector. Here you configure the direct API connection to the shop (OAuth2 Client Credentials), default values for order import, item synchronization, taxes, currencies, and custom fields.
Communication with the Shopware 6 shop is direct via the Shopware 6 Admin API — no middleware required.
Opening the Page
- Via search: Shopware 6 Setup
- Via the Shopware 6 Dashboard → Action Setup
- Via the merchantCENTRAL Dashboard → Shopware 6 → Setup
Fields
API Configuration
Connection details to the Shopware 6 shop. Authentication uses OAuth2 Client Credentials.
| Field | Description |
|---|---|
| API URL | Base URL of the Shopware 6 shop, e.g. https://myshop.com. All API calls go directly to this URL. |
| Access Key ID | API access key from the Shopware integration. Stored encrypted in IsolatedStorage and displayed as ***. Must be created in the Shopware Administration under Settings > System > Integrations. |
| Secret Access Key | Secret API key of the Shopware integration. Stored encrypted in IsolatedStorage and displayed as ***. |
Security Notice
All credentials (Access Key ID, Secret Access Key, and OAuth2 Access Token) are stored in IsolatedStorage using the SecretText data type. Credentials are never stored in plain text in the database. The display always shows *** — only when changed is the new value applied.
Order Import
Settings for automatic order import from the Shopware 6 shop.
| Field | Description |
|---|---|
| Order Import Enabled | Enables automatic order import via the Job Queue. When disabled, no new orders are imported from the shop. |
| Max Orders Per Run | Maximum number of orders imported per Job Queue run. Default: 15. A lower value prevents timeouts with large order volumes. |
| Order Date Filter | Earliest order date for import. Orders before this date are ignored. Useful to restrict the import to a specific time period. |
| Missing Item Substitute | G/L Account No. used as a substitute when a Shopware item cannot be mapped to a BC item. Prevents errors during order import. |
| Suppress Status on Ship | When enabled, no automatic status update is sent to the Shopware shop upon shipment posting. Useful when the status should be updated manually or through a different workflow. |
Shipping Costs and Payment Methods
Shipping costs are configured centrally in the merchantCENTRAL Hub (charge item or G/L account). Payment method mappings are configured via the Hub table Payment Mapping for marketplace code SHOPWARE6. Discounts and promotions from Shopware are automatically imported as discount lines.
Item Settings
Default values for item synchronization.
| Field | Description |
|---|---|
| Item Sync Enabled | Enables automatic item synchronization via the Job Queue. |
| Price Sync Enabled | Enables automatic price synchronization via the Job Queue. |
| Inventory Sync Enabled | Enables automatic inventory synchronization via the Job Queue. |
| Default Tax ID | Default tax UUID in the Shopware shop. New items are created with this tax class. Can be automatically determined via the Fetch Shop Defaults action. |
| Default Tax Rate | Default tax rate in percent (e.g. 19). Used together with the Tax ID to find the matching tax rate during automatic detection. |
| Default Currency ID | Default currency UUID in the Shopware shop. Can be automatically determined via the Fetch Shop Defaults action (searches for EUR). |
| Price List Code | Customer price group code (e.g. SHOP) from which sales prices for the shop are read. If empty, the default price SHOP is used. |
| Sales Channel ID | Default sales channel UUID. Used for SEO URLs and channel-specific features. Can be populated automatically via the Sync All Master Data action. |
| Description Template | Default description template for automatic HTML description generation. Can be overridden per item. |
Custom Fields
Up to 4 custom fields that are transferred to the Shopware shop during item upload.
| Field | Description |
|---|---|
| Custom Field 1 Name / Label | API name and display name of the first Boolean custom field. The API name must match the custom field configuration in Shopware. |
| Custom Field 2 Name / Label | API name and display name of the second Boolean custom field. |
| Custom Text 1 Name / Label | API name and display name of the first Text custom field. |
| Custom Text 2 Name / Label | API name and display name of the second Text custom field. |
Status
Read-only status information about the last synchronization.
| Field | Description |
|---|---|
| Last Order Sync | Timestamp of the last successful order synchronization. |
| Last Item Sync | Timestamp of the last successful item synchronization. |
| Last Sync Error Message | Last error message from a synchronization. Displayed in red if an error exists, otherwise in green (no error). |
| Last Sync Error DateTime | Timestamp of the last synchronization error. |
| Token Expiry | Expiration time of the current OAuth2 access token. Managed automatically — a new token is requested upon expiration. |
Actions
| Action | Description |
|---|---|
| Test Connection | Tests the connection to the Shopware 6 shop in two steps: (1) basic reachability via /api/_info/version, (2) fully authenticated API call via OAuth2 (/api/_info/config). On success, a confirmation message is displayed; on failure, the HTTP status message is shown. |
| Sync All Items | Downloads all products from the Shopware 6 shop and updates the local item records. A confirmation dialog appears before starting and a 3-line progress dialog during processing. |
| Sync All Master Data | Performs a complete master data synchronization: tags, categories, manufacturers, properties, units, currencies, tax rates, payment methods, and sales channels are downloaded, missing BC entries are filled, and marked entries are pushed to the shop. |
| Fetch Shop Defaults | Automatically determines the default tax ID (matching the configured Default Tax Rate) and the default currency ID (EUR) via the Shopware API and populates the setup fields. |
| Init Shop Price List | Creates or updates the BC price list from all Shopware 6 item prices. Useful for initial price alignment after first setup. |
| Create Job Queue Entries | Creates the default Job Queue entries for automatic synchronization (order import, item sync, price/stock update, status check, WorkQueue processing). A confirmation appears after creation. The entries must then be activated in the Job Queue management. |
Initial Setup (Step by Step)
- Create Shopware Integration: In the Shopware Administration under Settings > System > Integrations, create a new integration and copy the Access Key ID and Secret Access Key.
- Enter API URL: Enter the base URL of the shop (e.g.
https://myshop.com). - Enter Credentials: Enter Access Key ID and Secret Access Key in the corresponding fields.
- Test Connection: Verify the connection — the message "Connection successful" confirms successful authentication.
- Set Default Tax Rate: Enter the default tax rate (e.g.
19for 19% VAT). - Fetch Shop Defaults: Automatically retrieve the default tax ID and currency ID (EUR) from the shop.
- Sync All Master Data: Synchronize all master data (tags, categories, manufacturers, units, currencies, taxes, payment methods, sales channels).
- Payment Method Mapping: In the merchantCENTRAL Hub under Payment Mapping, assign Shopware payment methods to BC payment terms.
- Create Job Queue Entries: Set up automatic background processing.
- Activate Job Queue: Activate the created Job Queue entries in the BC Job Queue management.