Skip to main content

Documentation Index

Fetch the complete documentation index at: https://partner-integrations.voyado.com/llms.txt

Use this file to discover all available pages before exploring further.

Follow these steps to integrate your Engage account with your Shopware store using the Voyado extension for Shopware.

Setting up the app

1

Go to Shopware admin

Log into Shopware admin and access your Shopware admin panel.
2

Install the Voyado Extension

  • Navigate to Extensions > Store
  • In the Find extensions search field, search for “Voyado”
  • Select the Voyado extension and click on Add extension
  • Once added, click on Install extension
3

Activate and configure the extension

  • Go to Marketing > Voyado Configuration
  • Copy the Store ID and securely send it to your Voyado team
  • The team will notify you when the extension is configured.

The hasAccount custom attribute

The hasAccount custom contact attribute in Engage is used to determine whether a contact is a Customer or Guest in Shopware. Create it like this:
1

Log into Engage

2

Navigate to Config Hub

In the Engage UI go to Administration > Config hub > Contacts > Contact attributes.
3

Add the attribute

  • Scroll down and select Add attribute
  • As “Name” enter “Has account”
  • As “Id” enter “hasAccount”
  • As “Type” pick “Consent”
  • Choose in which panel you want the attribute to be displayed
  • Select Save.
You now have created the hasAccount contact attribute that you need.

Mapping sales channels to stores

Track where customers register and ship their orders by mapping Engage stores to shipping countries in Shopware. The mapped data can be used as filters for automation and segmentation.
An Engage Store is an entity that can be linked to both a customer and an order, allowing for more detailed segmentation within an Engage Environment. It supports mapping by country or location, including physical stores.
https://mintcdn.com/voyado-partners/0IxEIB2Y6a--gNYY/icons/developer-link.png?fit=max&auto=format&n=0IxEIB2Y6a--gNYY&q=85&s=36f1df27b0269657d842f3301d440083

Show me more about Engage stores

To map your Engage stores to storefront channels, follow the steps below:
1

Log into Shopware admin

2

Navigate to Marketing Voyado Configuration

3

Select sales channel

  • Under the Store and Country Mapping section, select your Sales Channel.
4

Set a fallback Engage store

  • Choose the Engage Store that will be used as a fallback.
  • Any country that has not been mapped will default to this store.
5

Map specific countries

  • Select Add New Option to map a country to an Engage Store.
  • Repeat until you’ve mapped all the required countries
Shopware does not validate phone numbers in the same way as Voyado Engage. To ensure compatibility, you must add validation to all phone number fields in customer registration forms. We recommend using the Google libphonenumber library for accurate validation.

Cookies for Web Activity Tracking

When the Voyado app is installed in Shopware, it automatically adds a cookie consent entry for Voyado Analytics under the Marketing consent group in Shopware’s default cookie banner. This ensures that tracking is compliant with privacy regulations and only runs with the user’s explicit consent.
For merchants using a third-Party cookie bannerIf you are using a third-party cookie banner instead of Shopware’s default consent manager, you are responsible for manually including the Voyado Analytics cookie in your consent configuration. To maintain proper functionality and compliance, this cookie must:
  1. Be categorized under a marketing or tracking-related group
  2. Be clearly presented to the user with the ability to provide or withdraw consent
Failure to include this consent may prevent the Voyado Analytics functionality (such as web activity tracking) from working correctly.

Troubleshooting cart tracking

If cart tracking is not functioning as expected, it may be due to missing custom Twig blocks from the Voyado app in your Shopware theme. By default, the app injects custom blocks into your theme’s template files during installation. However, in some cases—such as when using a custom theme or after modifying theme files—these blocks may not be properly included. There are two options to resolve this issue:
  1. Reinstall the App
    This will attempt to reapply the customizations automatically.
  2. Manually Add the Custom Twig Block
    If you prefer manual control or are using a highly customized theme, you can manually add the required Twig block.
The file you’ll need to add this code to is:
cart-widget.html.twig
The Twig code you’ll need to add is:
{# Extend the default Shopware cart widget template #}
{% sw_extends '@Storefront/storefront/layout/header/actions/cart-widget.html.twig' %}

{# Override the cart widget block to include custom tracking data #}
{% block layout_header_actions_cart_widget %}
    {{ parent() }}

    {# Custom block for tracking cart changes #}
    {% block voyado_layout_header_actions_cart_widget %}
        {% set filtered_cart_items = [] %}

        {% for item in page.cart.lineItems %}
            {% if item.type != 'promotion' %}
                {% set filtered_cart_items = filtered_cart_items|merge([item]) %}
            {% endif %}
        {% endfor %}

        {% set cart_data = filtered_cart_items|json_encode %}
        {# Store Cart Tracking Data #}
    {% endblock %}
{% endblock %}
Make sure this template is correctly placed and loaded in your theme so the cart data can be tracked and sent to Engage.