Shopify

Overview

The Shopify integration allows you to connect your Shopify store to your Cordial account for seamless exporting of customer, product and order data.

Cordial's redesigned Shopify app delivers numerous infrastructure improvements targeted at app performance, stability and availability. This update includes support for AJAX cart calls and the ability to customize Cordial attributes to match default Shopify data fields.

Once the integration is set up, attributes mapped and data synchronized, you will be able to build audiences, trigger messages and personalize message content based on products, customers and order data from your Shopify account.

Install and Setup

Before installing the Cordial app and setting up your API and account keys, please ensure that Shopify customer fields you wish to map already have corresponding contact attributes in your Cordial account. You will need the Cordial contact attribute keys when mapping Shopify customer fields. If the corresponding contact attributes have not been created in your Cordial account, the key mapping and data synchronization will not be successful.

1. Navigate to https://shopify-integration.cordial.com and enter your Shopify shop URL to install the Cordial app.
   
2. Give permission to install the app in your account.
   

Enter your API and account keys

1. In your Cordial account, create a new API key for the catch-all IP address 0.0.0.0/0. Learn how to generate an API key.
2. On the Cordial Administration page in Shopify, enter your API key and click the Test button to check the API connection in your Cordial account. Please ensure that at least one contact attribute already exists in your Cordial account before testing and saving your credentials.
   
3. Enter your Cordial Account Key. You can find your Account Key on the Account Settings page in the Cordial platform.
4. Click Save.

Install the JavaScript Listener

Installing the JavaScript listener enables Shopify to post data to your Cordial account. The posted data consists of custom events, cart items and orders.

The following custom events and related properties will be available once the JavaScript listener is installed:

Custom events (browse, cart, and order) can not be renamed.

To install the JavaScript listener, click the Install JS Listener button located in the Quick Actions menu on the Cordial Administration page.

You can Edit the JavaScript base script to modify script parameters depending on your store configuration. For example, if you are using a vanity domain with JavaScript listener v1, add it as the data-cordial-url and t.src values to replace the default track.cordial.io entries. Similarly, if using vanity domains with JavaScript listener v2, replace the track.v2.js URL (typically d.{subdomain}.{domain}.com) as well as the trackURL (typically se.{subdomain}.{domain}.com) to match your vanity domains. This so that the JavaScript listener configurations on your website and within the Cordial Shopify app match, and all relevant events and revenue attribution are being tracked.

If you are using JavaScript listener v2 and customizing the JS base script in any way, such as using vanity domains, you will need to take the additional step of calling the matching Shopify initialization script after trackv2.js is loaded. This is done by updating the default cordialShopifyInit() function, which loads the v1 initialization, to load cordialShopifyInit(2) instead:

window.cordialLoaded = function() {
 cordialShopifyInit(2);
}

Map Attributes to Cordial

Once the Cordial app is connected to your account, and the necessary contact attributes created in your Cordial account, you can start mapping Shopify customer fields to your contact attributes in Cordial.

Order and product attributes that are unique to Shopify and do not exist in Cordial will be stored as additional properties of the respective Cordial order or product data collections.

1. Navigate to the attribute mapping page by choosing Key Mapping from the Main Menu dropdown in the top right of the Cordial Administration page.
   
2. On the Attribute Mapping page, choose a Shopify field you wish to map from the dropdown menu. The selected field will automatically be added to the top of the existing list of keys.
   
   
3. Enter the corresponding Cordial contact attribute name to the right of each Shopify customer field.
   Note: Cordial contact attributes you wish to map must already exist in your Cordial account. Attributes that do not exist in your Cordial account will not be created automatically.
4. You can Test your key mappings to check for errors.
5. Click Save once all Shopify customer fields are mapped to their corresponding Cordial contact attributes.

Note: The Reset to Default Mappings button will reset all key mappings for first name, email and subscribed status fields to their default values.

Map to Array Attributes in Cordial

You can map Shopify customer fields to array type contact attributes in Cordial using the split(,) array modifier.

For example, to map the Shopify customer tags field to the Cordial tags contact attribute, use tags|split(,) within the Shopify key mapping field. Shopify customer tags will be inserted as an array into the Cordial tags contact attribute.

Synchronize Product, Customer, and Order Data

When synchronizing data from Shopify to Cordial, there are two options: manual synchronization and automated recurring synchronization. Normally, you would use the manual method to perform a one-time syncchronization of historical data, and then set a recurring schedule for all future automated data posts. Note that these data synchronizations use API calls to post data.

Synchronization is a One-Way Post

Note that synchronization is a one-way post of contact, product and order data. Data is posted from Shopify to Cordial and not in reverse. For example, if a contact attribute is updated in Cordial (i.e. first name), it will not be updated in Shopify.

Synchronizing Subscribe Status

The synchronization of subscribe status changes depending on the contact's status in Cordial. Shopify key for email subscribe status is accepts_marketing: yes/no, which is mapped to Cordial's email subscribe status key of channels.email.subscribeStatus: subscribed/unsubscribed.

The table below displays how subscribe status is updated after synchronization:

Note above that if a contact has unsubscribed from receiving promotional emails in Cordial, it is not possible to change the subscribe status to subscribed as a result of a Shopify synchronization. Also, if a contact is subscribed in Cordial, it is not possible to change subscribe status to none as a result of a Shopify synchronization.

Manually synchronize historical data

After mapping attributes to your Cordial account, you should synchronize all desired historical data from Shopify. This will ensure that your Cordial account is up to date with product, customer and order data from your Shopify account.

Navigate to the Cordial Admin page from the Main Menu dropdown.

On the Cordial Administration page, locate the Jobs section and click Run Now for the desired data collections under the Sync All heading. Doing so will synchronize all historical data in the selected collection, regardless of creation date.

Automatically Synchronize Data on a Recurring Schedule

Once you have manually synchronized your data, you can set a recurring interval to automatically synchronize any new and updated data moving forward.

In the Jobs section of the main Cordial Administration page, enter the recurring synchronization interval in minutes (2 minute minimum) for each data collection and click Enable. To disable a running synchronization, click the corresponding Enabled button.

Check for synchronization errors

API call errors can cause data not to post successfully to your Cordial account. Navigate to the Job Logs page where API errors will be listed, along with past synchronization jobs.

The Job Logs page will list the last 100 jobs. Use the Refresh button in case your recent jobs are not listed immediately. In-progress jobs can be canceled by pressing the ✖ button in the Actions column.

Your Shopify account is now configured and synchronized with your Cordial account. You'll now be able to build audiences and trigger messages based on data collected from your Shopify store.