For the complete documentation index, see llms.txt. This page is also available as Markdown.

Field Reference: Configuration

This reference describes all setup fields of the Shopware configuration (the "Shopware Configuration Card" page) in the Shopware 6 API Connector for Business Central. The configuration is divided into several areas (FastTabs). Use this page as a complete reference; the functional chapters in the "Configuration" section explain the relationships in detail.

Field captions may differ slightly depending on the language version. Where helpful, the technical field name is given in parentheses so that you can identify the field unambiguously.

Shopware information (connection)

Basic connection and access data for the Shopware 6 shop.

Field
Meaning

Web Store Code

Internal code of the configuration (primary key).

Web Store Name

Unique, descriptive name of the shop.

Website URL

Base URL of the Shopware shop. A trailing / is removed automatically.

API Base Path

API module path, /api by default. A leading / is enforced.

Integration Access

Switches the authentication mode: enabled = integration access (client credentials), disabled = admin user (user name/password).

User Name

Depending on the mode, the user name (admin) or the client ID (integration).

User Password

Depending on the mode, the password or the client secret (stored masked).

Developer Log

Writes complete API requests and responses (JSON) to the API Call Log – ideal for error analysis.

isActive (Enable)

Master switch: enables or disables the entire connection.

Order Settings

Controls the order download from Shopware and the document creation in Business Central.

Field
Meaning

Allows Ord Download

Allows orders to be downloaded from Shopware.

Download Order As

Target document type in BC: Quote, Order, or Invoice.

Generate Sales Order

Automatically creates the BC sales document during download.

Create Unknown Item

Automatically creates unknown items during order import (using an item template).

Price Included Tax

Treats order prices as including VAT.

Use Shopware Price

Uses the Shopware price from the order instead of the BC customer price.

Shopware Opening AutoIncrement

Start value for the incremental order download (set once; see "Auto-Increment & Incremental Download").

Ord Download Location

Location that is entered in the sales documents that are created.

Sales Ord No.Series

Number series for web orders.

Tax (subgroup)

Field
Meaning

Use VAT

Uses VAT instead of sales tax.

Bus. Posting Group

Business posting group (VAT or Gen. Business Posting Group).

Prod. Posting Group

Product posting group for order lines.

No Tax Group Code

Tax-exempt group for tax-exempt lines.

Shipment & order status (subgroup)

Field
Meaning

Allows Shpmnt Upload

Allows the shipment status to be reported back to Shopware.

Ord Status On Shipment

Shopware order status that is set once the shipment has taken place (selected via the state machine).

Ord Status on Invoice

Shopware order status once the invoice has been issued.

Send Order Status Email

Triggers a Shopware customer notification when the status changes (sendMail).

Inventory Settings

Master switches and detailed options for uploading items, inventory, and standard prices.

Field
Meaning

Upload Items

Master switch for the item upload.

Upload Inventory

Master switch for the inventory upload.

Upload Neg. Qty

Transfers negative inventory; otherwise 0 is sent.

Use Default Stock

Uses a fixed inventory value instead of the locations.

Default Quantity

Fixed inventory value when "Use Default Stock" is enabled.

Inventory Location Ids / Name

Comma-separated BC locations whose inventory is totaled.

Upload Reg. Price

Transfers the standard/regular price.

Default Price List Code

Default price list used as the source of the product price.

Prices Are Gross

Treats BC prices as gross prices.

Price API Limit

Maximum number of prices per API request (bulk upload, default 1).

Upload Category

Enables the category upload.

Upload Tags

Enables the tag upload.

Item Template

Item template for automatically created, unknown items.

Weight in Kg

Transfers the weight in kilograms (otherwise grams).

Parent Category ID

Root category ID in Shopware (can be selected via AssistEdit).

Default Tax ID

Fallback tax ID if no mapping applies.

Picture Folder ID

Media folder ID in Shopware for uploaded images.

Customer Settings

Behavior when creating and assigning customers during order import.

Field
Meaning

