Connecting and Configuring Plug-Ins

Establish the connection between Shopify and SAP Emarsys by installing the necessary plug-in from the Shopify store.

Before proceeding with the integration, make sure the following are in place:

• A functioning Shopify store.

• An active SAP Emarsys account, especially the following elements:

  • SAP Emarsys merchant ID.

  • SAP Emarsys API credentials for authentication.

  • Verify that the Shopify API user can access the customer.settings API endpoint.

• Manage this process by enabling the customer.settings API endpoint in Management > Security Settings > API Credentials.

Let’s discover how to set up Shopify plug-ins in SAP Emarsys.

Set up the plug-in completely, then start synchronizing various data sets, such as customer data, events, product data, order data, and Web Extend. Synchronize customer data first to activate other parts of the plug-in SAP Emarsys.

Avoid legacy order data load after activation:

Triggering an initial data load after activation strains the system, extending response times. Avoid importing large volumes of historical orders, as it only updates contacts and triggers events, tiring server resources without benefits.

Steps to correct accidental triggering of data loads:

• Deactivate the general data upload.

• Wait for the completion of the customer data load to SAP Emarsys, which is different in duration based on the database size.

• Once completed, continue uploading Shopify events, products and orders, then install web behavior tracking scripts.

• Reactivate the data upload.

Request limitations:

The system limits data requests to 1000 per minute per customer.

Data load triggers:

• Adjusting mappings prompts the system to re-upload all customer data to SAP Emarsys, overwriting current contact data, including opt-in information, with Shopify store values.

• Field matching changes start a complete customer data upload. Consider the database size, as uploads take considerable time, pausing other updates such as subscriptions.

• Plan for busy periods, such as Black Friday, to avoid starting large uploads during high traffic times. By activating data uploads:

  • An initial load starts for the contact data.​

  • An initial load doesn't start for event data.

  • Uploads start for order data, including the missing orders.​

Uploading Shopify customer data:

Transfer customer data from Shopify to SAP Emarsys, essential for activating SAP Emarsys features.

Before starting:

• The Shopify app imports and overwrites contact data in SAP Emarsys. Export SAP Emarsys contacts to Shopify before installation to preserve details.

• Check the SAP Emarsys Help Portal for more details on protecting important data. Use the emarsys_ignore tag to exclude contacts from upload.

• Change the default field-mapping post-upload. Reviewing or editing mappings between Shopify and SAP Emarsys guarantees that SAP Emarsys maps details correctly, such as formatting mobile numbers with the structure +<country code ><mobile phone number >.

• Synchronize SMS opt-in data automatically. This action enables bi-directional synchronization. Activate the SAP Emarsys SMS channel and map the Shopify's SMS marketing consent field to SAP Emarsys Mobile SMS opt-in. Collect SMS consent during checkout in Shopify settings.

• Match Shopify metafields to SAP Emarsys custom fields. This action needs to refer to the proper guide.

Synchronizing Shopify events:

Synchronize Shopify events to activate specific Tactics within SAP Emarsys. The integration creates and maps External Events in SAP Emarsys to trigger Automation programs to power customer journeys. Use these events in the Automation programs to power customer journeys.

Enabling synchronization creates missing contacts, including guest buyers, in SAP Emarsys to guarantee message delivery. The system syncs only events that use an email address as the ID.

Uploading Shopify product data:

Upload product data from Shopify to use order data and Web Extend.

• Click 'Enable' in the plug-in.

• If the update stays disabled, check the Health Check page.

Field mapping:

Products in SAP Emarsys consist of a parent and a child variable. If a parent doesn't exist, the system creates one.

Uploading Shopify orders:

• The app syncs the complete order history and excludes refunds, needing an email address for identification.

• After enabling, wait up to three hours for Smart Insight mappings.

• Follow the sequence for correct feature functionality in SAP Emarsys.

Smart Insight considerations:

• When configuring sales data with the SAP Emarsys Shopify plug-in, choose ‘Upload’ through the plug-in.

• SAP Emarsys uses only net values to sync order details. Users can define purchase filters as needed.

• SAP Emarsys retrieves essential fields from Shopify that users can't change.

• Contact SAP Emarsys support for assistance with data reloading.

Processed_at field:

