Skip to main content

Shopware Connections and Settings

How to connect Shopware to iPaaS.com and configure the integration's subscription settings, authentication, initialization, and throttling.

The Shopware integration is a bidirectional connection between Shopware 6 (using the B2B-oriented Admin API) and iPaaS.com. It keeps commerce data in sync in both directions, covering:

  • Customers and B2B Companies, including their addresses and employee relationships.

  • Orders, Order Returns, and Order Deliveries, including line items, payments, taxes, and tracking.

  • Products, including variants, inventory, kits, property groups, scale units, related products, and catalog categories.

  • Payment Methods, Shipping Methods, Warehouses, Warehouse Groups, and Customer Groups.

Some areas rely on Shopware commercial or extension features: B2B Company and employee synchronization depends on the B2B Suite; warehouse synchronization depends on Advanced Stock Management; certain delivery and content behaviors depend on the Partial Delivery and Sales Channel Specific Content extensions; and sending per-line discount amounts from order line items requires the Discount Line Item Extension (version 1.0.0). Each of these is optional — the rest of the integration works without it, and only the dependent feature is unavailable. See the Installation Instructions for the full list of extension prerequisites. The relevant settings below note where an extension is required.

See what the Shopware integration can do →

How to Connect

Subscribers or their MiSP connect iPaaS.com to Shopware by entering the store's API URL and one set of authentication credentials. Which credentials are needed depends on the authentication grant selected in the connection settings (see Authentication Methods below).

This integration has been tested against Shopware 6.6.10.4.

Prerequisites

Before setting up the integration, ensure you have the following:

  • Administrative access to your Shopware 6 store.

  • One of two credential sets, depending on the authentication grant you intend to use:

  • For the Client Credentials grant: an Access Key ID and Secret Access Key. In the Shopware Administration, navigate to Settings > System > Integrations, create a new Integration with an administrative role, and copy the generated Access Key ID and Secret Access Key.

  • For the Password grant: the username and password of a Shopware administrator account.

For details on creating an Integration and on Shopware's API authentication, refer to Shopware's Admin API documentation.

Configuration Details

Enter the following credential fields when configuring the Shopware connection in iPaaS.com. Requiredness for several fields is conditional on the selected Grant Type.

API Url: The base URL of your Shopware store. Required.

Grant Type: Selects the OAuth grant used to authenticate against the Shopware Admin API. Valid values are password and client_credentials. Required.

ClientId: The Integration Access Key ID generated in the Shopware Administration. Required when Grant Type is client_credentials; not used for the password grant, which authenticates through Shopware's built-in administration client.

ClientSecret: The Integration Secret Access Key generated in the Shopware Administration. Required when Grant Type is client_credentials.

UserName: The Shopware administrator username. Required when Grant Type is password.

Password: The Shopware administrator password. Required when Grant Type is password.

Configure Subscription Settings

The following settings let subscribers or their MiSP tune how the integration behaves. All settings are Optional unless noted, and most have a sensible default that suits a standard configuration.

Subscription Settings page showing the Shopware integration's settings

Field

Description

Required

Example

TransferCategory

Controls whether customer categories transfer along with customers. Off by default.

No

false

CompanyAddressesAsSubsidiaries

Treats B2B company addresses as subsidiaries. Off by default. Applies to B2B Company flows.

No

false

TransactionPollSearchDays

The look-back window, in days, used when polling Shopware for transactions. Set to a window appropriate for your order volume.

No

30

DoNotUpdateOrderPaymentStatuses

A comma-separated list of exact Shopware payment status names. If an order's payment already holds one of the listed statuses, an inbound status update leaves it unchanged — use this to protect payment statuses you manage manually in Shopware. Leave blank to allow all payment-status updates.

No

Paid, Paid (partially)

DoNotUpdateOrderDeliveryStatuses

A comma-separated list of exact Shopware delivery status names. If an order's delivery already holds one of the listed statuses, an inbound status update leaves it unchanged — use this to protect delivery statuses you manage manually in Shopware. Leave blank to allow all delivery-status updates.

No

Shipped, Shipped (partially)

TrackingUpdateDefaultDelivery

Controls whether inbound status updates apply to an order that has a single delivery. Orders with more than one delivery always receive delivery-status updates; when an order has just one delivery, that delivery is updated only if this setting is true. A store whose orders normally have one delivery must set this to true to receive delivery-status updates from iPaaS.com. Off by default.

No

true

Product Content Processing

