Overview
The Dynamic Yield – Shopify app provides a quick and seamless integration with Dynamic Yield and enables an automatic implementation of Dynamic Yield’s eCommerce solution to include:
- Dynamic Yield tracking script implementation
- Context API implementation
- eCommerce events implementation (Purchase, Add to cart, Signup, Login, Newsletter subscription, Remove from cart, Sync cart content, Change attribute, Search)
- Product Feed (catalog) export
When the Dynamic Yield Shopify App (DY Shopify App) is installed into your Shopify store, Webhooks and ScriptTags required by the App are created in the background for your store:
- Webhooks: A Shopify event trigger that will be fired when a matching event is identified. One webhook (app/uninstalled) will be created in your store upon installation to control any uninstall routines associated with our app being removed from your store.
- ScriptTags: Javascript files associated with a Shopify App that run on the front-end of your store. These files are usually necessary for the functionality of the app. One ScriptTag (onload/display_scope:all) will be created in your store upon installation.
In Shopify, a snippet is injected into the theme: /snippets/dynamic-yield.liquid. In the layout/theme.liquid file an include statement for the snippet is added just before the </head> tag. If you modify your Shopify theme at any time after this installation, make sure the include statement still exists.
{% include 'dynamic_yield' %}
Your Shopify Product Feed will be synchronized to Dynamic Yield once every 12 hours (schedule for 2am and 2pm EST). The SKU and group id in the product feed will be the same, and will match the product id in Shopify. Meaning that the feed will not have different SKUs with same group_id (variations). They will also match the context data and event data implemented on the site.
Note: If the product feed from Shopify requires manipulation in Dynamic Yield, you need to manually upload and synchronize a different product feed directly to Dynamic Yield. For details, see Creating and Syncing a Product Feed.
How to Install the Shopify Extension
- If your Customer Success Manager has created your first Dynamic Yield site for you, make sure they have provided you with the site ID, access key, and secret access key. If you are creating your first site yourself, you will receive the site ID, access key, and secret access key in an automated email.
- Go to https://sca.dynamic-yield.com/
- Enter your Shopify Domain and click Install.
- In the window that opens, click Install unlisted app. Ignore the message that the app is not in the store. Installing the app will not affect your Shopify Store or harm your app in any way.
- In the window that opens, click Connect App. You will be taken to the DY Shopify App settings page
- In the Account Settings window that opens, enter the Dynamic Yield Site ID, Access Key, and Secret Access Key.
- You can specify additional data to be sent in the Product Feed:
- Compare at price: The original price of products that are on sale.
- Product vendor: The brand associated with the product.
- Select any additional fields to include in the product feed keyword field.
- If you are using Dynamic Yield's CDN, and using Dynamic Yield's US servers (standard), do not change any of the advanced settings.
- If you are using Dynamic Yield's EU servers, select Europe for both the CDN Locator and the Product Feed Upload Location.
- If you are using a custom CDN, select Custom for the CDN Locator (even if you are using Dynamic Yield's EU servers).
- Click Save. The first time this is done it will trigger a product feed upload of your products to the Dynamic Yield Server and may take some time. Re-saving your Product Feed Settings will not automatically begin another sync. Any changes you make to your settings will, however, be included in the next scheduled Product Feed Sync.
- In Shopify, a snippet is injected into the theme: /snippets/dynamic-yield.liquid. In the layout/theme.liquid file an include statement for the snippet is added just before the </head> tag. If you modify your Shopify theme at any time after this installation, make sure the include statement still exists.
{% include 'dynamic_yield' %}
- If you are using a repository in your work with Shopify, make sure you pull in the following items after installing the DY Shopify App and after we have included the snippet:
- Layout/theme.liquid
- Snippets/dynamic_yield.liquid
These items are required because the DY Shopify App injects the dynamic_yield.liquid snippet into the Published theme in the Snippets folder, and the snippet is manually referenced by editing the theme.liquid file in the published them by adding this line just before the closing </head> tag:
{% include 'dynamic_yield' %}
- If you are using Shopify plus and you are using the checkout page, you also need to pull dynamic_yield_purchase.liquid into the repository. In the checkout.liquid file an include statement for this snippet will be added immediately after the existing include statement as shown below. This should appear after {{ checkout_scripts }} but before </head>
{% include 'dynamic_yield' %} {% include 'dynamic_yield_purchase' %}