• The plug-in uses processed_at as the default date field.

• Change processed_at in Shopify for migration purposes.

• Use Smart Insight mapping during Shopify migration to guarantee the correct creation date.

Email as identifier:

The email field serves as the external key for matching with SAP Emarsys contacts.

Web behavior tracking with web pixel:

Track web behavior uses a web pixel without scripts.

Checking tracked data:

Avoid using the inspector, as it doesn't show data from the web pixel.

Headless Shopify integration:

• Web pixel supports a headless integration with Shopify.

• Test integration carefully, as Headless Shopify offers extensive customization options that the integration doesn't cover.

• Resolve any differences for proper setup.

Using Shopify Tactics:

Let’s discover the available Shopify Tactics:

• Welcome

• Post-purchase upsell

• Post-purchase cross-sell

• Post-purchase category cross-sell

• Post-purchase feedback

• Registration confirmation - transactional

• Fulfillment confirmation - transactional

• Order confirmation - transactional

• Order refund - transactional

• Order cancellation - transactional

• Order fulfillment updates - transactional

• Payment reminder - transactional

• Lead acquisition

Use the plug-in to connect Adobe Commerce, formerly known as Magento 2, with SAP Emarsys. It automatically syncs customers, events, and order data. The Adobe Commerce integration enables SAP Emarsys users to create contact segments, customize messages, and develop event-based programs to maximize and simplify marketing communication.

Key features:

• Import and regularly update customer data from Adobe Commerce to SAP Emarsys.

• Sync opt-in data from SAP Emarsys to Adobe Commerce quickly, retrying updates for up to 24 hours if needed.

• Automate event triggers, product data uploads, and order data updates between Adobe Commerce and SAP Emarsys.

• Automatic Web Extend data collection script installation on the Adobe Commerce store.

The Adobe Commerce plug-in uses email addresses to manage contacts and synchronize orders, except for web behavior tracking, which can switch to Magento ID.

If SAP Emarsys can't update opt-in data, the following happens:

• The change request enters a queue after a few retries.

• The request stays in the queue for 60 minutes.

• The update starts again after 60 minutes.

• The plug-in repeats the process every 60 minutes for 24 hours from the point that the change request enters the queue.

• If unable to update within 24 hours, the plug-in discards the opt-in change.

Adobe Commerce requirements:

• Get admin access for the Adobe Commerce store.

• Use store version 2.4.3 or newer.

• Find the merchant ID under the Predict Data Sources page after enabling email sending.

• Encrypt the website with a trusted SSL certificate. The plug-in needs HTTPS, so reject unsecured sites.

• Access the system with fixed IPs. If IP filtering runs in Adobe Commerce and allow lists are in use, allow these IP addresses:

  • 34.89.173.3

  • 35.246.249.205

  • 34.89.137.140

  • 185.4.123.111

