Integrating your Magento store with Listrak is an easy way to increase the overall effectiveness of your email marketing strategy. Once you install Listrak’s extension within your Magento store, all the power of Listrak will be available to you. The integration enables you to launch a Shopping Cart Abandonment campaign, structure Post-Purchase message threads and target specific customers through purchase history profile attributes.
IMPORTANT: We strongly suggest you first install this extension on a development environment to ensure proper functionality of the code prior to deploying to your production environment. Open source software can create scenarios of near infinite configuration options that may negatively impact the Listrak extension. It is also recommended that you confirm that your store meets the minimum requirements posted by Magento found here.
To install the Listrak extension, you must first obtain an extension key by going to our extension page on the Magento Marketplace, and adding the Extension to your cart. Once you have completed the checkout process, click the Install button on the order confirmation page. This will give you an extension key to copy for use within the Magento Connect Manager. Copy the key for the latest extension and then login to the Magento Connect Manager from within your Magento Admin Panel: System > Magento Connect > Magento Connect Manager. The system may require that you login once again.
Paste the key in the appropriate box (as shown below) and click install:
Now you should see a table displaying all the components of the installation. Click Proceed to complete the installation.
A console window appears that indicates the extension was successfully installed. You may need to refresh the page to see it listed along with any other extensions you have installed on your store.
In order for Listrak to retrieve data from your store such as: order history, abandoned carts, and newsletter subscribers, an API user is necessary. To do this, you must first create a Role for the API user. From the Admin Panel menu, select System > Web Services > SOAP/XML-RPC - Roles. Click Add New Role and enter “Listrak” as the Role Name.
No specific Role Resources are required, simply click Save Role.
Now that you have created a role, add a new user by going to System > Web Services > SOAP/XML-RPC - Users. First click Add New User and then enter the following information:
- User Name – listrakapi
- First Name – Listrak
- Last Name – API User
- Email – firstname.lastname@example.org (use your actual domain, the inbox doesn’t need to exist)
- API Key – (the password must be at least 6 characters)
- API Key Confirmation – (the same password you just entered)
Click User Roll from the tab on the left, and then select the radio button for the “Listrak” role and click Save User to complete the process.
NOTE: Please keep the password for the user you just created in a safe and secure place, so that you can send this information to your Listrak representative during the account setup process. Your Project Manager will need this information to validate your site.
OBTAINING STORE ID
To ensure that Listrak processes are connecting to the appropriate store within your Magento installation, you will need to email the Store ID of your website to your Listrak project manager. Typically, this value is 1, but this guide will ensure that we confirm the correct value. To obtain your store ID value, go to System > Manage Stores to view a list of available stores. Find the store you will be installing the module for and click on the store view name. View the URL in the address bar and take note of the value as highlighted below. In this example, the store ID value is “1”. If your store ID is not 1, please relay this information back to Listrak.
There are a few settings that are able to be configured for the Listrak module. To access the settings, go to System > Configuration and click on Listrak under the Customers menu in the left navigation.
Core Functionality: The Listrak module captures data related to Products, Customers, Orders and Abandoned Carts – the Core Functionality option will by default be set to “Enable”. This setting should remain intact.
Review API: The Review API option allows for Listrak to gather information on Magento product reviews for use in Marketing emails – this is set by default to “Disable”. If your store utilizes Magento product reviews please set this to “Enable”.
- NOTE: The Review API will only pull Magento Reviews, which means if you are using an alternate review provider, such as BazaarVoice or PowerReviews, you would still leave this set to “Disable” and contact your Listrak Project or Account Manager for integration of the alternate Review Source.
The newsletter emails by default will come out of the Magento Platform. Typically you would be sending the welcome messages from Listrak, so setting these items to disabled is a way to disable the Magento Default emails from going out so that everything goes through Listrak.
PRODUCT RETRIEVAL OPTIONS
The Product Retrieval Options control the product data we are retrieving from your store. The Category Source option defines where the category and subcategory data is being pulled from. It will either be pulled from the categories defined in the catalog or from another product attribute (see Setting Brand and Category section of this guide). The base category level defines at what level the category and subcategory are defined. The default value for this setting is 3. Please work with your Project Manager to determine if this needs to be changed. The skip category IDs field is a comma delimited field of category ids that you would like Listrak to skip when attempting to retrieve category and subcategory data. Please work with your PM to determine the proper settings for this if you feel there is a need to skip some categories. The related products flag determines if Listrak can consume the default related products data within Magento. If you have not setup any related products, this flag can be set to Disabled. The products available for purchase setting tells Listrak if a product is available on the website. The default value for this setting is site (catalog or search). Please work with your Project Manager to determine if this needs to be changed.
Now all you need to do to complete the setup is clear your stores cache. To do this, navigate to System > Cache Management in your Magento Site Admin Panel. On this page, you need to click the link for Select All and then make sure “Refresh” is selected before hitting the Submit button in the top right corner of the cache listing.
Next you should flush the Magento Cache and the Cache Storage. These are buttons located in the top right of the Cache Management page. Click the Flush Magento Cache button and wait until you see the success message. Then click Flush Cache Storage and confirm that you would like to do so.
- NOTE: Do not worry if you click on the Configuration > Abandoned Carts link and nothing appears in the content pane. A bug in Magento prevents this from appearing right away. If you do not see the configuration options for Listrak Cart Abandonment, simply log out and log back into the admin panel
To ensure your Cart Abandonment campaign reaches as many potential customers, you need to set up your Magento store to capture email addresses entered on your site as the customer is typing.
Not all Magento installations are the same, but Listrak has pre-filled a few email input values during the installation process. This will capture the default scenario for newsletter signup, checkout login, and guest checkout. Any other areas of your site that a customer would type their email address should be added to the capture list. If your site uses a custom checkout, you will need to make sure that any email address input that appears during checkout is added to the capture list too.
To configure a page to capture an email address, you must go to Listrak > Email Capture, then click Add Field. You can either put in an asterisk ( * ) or enter an actual page URL. Note that all Magento URLs have 3 parts. If you copy a URL that is only two parts, simply add “index” after the last slash.
To add an email field, navigate to the page on your site where the input exists. Note the URL in your address bar after your store’s domain. In the example below, the page is “customer/account/login”.
Right click and view the page source. When viewing the HTML source, search (Ctrl+F) for something near the form input, in this example I will search for “Email Address” as you can see in the screenshot below:
Once you have found that in the code, you are looking for the HTML tag so that you can identify the ID value of the input. In this case the input has an ID of “email” assigned.
Enter this value in the box labeled Field ID. Click Save Field and you’re done! Repeat this process for all inputs you wish to capture an email address from.
SESSION COOKIE TIMEOUT
Magento allows merchants to define how long their cookie will exist on a customer’s computer before expiring. The default value is 3600 seconds, or 1 day. To ensure optimal operation of your email re-marketing campaigns, we recommend that this setting be increased to at least 604800 (7 days) to ensure baskets do not appear empty to customers as they click from an email to your online store. This setting can be changed by navigating to System > Configuration. On the settings page, under the General section on the left-hand side, select Web and expand Session Cookie Management. Change the Cookie Lifetime to 604800 and click Save Config.
Now you must make sure you flush both the Magento Cache and Cache Storage in the same manner as directed during the extension installation process.
Now that you have completed your Magento integration, please make sure these steps are followed:
- Send your API login and password to Listrak
- Send your Store ID (if other than 1) to Listrak
- Let your Listrak PM/AM know that you have completed your integration
- Provide Magento front end URL and any credentials needed to gain access
- Make certain your cache has been cleared