Magento integration guide

Plugin overview#

The ExpertSender CDP plugin not only syncs orders by default but also allows you to collect customer consents directly from your Magento store and submit them to ECDP.

The plugin is compatible with Magento 2.2+.

If you prefer using this feature instead of an API integration for collecting consents, follow these steps:

Order synchronization

• By default, order information is automatically sent to ECDP. No additional setup is required for this.
• To ensure order statuses are properly synced, refer to the Order Status Mappings section.

Steps to collect and submit consents

1. General settings configuration
   Go to the General Settings tab and fill in the necessary fields:
   • API key
   • Tracking code
   • Website ID
2. Create consents in Magento
   If you want to collect marketing consents (e.g., when users register, edit profiles, or place orders):
   • Go to the Consents tab.
   • Create a consent in Magento and map it to a corresponding marketing consent in ECDP.
3. Create consent forms
   In the Consent Form Elements tab:
   • Create the forms responsible for collecting consents (e.g., “Checkout consent”).
   • Select where the consent checkbox or form should be displayed (e.g., registration, checkout, profile edit).
   • Choose which consent is collected once the form is submitted.
4. Configure opt-in mode
   Go to Settings > Form Settings and define whether consents will be collected using Single Opt-In or Double Opt-In. If Double Opt-In is selected, you’ll need to specify the Confirmation Message ID from ECDP.
5. Optional: Custom data mapping
   If your store collects additional data beyond standard fields (e.g., order, product, or user data):
   • Configure the submission of custom fields in the Custom field mapping tab. This step ensures that non-standard data is sent to ECDP.

Installation & configuration

1. Install the extension

You can install the ExpertSender CDP extension using either Composer or manually via FTP:

Via composer:
Run the following command in your Magento root directory

composer require expertsender/ecdp

Manually via FTP:

• Download the plugin from GitHub.
• Upload the extension files to your Magento server in the following directory: app/code/ExpertSender/Ecdp/

2. Run Magento commands

After installing the extension (using either method), run the following commands in your Magento root directory to enable and compile the extension:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

Plugin sections

General settings

1. Navigate to the Magento admin panel.
2. Go to ECDP > General Settings.
3. Here, you need to configure the following fields:
   • API Key: Enter your ExpertSender API Key for authentication.
   • Tracking Code: Add the tracking code to monitor user activity on your site.
   • Website ID: Input your website’s ID for ExpertSender CDP.
   • Enable API Log: If enabled, all requests and responses to/from the ECDP API will be logged in the /var/log/expertsender/api.log file for troubleshooting purposes.

Customer Data settings

To configure how customer data is sent to ECDP:

1. Navigate to ECDP > Customer Data in the Magento admin panel.
2. You can configure the source for the customer’s phone number to be sent to ECDP with the following options:
   • Billing Address (default)
   • Shipping Address
3. Additionally, you can determine whether to send the customer’s phone number to ECDP.
   If you select Yes, ensure that all phone numbers stored in Magento are in international format(including the country prefix), as failing to do so may cause issues during data transmission.

Form settings

To configure forms in ExpertSender CDP:

1. Navigate to Admin Panel > ECDP > Form Settings.
2. The General section includes the following fields:
   • Text to display before consents in forms: This is the text that will appear above the list of checkboxes in forms, such as “I agree to:”.
     Note: This text does not display in the newsletter or profile edit forms.
   • Use ExpertSender CDP form: Set whether the plugin should replace the default newsletter form with one that includes consents.
3. The Single/Double Opt-In section includes options for different forms (registration, profile edit, checkout, newsletter):
   • Form type: Choose between Single Opt-In or Double Opt-In for each form.
   • Confirmation message ID: If Double Opt-In is selected for any form, an additional field will appear where you can enter the ID of the confirmation message. If left empty, the default confirmation message will be sent.