Create Unknown Cust.

Automatically creates unknown customers.

Create Guest Customer

Creates a customer for guest orders.

Default Guest Cust.

Default/collective customer for guest orders.

Default Logged Cust.

Fallback for logged-in Shopware customers without a BC assignment.

Cust. Template

Customer template for new records.

Customer Default Password

Default password for customers newly created in Shopware.

Shopware Payment Method ID

Default payment method (selected from the payment mapping).

Cust. Mapping Type

Matching logic during download: by email/phone, email only, phone only, or mobile only.

B2B Contacts

Settings for uploading contacts as B2B users (Shopware B2B/Commercial).

Field
Meaning

Upload Contacts

Enables the upload of contacts as B2B users.

B2B Language ID

Language ID for newly created B2B users.

B2B Role Freigabe ID

Shopware role ID for the "Approval" role.

B2B Role Besteller ID

Role ID for the "Buyer" role.

B2B Role Anzeige ID

Role ID for the "View" role.

B2B Email Fallback Domain

Substitute domain used to build a login email address if no email address is stored.

Shipping

Posting of the shipping costs from imported orders.

Field
Meaning

Shipping Charge Type

Posting as an Item or a G/L Account.

Shipping Charge Code

Item used for shipping costs (with the "Item" type).

Shipping Charge G/L Account

G/L account used for shipping costs (with the "G/L Account" type).

Shopware modules (Premium)

Additional functions that require a Shopware plugin.

Field
Meaning

Allows Invoice Upload / Enable Document Upload

Upload of documents (PDF) to the customer account.

Enable PDF Doc Upload

Automatic PDF generation from BC documents.

Enable Grouped Products

Enables group items (plugin required).

Enable SharePoint Docs

Attaches SharePoint documents to products.

MODUS Auth. Code

Authorization code for the MODUS M365 connection.

SharePoint Site Host / Path / Doc Library

Target storage location in SharePoint.

SharePoint Folder Pattern

Folder pattern, for example {ItemNo}.

SharePoint File Filter / Exclude Filter

Inclusion and exclusion filters for files.

SharePoint Tenant / Client ID / Client Secret

Azure AD access as a fallback.

AI / Copilot (AI Configuration)

Connection to an AI service for text generation.

Field
Meaning

AI API Key

Key for the AI service.

AI API URL

Endpoint of the AI service (default: OpenAI).

AI Model

Model used (default: gpt-4o-mini).

Other

Field
Meaning

Product Properties Json

Fixed product properties that are passed to every product as JSON.

Actions on the configuration card

The configuration card brings together numerous actions. The most important ones at a glance:

Processing

Action
Function

Mapping

Opens the mapping page (all mapping modules).

Download Initial Data

Loads payment/shipping methods, taxes, tax rules, currencies, sales channels, customer groups, salutations, countries, languages, and state machines from Shopware.

Test Connection

Retrieves a token and thereby checks the connection.

Show Password

Displays the stored access data.

Sync management

Action
Function

Open Price List Overview

Opens the price list overview.

Mark All as Web Items

Marks items that have a picture, as well as all categories, as web objects.

Mark All Items UnSync

Sets all items (optionally including price lines) to "not synchronized".

Mark All Prices Unsynced

Sets all web price lists to "not synchronized".

Delete Orphan Prices

Removes orphaned Shopware prices that have no BC assignment.

Reset data

Action
Function

Reset ALL Shopware Data

Resets all links (Web IDs).

Reset & Sync All Mappings

Deletes mappings, resets master data IDs, and reloads the initial data.

Reset Tax / Customer Mappings

Resets the tax or customer mappings.

Reset Items / Categories / Customers / Sales Price List

Area-specific reset.

Reset Unit / Attribute / Manufacturer IDs

Resets the respective Web IDs.

Delete Web Items

Deletes products, parent items, and images in Shopware.

Delete Activity Log

Clears the API Call Log and the API responses.

Orders

Action
Function

Download Orders

Starts the order download report.