Shopware

Enhance post-purchase retention, upselling, and branding by fully integrating Karla into your Shopware store.

Install the Karla Extension

Follow these steps to install and configure the Karla extension in your Shopware store.

1. Upload the Extension

1. Download the Karla extension from the official releases page. You will typically download the KarlaDelivery.zip file for the latest version.
2. In your Shopware admin panel, navigate to Extensions > My extensions.
3. Under My extensions, click Upload extension.
4. Click Confirm and upload the KarlaDelivery.zip file you just downloaded.

2. Install and Activate

1. Once uploaded, click Install next to the Karla extension to begin the installation process.
2. A success message will confirm the successful installation.
3. After refreshing the page, the Karla app will show as activated. Click Configure to proceed with merchant-specific settings.

3. Configure the Extension

1. Enter your shop slug and API key.
2. Optionally, you can define a custom target API URL for advanced setups.
3. Under Shop events, select which events trigger data synchronization with Karla.
4. Click Save to apply your changes.

Now your shop is fully integrated with Karla!

How it works

The Karla extension automatically synchronizes orders, shipments, and attribution data from your Shopware store to Karla.

Order attribution

The extension tracks order attribution through Shopware's built-in affiliate and campaign tracking system. This allows you to measure the effectiveness of your tracking pages, deals, and other marketing campaigns.

When a customer clicks a link from Karla (e.g., from a tracking page or deal), the link includes attribution parameters:

https://your-shop.com?affiliateCode=karla&campaignCode=tracking_page

Shopware stores these parameters in the customer's session and associates them with any orders placed during that session. The attribution data is then automatically synchronized to Karla through the extension.

Attribution parameters:

• affiliateCode: Identifies Karla as the traffic source (typically set to karla)
• campaignCode: Identifies the specific source within Karla (e.g., tracking_page, deals, or a specific campaign UUID)

Key behavior:

• Last-click attribution: If a customer clicks multiple affiliate links, the most recent attribution is saved
• Session persistence: Attribution data persists across page loads and browsing sessions
• Automatic synchronization: Attribution is automatically included in order data sent to Karla

No additional configuration is required for attribution tracking. The extension handles this automatically once installed and activated.

Order segments

The extension automatically tracks order segments from various Shopware entities, enabling you to create targeted campaigns and analyze customer behavior. Segments are sent as part of the order data and can be used with segmented campaigns.

Automatic segment tracking:

The extension captures segments from the following sources:

• Customer tags: Tags assigned to the customer who placed the order
• Order tags: Tags assigned to the specific order
• Sales channel: The sales channel through which the order was placed (e.g., storefront, headless API, marketplace integration)
• Customer groups: The customer group membership (e.g., B2B customers, VIP members, retail customers)

How segments work:

When an order is synchronized to Karla, all applicable segments are automatically included in the order data. For example, an order might have segments like ["vip-customer", "b2b", "storefront", "newsletter-subscriber"].

These segments can then be used to:

• Create targeted campaigns for specific customer groups
• Analyze purchasing patterns by segment
• Personalize tracking page experiences
• Trigger segment-specific promotions and upsells

Configuration resources:

• Customer groups: Configure in Shopware admin under Settings > Customer groups. Learn more about customer groups
• Tags: Create and manage tags in Settings > Shop > Tags
• Sales channels: Configure in Settings > Sales channel

No additional configuration is required in the Karla extension. Segment tracking happens automatically based on your existing Shopware setup.

Configuration

Trigger behavior

You can select which Shopware events trigger the sending of order and shipment data to Karla.

Product synchronization

Orders automatically include product data even when product sync is disabled. However, this data is captured at order creation time and may become outdated. For example, if a product image changes after the order is placed, the tracking page may display a broken link and fall back to a placeholder image. Additionally, product information sent with orders does not include translations.

When product sync is enabled, the plugin continuously synchronizes the latest product information from your admin panel to Karla, including translations. This ensures that products displayed on tracking pages always reflect the current state of your shop.

Enabling this feature will perform an initial full sync of all products, then automatically sync any new, updated, or deleted products while the feature remains active.

Webhook Receiver (Incoming Events)

Enable receiving events from Karla into your Shopware instance. This will validate any incoming requests with a uniquely generated secret as described in Webhooks.

Enabled Events accepts a comma-separated event names, or * for all events. Examples: shipments/delivered,claims/created. Set before enabling webhook (changes after webhook creation will be ignored). See Events Filtering.

The Webhook ID, Webhook URL and Webhook Secret values are read only and will be shown once you save the setting with the Enable Webhook Receiver toggle activated and you refresh the page.

Karla Notify via Shopware

This setting is necessary to configure Notify

Mappings

Use Mappings to define line item types (e.g., 'deposit'). This lets you exclude them from the order summary on the tracking page.

Multi-tenant

For Shopware instances with multiple sales channels, this configuration links each sales channel to a specific Karla shop ID. This enables using multiple Karla shops with a single Shopware instance.

You can retrieve the version of your sales channel if you click on it in the admin panel and you check the url: for instance in https://<your-shop-domain>/admin#/sw/sales/channel/detail/98432def39fc4624b33213a56b8c944d/base, 98432def39fc4624b33213a56b8c944d is the sales channel id.

warning

Make sure that the provided API credentials have access to all the shops defined in this setting. It is possible to have multi-shop credentials.

Upgrade the Karla extension

If you already have the Karla plugin installed and want to get benefit from the latest plugin features, just upload the latest KarlaDelivery.zip file as described in Upload the Extension.

You will then see an option to update your currently installed extension.

After clicking update, your plugin will be automatically updated to that version with the settings you set before.