Skip to main content
Version: 2026.10

Configuration

Bundle Configuration​

Overview​

The bundle can be configured in the Twocream Bundle Overview which can be accessed via a new button with the Twocream logo in the Pimcore sidebar. There the bundle can then be selected to open its configuration.

Configuration Fields​

NameDescription
Email branding colorHex color value to be used for styling in the import/export email template
Email branding imageRelative file path (from the pimcore root) of the brand logo that is to be embedded within the import/export email template

YAML Configuration​

General​

A YAML file must be placed in the directory config/packages/shopware_connector.yaml of the Pimcore project. All configurations for the bundle are made in this file.

Structure of Configuration​

twocream_shopware_connector:
  export_targets:
    - key: shop_staging
      target_type: shopware
      has_delta_management: true
      adapter_blocklist:
        - links
        - fairs
        - press
      export_directory: '/path/to/export/directory/'
      asset_domain: 'https://assets.tld'
      asset_directory: '/path/to/asset/directory/'
directory_resolver: 'default'
transfer:
adapter: 'sftp'
parameters:
host: 'sftp.example.com'
username: 'user_name'
password: 'Password123!'
port: 22
asset_transfer:
adapter: 'nfs'
      reporting:
        from: 'sender@your-domain.tld'
        reply_to: 'reply-to@your-domain.tld'
        cc_recipients:
          - copy-recipient@your-domain.tld
      import_mail_subject: "Shopware-Import to STAGE"
      export_mail_subject: "Pimcore-Export to STAGE"
supported_languages:
- de
- en
  adapters:
    - key: YOUR-ADAPTER-PACKAGENAME
      source_folder_ids:
        - 5
        - 7
language_mapping:
de: 'de_DE'
en: 'en_GB'
disabled_languages:
- fr
Best Practice

For flexible use in different instances, it is recommended to outsource the values into environment variables (.env). This allows easy adjustments for the respective instances without having to edit the service configuration file.

twocream_shopware_connector:
export_targets:
- key: shop_staging
target_type: shopware
has_delta_management: true
export_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_DIRECTORY)%'
asset_domain: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DOMAIN)%'
asset_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DIRECTORY)%'
directory_resolver: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_DIRECTORY_RESOLVER)%'
transfer:
adapter: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_TRANSFER_ADAPTER)%'
reporting:
from: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_FROM)%'
reply_to: '%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_REPLY_TO)%'
import_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_IMPORT_MAIL_SUBJECT)%"
export_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_MAIL_SUBJECT)%"
- key: shop_live
target_type: shopware
has_delta_management: true
export_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_DIRECTORY)%'
asset_domain: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DOMAIN)%'
asset_directory: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DIRECTORY)%'
directory_resolver: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_DIRECTORY_RESOLVER)%'
transfer:
adapter: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_ADAPTER)%'
parameters:
host: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_HOST)%'
username: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_USERNAME)%'
password: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_PASSWORD)%'
port: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_PORT)%'
reporting:
from: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_FROM)%'
reply_to: '%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_REPLY_TO)%'
import_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_IMPORT_MAIL_SUBJECT)%"
export_mail_subject: "%env(SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_MAIL_SUBJECT)%"
adapters:
- key: 'products'
source_folder_ids:
- '%env(SW_CONNECTOR_ADAPTERS_PRODUCTS_SOURCE_FOLDER_ID)%'
- key: 'attributes'
hide_export_mask: true
source_folder_ids:
- '%env(SW_CONNECTOR_ADAPTERS_ATTRIBUTES_SOURCE_FOLDER_ID)%'
SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DOMAIN=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_ASSET_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_DIRECTORY_RESOLVER=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_TRANSFER_ADAPTER=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_HOST=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_USERNAME=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_PASSWORD=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_SFTP_PORT=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_FROM=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_REPORTING_REPLY_TO=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_IMPORT_MAIL_SUBJECT=""
SW_CONNECTOR_TARGETS_SHOP_STAGING_EXPORT_MAIL_SUBJECT=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DOMAIN=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_ASSET_DIRECTORY=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_DIRECTORY_RESOLVER=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_TRANSFER_ADAPTER=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_FROM=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_REPORTING_REPLY_TO=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_IMPORT_MAIL_SUBJECT=""
SW_CONNECTOR_TARGETS_SHOP_LIVE_EXPORT_MAIL_SUBJECT=""
SW_CONNECTOR_ADAPTERS_PRODUCTS_SOURCE_FOLDER_ID=""
SW_CONNECTOR_ADAPTERS_ATTRIBUTES_SOURCE_FOLDER_ID=""

