Skip to main content

Connecting a Shopware 6 Store

How to connect your Shopware 6 store to Klar so your order and product data flows in automatically.

Written by Franz May

tl;dr

You'll need two things from Shopware to complete the connection:

  1. Your Shopware API URL (your shop URL + /api)

  2. An Access Key ID and Secret Access Key — generated in Shopware's Settings → Integrations

Two options for the integration: grant Administrator access (quickest) or create a custom role with Read-only permissions (more secure, recommended for production).


Step 1: Add Shopware 6 as a datasource in Klar

  1. In the left sidebar, go to Store ConfiguratorData Sources

  2. Click Add Data SourceAdd New Data Source

  3. Search for or select Shopware 6

  4. Enter a name for the store (e.g. Shopware 6 DE) and click Connect


Step 2: Enter your Shopware API URL

In Klar, enter your Shopware API URL. This is your shop URL with /api appended:

⚠️ Note: Some Shopware setups require the URL without www. — if the connection fails, try removing it.


Step 3: Create an Integration in Shopware

In your Shopware Admin, go to SettingsIntegrations.

Click Add Integration. You have two options:

Option A — Administrator access (quickest) Enable the Administrator toggle. This gives Klar full read access. Use this for testing or if you're comfortable with the permissions scope.

Option B — Custom role with read-only permissions (recommended) See the Custom Role Setup section below for a more secure setup.


Step 4: Copy credentials into Klar

Once the integration is saved, copy the Access Key ID and Secret Access Key from Shopware and paste them into the corresponding fields in Klar. Complete the setup over Save Integration.


For Option B: Custom Role instead of granting admin permissions

For production environments, we recommend creating a role with only the permissions Klar needs — read access to orders, products, and customers.

  1. Log in to your Shopware 6 Admin dashboard

  2. Go to SettingsSystemUsers & Permissions

  3. Click Roles in the left-hand menu

  4. Click Create role

  5. Enter a Name (e.g. Klar API Read-Only)

  6. Click the Permissions tab

  7. Grant View (Read) access for the following entities — use the search bar to find each one quickly:

Entity

Permission

Category

View

Country

View

Currency

View

Order

View (covers order, order-delivery, order-transaction, order/line-items)

Payment Method

View

Product

View

Sales Channel

View

Shipping Method

View

State Machine State

View

Unit

View

8. Click Save

9. When creating the Integration (Step 3), assign this new role instead of enabling Administrator

Did this answer your question?