• Make the URL < clientdomain >/rest/V1/* publicly accessible on the server. The SAP Emarsys plug-in uses the Adobe Commerce API to connect to the store.

Let’s discover how to set up the SAP Emarsys for Adobe Commerce plug-in.

Customer data:

The Adobe Commerce plug-in imports contact (whether a customer or newsletter subscriber) data into SAP Emarsys, overwriting existing values. The initial synchronization merges these contacts and potentially reduces the total number of unique contacts.

Field mapping:

• SAP Emarsys uses the email field as the external unique contact identifier for plug-ins to match contacts.

• Starting with version 1.13.0 of the Adobe Commerce 2 (v2) plug-in, mapping choice fields from Adobe Commerce to SAP Emarsys fields changes synchronization to use text values instead of numeric IDs, unlike previous versions, which used numeric IDs.

• Update the recommended attribute mappings, except for the non-editable fixed ID, store ID, and Accepts Marketing attributes. Adjust mappings by adding or removing attributes, but avoid unsupported multi-choice fields.

Events:

Adobe Commerce events, such as customer registration, are available on the SAP Emarsys platform for transactional marketing, personalization, and Interaction programs.

Event handling for version 1.10.0 and later:

• Enable the relevant toggle triggers for events in SAP Emarsys only. To prevent duplicates, turn off transactional emails in Adobe Commerce and consider migrating communications to SAP Emarsys.

• Activate 'Trigger events also on Adobe Commerce' to make Adobe Commerce events available on both SAP Emarsys and Adobe Commerce platforms. This setup is suitable for testing and message transition.

Event handling for version 1.9.2 and earlier:

• Enable events in the Events section for availability in SAP Emarsys.

• Enabling event triggering automatically disables sending transactional emails from Adobe Commerce, preventing duplicate messaging. Consider migrating the relevant communications, such as order confirmation emails, from Adobe Commerce to SAP Emarsys before enabling event triggering.

Products:

Integrate product data from Adobe Commerce into SAP Emarsys using a synchronization setup.

Parent product availability depends on child products:

• Parent is available if at least one child product is available.

• Parent is unavailable if all child products are unavailable.

Before starting:

• Suppose a client has a single Adobe Commerce instance with several websites connected to different SAP Emarsys accounts. In that case, the Adobe Commerce 2 (v2) plug-in’s product sync feature includes all products from these websites.

• For this feature, use Adobe Commerce 2 (v2) plug-in version 1.14.5 or later.

• Match custom product fields only, as standard SAP Emarsys fields automatically match. Changing the automatic matching for the standard fields could cause issues with the product catalog synchronization.

Setup and synchronization:

To set up synchronization of product data from Adobe Commerce with SAP Emarsys:

• Implement Predict in SAP Emarsys before enabling product data upload.

• Enable regular product data uploads in the products section.

• Check the Adobe Commerce Integration/Health Check tab if the regular upload stays turned off.

Outcome:

Configured product data synchronization allows targeting customer segments based on products purchased, viewed, or left in carts, and offering tailored product recommendations.

Web Behavior tracking:

Web Extend scripts track visitor interactions on the website. The plug-in automatically installs them to process validated data for SAP Emarsys applications such as Smart Insight, Predict, and Interactions.

Orders:

• Select 'Enable' in the Orders section to activate regular order uploads to SAP Emarsys.

• Implement Smart Insight for proper order upload functionality. Without implementing Smart Insight, sales data is inaccessible.

Smart Insight considerations (For Adobe Commerce plug-in implemented after March 2021):

• To use sales data in Smart Insight through the Adobe Commerce plug-in, select the 'Upload via Plugin' option when configuring sales data.

• Starting March 10, 2021, SAP Emarsys syncs order data, including all details such as price without tax, and Smart Insight uses gross values for calculations.

• Smart Insight pre-maps the needed sales data-related fields and allows attribute selection for segmentation and filtering. Use the email as a unique identifier for Adobe Commerce used through Smart Insight.

Health Check tab:

Access the Health Check tab to view the data synchronization status between Adobe Commerce and SAP Emarsys.

Status widget:

View the overall synchronization status, including Contacts, Orders, Products, Events, and the last update dates. Possible statuses include:

• OK: The system properly syncs the data.

• Data sync error: The system fails to sync data since the date shown, indicating issues retrieving contacts, order updates, or events.

• X is disabled: Disable synchronization for a specific data type.

History widget:

Explore warning and error messages related to data synchronization. It shows in rows organized by type and severity level. By default, the system shows the last ten rows.

Messages include:

• The system records the date and time when it receives the message.

• The data type of the warning or error includes:

  • API

  • Contact sync

  • Disconnect

  • Order sync

  • Product sync

• Description of the warning or error.

• Use the ‘Search’ field to find specific messages.

• Shopify integration overview: Connect Shopify with SAP Emarsys to sync customer, event, product, and order data for segmentation, personalization, and automation.

• Shopify data sync and configuration: Sync customer data first, then upload events, products, and orders. Map fields to SAP Emarsys using email as an identifier, and sync opt-in and Smart Insight data.

• Adobe Commerce (Magento) configuration: Set up plug-ins to import customer data, map fields, sync products and orders, and automate event triggers for transactional messages.

• Adobe Commerce data setup: Inject Web Extend scripts through the plug-in to track customer behavior and sync product, events, orders, and web behavior tracking data for Smart Insight, Predict, personalization, and automation features.

• Health and error monitoring: Use the Health Check tab, Status and History widget to track data sync between Adobe Commerce and SAP Emarsys, warning messages, and update statuses by data type.