Shopify

You can integrate your website built on the Shopify platform. The scope of integration involves the transmission of the following data from Shopify to Synerise:

• information about the customers (their activity, identification of a customer, customer data update, customer logging in and out),
• information about the transactions (purchase, cart status),
• information about the items (item updates, adding and removing items)

Scope of tracked events

The table below contains the list of events tracked by default.

Prerequisites

• You must have access to admin panel in the Shopify platform.
• Create a tracking code in the Synerise portal

Configuration in Shopify

Implement tracking codes in your shop

In this part of the process, you will need to implement Synerise tracking codes in two places:

1. A pixel in the Shopify admin panel
2. The store’s theme’s code

Adding a pixel with the tracking code

1. Go to Admin panel > Settings > Customer events.
   Result:

   

2. Click Add custom pixel.
   Result: A pop-up appears.
3. In the Pixel name field, enter the name of the pixel.
   This is only for identifying the pixel on the list of pixels.
4. Click Add pixel.
   Result:

   

5. Leave the settings in the Customer privacy section at default.
6. In the Code section, enter the Synerise tracking code from the Tracking code for Shopify pixel section which you created as a part of prerequisites.
7. In the upper right corner, click Save.
8. At the bottom of the Code section, click Connect.
   Result: Tracking of the following customer activities starts:
   • adding or removing an item from the cart
     These two activities generate product.addToCart and product.removeFromCart events in the Synerise platform on the card of a customer. These activities also generate a cart.status event. The parameters of all these events contain the IDs of the products.
   • viewing a page - This activity generates a page.visit event and triggers tracking the cart status. The basket contents are saved in the browser’s local storage (in a _snrs_cart_state parameter), so when a customer visits the website, the contents of their cart are checked as well as the list of IDs of product they visited.
   • logging in and logging out - These activities generate client.login event and client.logout event events, respectively

Adding the tracking code to the store theme code

2. In the Shopify admin panel, go to Online Store > Themes.
3. On the theme you currently use, click the Customize button.
4. In the upper left corner, click the three dot icon.
   Result:

   

5. From the dropdown list, select Edit code.
6. In theme.liquid.html, enter the Synerise tracking code from the Tracking code for store’s theme code section which you created as a part of prerequisites.
7. Save the changes.
   Result:
   • When a customer visits a product page, a page.visit event with the item’s SKU is generated.
   • All other activities defined in the Scope of tracked events are tracked.
   • dynamic content can be used on the store website.

Create custom application

1. Go to the Shopify administration panel.
2. Create a custom application according to the instruction in the Shopify documentation. Set the following permissions for the custom application:
   • read_customers,
   • read_products,
   • read_orders,
   • write_script_tags,
   • write_pixels,
   • read_pixels,
   • read_customer_events
3. Install the custom application.
   Result: A window with API key, API secret, and Admin access token is displayed.
4. Keep the view open.
   You will need the data for the configuring the plugin in the Synerise platform. This is the only time you can view the API Admin access token.

Configuration in Synerise

1. In Synerise, go to Settings > Apps & Services.
2. On the list, find Shopify and click Show.
3. From the Select connection dropdown list, select the connection.
   If you haven’t established a connection yet, see Create a connection.

Create a connection

After you installed the custom application in Shopify, use its data to establish a connection.

1. In the Shop name field, enter the name of your shop.
   You can find it in the URL, for example: https://[myshopname].myshopify.com
2. In the Shopify API key field, enter the API key from the API key and Secret key section in the custom application.
3. In the Secret key field, enter the Secret key from the API key and Secret key section in the custom application.
4. In the Admin token field, enter the value of the API Admin access token field from the custom application.
5. Click Next.
6. In the Integration name field, enter the name of your integration.
   It will be visible on the connection list only.
7. Make a connection by clicking Apply.

Enabling ongoing synchronization

You can start synchronizing data between your shop and Synerise once the connection has been made. The synchronization runs in real-time. If you want to synchronize historical data, see “Synchronizing historical data” section.

To start automatic synchronization of a specific scope, enable the respective option on the interface (Customers, Orders, Products).

In the “Scope of tracked events” section of this article, you can check the events which will be sent to Synerise as a result of enabling ongoing synchronization.

Synchronizing historical data

To send historical records from your shop to Synerise, you must manually initiate the historical data synchronization process. This process doesn’t occur automatically.
In the “Scope of tracked events” section of this article, you can check the events which will be sent to Synerise as a result historical data synchronization.

1. In the Synchronize historical data section, click Add synchronization.
   Result: A pop-up appears.
2. On the pop-up, in the Synchronization name field, enter the name of the synchronization.
   It will only be visible on the list of historical data synchronizations.
3. From the Data type dropdown list, select scope of data you want to synchronize:
   • Customers
   • Orders
   • Products
     In the table at the beginning of this article, you can see what kind of information is synchronized and in what form they are available in the Synerise platform.
4. In the From field, enter the date from which you want to import data to Synerise.
5. In the To field, enter the date to which you want to import data to Synerise.
6. Start the import by clicking Launch.