Splits sales-channel-specific content into the dedicated content entity. Requires the Sales Channel Specific Content extension.

No

false

Transfer Kits using API Extension

Sends product kits through the Bundle API extension instead of native cross-selling. This is also the only mode that allows a single product to carry both related products and a kit. Off by default (native cross-selling is used).

No

false

Order Status Post Transaction Add

Sets the Shopware order's status once, when the order is first transferred to iPaaS.com from Shopware (the order's initial outbound transfer); it is not re-applied on later updates. This sets the Shopware order state, not the payment status. The value must be a valid Shopware order status that is an allowed transition from the order's current state; if it is not, the transfer fails and an error is recorded in Dashboard / Integration Monitoring / Error Logs. Leave empty to make no post-creation status change.

No

In Progress

Additional Error Hide

Suppresses additional error detail. Off by default.

No

false

Translations Enabled

Lets the integration send per-language translated values for product, variant, property-group, and category content. To use it, add custom fields on the source record named TranslationField_[localeCode]_[fieldName] (standard fields) or TranslationCustomField_[localeCode]_[customFieldName] (custom fields), using the Shopware language's locale code such as de-DE, and map them so their values are sent; see the Product and Catalog Category mapping documentation for details. Off by default.

No

false

Returns Core or Proxy API

Selects which API path is used for order returns. Choose the path that matches your store configuration.

No

Core

Index Behavior Header

Sends an indexing-deferral header on writes to improve performance during bulk loads. Stock and inventory writes bypass this header. Useful for large data loads.

No

true

Property Group Match Field

The field used to match an existing property group instead of matching by name. Defaults to matching by name.

No

name

Property Group Option Match Field

The field used to match an existing property group option instead of matching by name. Defaults to matching by name.

No

name

Tax ID

The default Shopware tax used as a pricing fallback. Used when a tax value cannot otherwise be resolved.

No

Standard rate

Currency ID

The default Shopware currency used as a pricing fallback. Used when a currency value cannot otherwise be resolved.

No

EUR

StoreFront ID

Reserved setting. This value is declared but is not actively consumed by the current integration, and has no functional effect in the current release at the time this documentation was written.

No

(leave blank)

Product Category Duplicate Checking By

How catalog-category duplicates are detected (by name, by description, or by a named custom field). Defaults to name.

No

name

Product Category Duplicate Matching By

How catalog-category duplicates are matched (by name, by description, or by a named custom field). Defaults to name.

No

name

Group Kit Components Using Custom Fields

When enabled, groups kit components using a custom field. Off by default. Used by the kit-grouping mapping.

No

false

Concurrent Batch Executions

The number of batches the integration processes concurrently. A platform concurrency control; raise or lower it to match your store's API capacity.

No

4

Authentication Methods

The integration authenticates against the Shopware Admin API using OAuth 2.0. The grant type is selected with the Grant Type setting:

  • Password grant: Uses a Shopware administrator username and password through Shopware's built-in administration client.

  • Client Credentials grant: Uses an Integration Access Key ID and Secret Access Key generated in the Shopware Administration.

Access tokens are obtained automatically when the integration runs and are refreshed automatically as they expire. Subscribers do not manage tokens manually. For more detail on these grants, refer to Shopware's Admin API documentation.

Initialization Support

Initialization is a one-time bulk backfill that loads existing reference data into iPaaS.com when the integration is first set up. For the Shopware integration, initialization is supported for exactly four reference data types, all transferred TO iPaaS.com:

  • Payment Methods

  • Shipping Methods

  • Warehouses

  • Warehouse Groups

All other entities (including Customers, Products, and Orders) and all flows running FROM iPaaS.com are not initialized. Those records transfer through webhook events, inbound transfers, or manual sync rather than through bulk initialization.

Throttling

The subscription exposes configurable throttle and concurrency controls so subscribers or their MiSP can keep the integration within their Shopware store's API capacity:

Subscription Settings page showing the throttle, concurrency, and Initialize Data settings common to all subscriptions
  • An inbound API throttle limit and a throttle window (in seconds) for requests coming into iPaaS.com.

  • A separate To-iPaaS throttle limit and window for data sent to iPaaS.com.

  • Concurrent Connections: the number of simultaneous connections the integration opens.

  • Concurrent Batch Executions: the number of batches the integration processes at the same time.

Tune these values to respect your store's available API capacity, and stagger large manual jobs so they do not overwhelm the Shopware API. For guidance on adjusting these values, see the Subscription Configuration – Edit Help Center article.

Did this answer your question?