Configure Target Systems​

KeyDescriptionMandatoryExample
keyUnique name for your target system (CamelCase notation)Yesshop_staging
target_typeType of the target system. Currently, this is only used in the case of the value "shopware" to distinguish code-side logicYesshopware | pimcore | wordpress | others...
adapter_blocklistArray of adapter names that are blocked for this export targetNofairs
has_delta_managementControls whether the target system can process delta exports (default true)Notrue |
export_directoryPath to the export directoryYes/path/to/export/
asset_domainAsset domainNohttps://assets.tld
asset_directoryPath to the asset directoryYes/path/to/assets/
image_pathURL prefix of the image thumbnails in the export instead of asset_domain (documents still use asset_domain)Nohttps://images.tld
directory_resolverThe identifier of the directory resolver to be used to determine storage directories of files

See: Determine storage directories using a directory resolver
Nodefault
transfer > adapterThe identofier of the transfer adapter to be used to handle files

See: Handle files using a transfer adapter
Nonfs
transfer > parametersAdapter-specific parameters, see: Handle files using a transfer adapterNohost: 'sftp.example.com'
username: 'user_name'
password: 'Password123!'
port: 22
asset_transfer > adapterThe identifier of the transfer adapter to be used to handle assets. If asset_transfer is not configured, the adapter configured under transfer is used

See: Handle files using a transfer adapter
Nonfs
asset_transfer > parametersAdapter-specific parameters for the asset transfer adapter, see: Handle files using a transfer adapterNohost: 'sftp.example.com'
port: 22
reporting > fromReporting email address of the senderYessender@your-domain.tld
reporting > reply_toReporting email address of the reply-to recipientNoreply-to@your-domain.tld
reporting > cc_recipientsArray of CC email addresses for reportingNocopy-recipient@your-domain.tld
export_mail_subjectSubject for export email reportNoPimcore-Export to STAGE
import_mail_subjectSubject for import email reportNoShopware-Import to STAGE
supported_languagesPimcore languages that the product adapters export for this export target. Without a value, all languages enabled in Pimcore that are not in disabled_languages are exported. See "Configure Language Mapping"Node
en

Configure Adapters​

KeyDescriptionMandatoryExample
keyUnique name for an adapter (corresponds to the package name of the adapter)Yesfairs
hide_export_maskHide the option in the export maskNotrue
source_folder_idsArray of folder or object IDs whose child objects are considered during export. Without a value, the root folder (ID 1) appliesNo5

Configure Language Mapping​

You can configure a mapping between Pimcore languages and Shopware languages. For each entry the Pimcore language is used as the key and the Shopware language is used as the value:

language_mapping:
de: 'de_DE'
en: 'en_GB'

Which Pimcore languages the product export (ProductAdapterAbstract) exports is defined per export target with supported_languages. Without a value, all languages enabled in Pimcore that are not in disabled_languages are exported. language_mapping only determines the Shopware locale: a language without an entry is exported under its Pimcore key (see "Pimcore language and Shopware locale").

twocream_shopware_connector:
export_targets:
- key: shop_staging
supported_languages:
- de
- en

Disable Languages​

With disabled_languages, individual Pimcore languages can be excluded from the export. The specified languages are skipped during export and are not taken into account in the language mapping either:

disabled_languages:
- fr