PrestaShop Integration Guide

About the module#

The ExpertSender Official module is a user-friendly add-on created for e-commerce professionals enabling seamless integration of PrestaShop-based online stores with ECDP marketing automation platform.

With this module, you can easily configure the synchronization and data mapping parameters in PrestaShop with the corresponding attributes in ECDP.

Module features#

• API call setup.
• Adding field mappings from PrestaShop with the fields available on the ECDP side.
• Manual synchronization setup.
• Extended logs.
• Import of existing customer and order data.
• CRON job configuration with a selected frequency to run periodic synchronization at a specified time.
• Automatically adding new customers and orders for synchronization and for resynchronization when this data is updated.

Pre-requisites and Compatibility#

• PrestaShop Compatibility: The module is compatible with PrestaShop versions 1.7.0 — 8.x, accessible via the PrestaShop admin panel.
• System Requirements: Ensure you have the necessary API key from ECDP and server credentials if a CRON setup is required.

Before Installation Checklist:

• Backup your server and database files.
• Obtain the API key from ECDP.
• Have server credentials ready for CRON setup (if required).

Module Installation#

Installation Step-by-Step#

1. Login to PrestaShop Admin Panel: Go to Modules > Module Manager.
2. Backup: We highly recommend backing up your server and database files before installation.
3. Upload Module: Select x.x.x-expertsenderofficial.zip, then choose Upload a module.
4. Install Module: Scroll to find ExpertSender Official and click Install.
5. Optional Step: Clear cache at Advanced parameters > Performance to ensure the module operates smoothly.

Module Configuration#

1. Access Module Settings: Go to Modules > Module Manager > ECDP > Configure.
2. Configuration Fields:
   • API Token: Enter your API ECDP key. (For information on obtaining an API key, see the additional help window below the input field.)
   • Website ID: Enter integration-related information, such as your ECDP site ID.
3. Mapping Setup: Five types of mappings are available: order statuses, order fields, consents, product fields, and customer fields.
   • To add a new mapping, go to the Mappings tab, click Add Mapping, and select the PrestaShop field and ECDP attribute.
4. Logging Options: In the Logs tab, enable Store History Logs to retain synchronization logs for reference. Logs can be downloaded as CSV files.

Example Mapping Setup: To create a common mapping like «Order Status»:

• Go to the Associations tab.
• Click on State Association.
• Select the relevant PrestaShop Order Status and ECDP Order Status.
• Save to apply the mapping.

Running the Synchronization Process#

In the Sync tab, you’ll find two lists: a list of orders and a list of customers pending synchronization. This list updates automatically whenever new customers register, new orders are placed, or data is modified.

Synchronization Options:#

• Automatic Sync: Continuous synchronization based on configuration settings.
• Manual Sync: For one-time synchronization, click Synchronize.
• Bulk Sync: Use Bulk Actions for resynchronization of multiple records simultaneously.

Common Errors and Fixes:#

• Phone Number Format: Ensure all phone numbers include the appropriate country code. ECDP requires standardized formatting, or it may return errors.
• Batch Size Recommendations: Adjust based on server capacity. For large databases, use smaller batch sizes. The default recommended value is 20.

Manual Export Options#

In the Sync tab, users have two options to manually export customer and order data:

Export Orders#

In the Export Orders section, you can specify a date range to export all orders placed within that time frame. Follow these steps:

• From: Select the start date to export orders placed no earlier than this date.
• To: Select the end date to export orders placed no later than this date.

Once the date range is set, click Export to add the task to the queue. This task will be executed during the next CRON job or can be started manually from the Sync section by clicking the Synchronize button.

Export Customers#

In the Export Customers section, you can specify a date range to export customer data within the selected time frame. Additional options are available for synchronizing customer consents:

• From: Select the start date to export customers registered no earlier than this date.
• To: Select the end date to export customers registered no later than this date.

Synchronization of Consents#

To synchronize the state of customer consents, use the options below to export consent data during the next synchronization according to the mappings set in the Mapping tab.

• Sync Newsletter Consent: Toggle to Yes if you want to include customer newsletter consent data during synchronization.
• Sync Opt-in Consent: Toggle to Yes if you want to include opt-in consent data.

Important:

• Running the next synchronization without the mappings of consent fields made in the Mapping tab will result in them being ignored.
• The transfer of consents will overwrite existing consents in ECDP with data available in PrestaShop.
• If you wish to synchronize only newly updated consents, skip these options. Consents will still be synchronized when customers update their current consents.

Once the settings are configured, click Export to add the task to the queue. The task will be executed during the next CRON job or can be manually started from the Sync section.

CRON Job Configuration#

To automate periodic synchronization, configure the CRON job link found in the Sync section.

CRON Example:

Frequency Recommendation:

• Average-Sized Stores: Every 4-6 hours.
• High-Traffic Stores: Every 1-2 hours (based on server performance).