Magento does not support the Magento 1 platform from July 1, 2020. Although Emarsys will not switch off the Magento 1 plug-in, it will no longer be supported after January 1, 2021.
This version is currently in pilot phase.
If you would like to assist us in the pilot program, please contact Emarsys Support.
For Magento 1 installations completed prior to November, 2018, see: Magento 1 Integration Manual (v1)
Magento 1 can be integrated with Emarsys using our plug-in, which does the hard work for you. It connects your store and automatically syncs customers, events and orders to Emarsys. Then you will be able to use your Magento data in Emarsys for creating smart contact segments, personalizing your messages, building event-based programs and automating retention marketing.
The plug-in also automatically installs our Web Extend data collection scripts on your Magento 1 store, which will allow you to deliver personalized product recommendations both on your website and in emails or to track revenue from your campaigns.
Here you will find all the information you need to set up and work with the Emarsys Magento 1 plug-in.
Important
This plug-in is designed to work with the default Magento 1 installation settings. If your platform instance has had a lot of custom development, we cannot guarantee that it will work as intended, nor will we be able to support you should any issues arise.
Supported functionality
- Initial import of all customer data from Magento 1 to Emarsys.
- Regular update of customer data from Magento 1 to Emarsys.
- Daily sync of contact opt-in data from Emarsys to Magento 1.
- Automated triggering of Magento e-commerce events as external events in Emarsys.
- Automated upload of all product data from Magento 1 to Emarsys.
- Initial upload of all existing orders from Magento 1 to Emarsys.
- Regular update of order data from Magento 1 to Emarsys.
- Automated installation of the Web Extend data collection scripts on your Magento 1 stores.
Prerequisites
- A Magento 1 store (version 1.9.x) with admin access.
- A fully set up and working Emarsys Marketing Platform account.
- An Emarsys merchant ID.
Notes
- All of the above should already have been set up as part of your standard Emarsys onboarding. If you are missing any of them, please contact Emarsys Support.
- Only one Magento website can be connected to an Emarsys account. If your Magento installation consists of multiple websites, you will need a separate Emarsys account for each.
- If your Magento website has multiple stores, you will be able to connect all of them to a single Emarsys account.
Note that as the plugin requires HTTPS, you must encrypt your website with a trusted SSL certificate. Connecting to unsecured sites will be rejected.
The Emarsys plug-in relies on the Magento API to establish a connection to your store. Make sure that the Magento API is publicly accessible on your server.
If your initial connection attempt fails with an Invalid API Token error, check your firewall settings.
Multi-choice fields are not supported by the plug-in at this stage.
Installing the module - deprecated
If you would like to install our Magento 1 extension, please contact Emarsys Support. To install the module, proceed as follows:
1. Download the latest release.
2. Install the extension using Magento Connect or from the command line.
3. Flush your Magento cache.
Connecting to Emarsys
- Log in to the Magento admin.
- Go to System > Configuration.
- Expand the Emarsys panel on the left-hand side.
- Click Connect.
- Click the heading of the Connect token panel to expand it.
- Copy the connect token shown in the text area to your clipboard.
- Log in to your Emarsys account.
- Go to Add-ons > Magento.
- Paste the connect token into the appropriate field.
- Click Fetch Sites.
- Select the website of your Magento 1 store.
- Click Connect.
This will open the Manage your stores dialog, in which you can select the stores you would like to associate with the given Emarsys account. Here you can also add a display name for each of your stores: these will be used throughout your account to reference them.
Customers
Do you already have contacts in Emarsys?
Our Magento 1 plug-in will import your Magento customer data to Emarsys and overwrite any existing values. If you already have contacts in your Emarsys account, consult Emarsys Support before using our plug-in so that we can help you to protect any critical data that has been collected in Emarsys, such as opt-in status.
Important
- When you enable customer sync for the first time, the plug-in will pull all your Magento customers and push them to your Emarsys account.
- We always use the
emailfield as the external key to match your Magento customers with your Emarsys contacts.
In the Field mapping section you can choose the Magento customer attributes you want to upload to Emarsys and map each one with a field in your Emarsys contact database. To do so, click Edit Field Mapping.
In the Field Mapping dialog, you can see a series of attributes and the mappings our plug-in recommends. You can modify these at any time, except for the predefined ID, Store ID and Accepts Marketing attributes, which are not editable.
Do not choose multi-choice or single-choice Emarsys custom fields for mapping.
Once you are done with the field mappings, click the switch Enable to turn on the regular upload of your Magento customers to the Emarsys contact database. This will enable you to make use of your Magento data in your marketing campaigns.
The progress of the initial upload is tracked in the Upload status pane.
Once the process has finished, all your Magento customer data will be available in your Emarsys contact database, which will be automatically updated whenever changes happen in Magento.
Notes
- You have to wait until all your customers are uploaded to Emarsys before you can start uploading your Magento events, products and orders, or install our web behavior tracking scripts. This may take up to a few hours, depending on the size of your customer database. But you do not have to keep the page open until the process completes.
- After the initial upload of your customer data, you will be able to modify the field mappings at any time. Note that whenever you modify the mappings, we will upload all your customer data to Emarsys again.
Events
In the Events section, click Enable to make your Magento events, which are user interactions in your store such as customer registration, available in the Emarsys Marketing Platform. You will be able to use these to send transactional marketing messages, personalize them and to build Interactions programs.
Click View Event Mapping to review how the individual events are mapped with Emarsys external events.
Click View Event Data to see the list of Magento attributes that are attached to each marketing event. These are available in Emarsys as well for pesonalization, and you can add these to your messages by using the personalization placeholders shown in the dialog.
Products
In the Products section, click Enable to turn on the regular upload of your product data to Emarsys.
With this information at your disposal, you will be able to target specific customer segments on the basis of which products they bought, viewed or left in their shopping carts, or send them tailor-made product recommendations.
Currently, the Magento 1 (v2) plug-in does not support custom fields, only standard fields are synced via the plug-in with Emarsys. Therefore, field mapping is not available on the UI.
Orders
If you have already uploaded sales data to your Emarsys account, do not enable this option. Contact Emarsys support first so that we can make sure that your orders will not be duplicated.
In the Orders section, click Enable to turn on the regular upload of your orders to Emarsys.
This information is essential for Emarsys features such as revenue reporting or product affinity models, and helps to make our smart features even smarter.
Important
- When you enable orders sync for the first time, the plug-in will pull the full history of your orders and push it to Emarsys.
- By default, the
emailfield will be used as the external key to match with your Emarsys contacts. - The plug-in uses our sales data API to upload your orders to Emarsys. If you want to upload additional order data from a different source (such as returns, cancellations or offline data from your physical stores), you will also have to use the API. Please consult Emarsys support if you do not know how to do this.
- Currently, the Magento 1 (v2) plug-in does not support custom fields, only standard fields are synced via the plug-in with Emarsys. Therefore, field mapping is not available on the UI. If you would like to configure Smart Insight, then you can check the preview of your Magento sales data structure by adding sample sales data for Magento on the Product data page. The following example shows you how a sample sales data for Magento looks like:
item,price,order,timestamp,email,quantity,s_storename
24-MB05,45,9,2018-10-09T08:22:04Z,first@customer.com,1,english_store
24-MB99,4500,10,2018-10-09T08:22:04Z,second@customer.com,1,english_storeWeb behavior tracking
Our Web Extend scripts track visitor interactions on your website and process this information to serve validated data to various Emarsys applications, such as Smart Insight, Predict, Automation Center or Interactions. The plug-in will install them automatically for you.
Click Enable to install the Web Extend data collection scripts on your Magento 1 stores.
Personalizing your message content
As a Magento 1 user, you not only have all the data stored in Emarsys available for personalizing your messages, but you can also use content coming directly from Magento. Specifically, each Magento event that triggers an Emarsys external event has a set of information attached to it, which you can add to your emails or other messages.
For a list of variables individual Magento events pass to Emarsys, go to Add-ons > Magento 1, in the Events section click View Event Data, and select an event in the dropdown list.
To add such Magento content to your emails, copy and paste the appropriate Emarsys Scripting Language (ESL) placeholders into the body of your message. When the message is sent, the placeholder will be replaced with the respective value passed by Magento.
For example, to add the discount amount and the grand total values to your email triggered by the Magento Customer new order event you have to add the following placeholders to the HTML of your email:
{{ event.order.discount_amount }}
{{ event.order.grand_total }}
Migrating from Magento 1 (v2) to the Magento 2 (v2) plugin
If you would like to migrate from Magento 1 (v2) to the Magento 2 (v2) plugin, then follow the instructions in Migrating from Magento 1 to the Magento 2 v2 plugin.