This version of the Shopify app will be supported until May 2023. For the new version of the app, see Implementing Dynamic Yield on Your Shopify Store [New].
The Dynamic Yield Shopify app enables you to quickly implement Dynamic Yield on your Shopify website. The app sets up:
- Dynamic Yield scripts on every page
- Page context
- e-commerce events (Purchase, Add to cart, Signup, Login, Newsletter subscription, Remove from cart, Sync cart content, Change attribute, Search)
- Product Feed sync to Dynamic Yield
When the Dynamic Yield 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 is fired when a matching event is identified. One webhook (app/uninstalled) is 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 your store's front end. These files are usually necessary for app functionality. One ScriptTag (onload/display_scope:all) is 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 is synchronized to Dynamic Yield once every 12 hours (at 2 am and 2 pm EST). The SKU and group ID in the product feed are the same, and match the product ID in Shopify. This means that the feed does not include different SKUs with the same group_id (variations). They 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.
Implementation Guidelines
- The app works best for shops that have no modifications to either the Add to cart or Purchase events, or to the standard product feed.
- The app works best in its original, unmodified form.
- The app does not support using variant IDs.
- The app does not support multi-language sites.
If you have modifications or plan to make modifications to your feeds, events, or to the app, contact your Customer Success Manager for assistance.
Installing the Shopify extension
Before you begin, make sure you have the site ID, access key, and secret access key. If your Customer Success Manager created your Dynamic Yield site for you, make sure they provide it. If you are creating your first site yourself, the information is provided 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 does not affect your Shopify Store or harm your app in any way.
- In the window that opens, click Connect App. The Dynamic Yield Shopify App settings page appears.
- In the Account Settings window, 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 the Dynamic Yield CDN and US servers (standard), do not change any of the advanced settings.
- If you are using the Dynamic Yield 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 the EU servers).
- Click Save. The first time you save, a product feed upload of your products to the Dynamic Yield Server is initiated. This might take some time. The next times you save, this does not happen, and any changes you make to the settings are 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 following 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 the snippet is added:
- Layout/theme.liquid
- Snippets/dynamic_yield.liquid
These items are required because the Dynamic Yield 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 theme by adding this line just before the closing </head> tag:
{% include 'dynamic_yield' %}
- If you are using Shopify Plus and you use 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 is 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' %}