| [ Web Proxy ] |
| Viewing: https://dev.extole.com/docs/shopify | [Back] [Original] |
Shopify Plus is an enterprise-level commerce platform designed for high-volume merchants.
Launch dynamic programs like Refer A Friend and Drop a Hint with the Extole and Shopify Plus integration. By following this guide, you can place targeted CTAs and experiences throughout your storefront and checkout experiences, track customer activity in real-time, and reward customers using Shopify Discounts.
| Requirement | Description |
|---|---|
| Shopify App | Install Extole's Shopify app on https://apps.shopify.com/extole. |
| Extole Access Token | You'll need to generate a long-lived access token in order for Shopify to use Extole's authenticated RESTful APIs. Generate your token within the Security Center of your Extole account. |
| Branded Program Domain | You must create a branded Program Domain in your Extole account. More information about Program Domains. |
| Whitelisted Shopify Domain | Make sure you have extensions.shopifycdn.com as an allowed site under the Production Sites Extole Should Support Requests Fromin your Branded Program Domain https://my.extole.com/tech-center |
Begin the integration from the Partners page in your Extole account or from the Shopify App Store by clicking "Install." Then, follow the steps below.
First, configure your core settings to begin adding Extole tags to your Shopify storefront.
Find your Branded Program Domain in the Tech Center of your Extole account under Program Domains. It's usually in the format of share.brand.com.
[Copy your branded program domain in the Extole Tech Center]Copy your branded program domain in the Extole Tech Center
To generate your Extole Access Token, go to the Security Center and follow the instructions to create a new token. Copy and save the access token in a safe place, as you wont be able to access it beyond this point.
[Click + New Access Token in the Extole Security Center]Click + New Access Token in the Extole Security Center
Once you've gathered your Branded Program Domain and Extole Access Token, log in to your Shopify account and go to the Extole app. In Step 1 of the app configuration process, paste in your domain and token and hit Save.
[Paste your Extole branded program domain and access token into the Extole app in Shopify]Paste your Extole branded program domain and access token into the Extole app in Shopify
Enable your Core Settings to add Extole's Core Javascript tag to your Shopify pages.
[Make sure Core JS is enabled in the Extole app in Shopify]Make sure Core JS is enabled in the Extole app in Shopify
After configuring your core settings, you can begin to add CTAs (calls to action) by integrating Extole's marketing tags into your Shopify store.
Marketing tags are for Liquid themes only. If you are on Shopify's headless theme, Hydrogen, you can add marketing tags directly through your front end. See here.
Hydrogen customers can continue to use Extole's app to set core settings, automate discounts, promote through checkout extensions, and send webhook events.
Navigate back to Extole to begin enabling the Marketing tags for the CTAs that you would like to place throughout your store. These can be found in the Campaign Editor for your program in the Marketing tab.
[CTAs like Global Header, Overlay, and Mobile Menu are found under the Marketing tab of Extole's Campaign Editor]CTAs like Global Header, Overlay, and Mobile Menu are found under the Marketing tab of Extole's Campaign Editor
Once you enable the Global Header, Global Footer, Overlay, and Product CTAs in your Extole account, youll then need to return to your Shopify account to begin placing the marketing tags throughout your store. Select the Marketing Tags wherever you'd like to market your program (Global Header, Global Footer, etc.)
[Select your enabled marketing placements in Shop]Select your enabled marketing placements in Shop
Next, in order for Extole content like "Refer and get $20"to display on your Shopify store, you'll need to name the zone in Shopify. To name the zone, navigate to the Extole CTA Tag from the Theme Editor menu.
Select the corresponding name in the drop-down. You can also modify the event data thats passed through the tags at this point.
While the marketing tags will automatically display in the corresponding area of your storefront, they can be dragged and dropped anywhere and re-named accordingly using the drop-down and custom zone fields in Shopifys App Embeds UI.
When configuring Extole's marketing tags, data such as email, first_name, last_name, partner_user_id, and locale is collected by default depending on the users logged in state. You also have the option to specify any custom data for additional tracking and segmentation capabilities.
To specify custom data in your marketing tags:
The custom data should be formatted as key-value pairs within a JSON object. You can include both static and dynamic data points.
Example of Custom Data Format:
{
"static_variable": "foobar",
"dynamic_product_url": "{{product.url}}"
}
In this example:
static_variable is a static data point with a fixed value foobar.dynamic_product_url is a dynamic data point that retrieves the product URL from the Shopify platform using Shopify's Liquid syntax {{product.url}}.Shopify's Liquid objects provide a range of dynamic data points that can be included in your custom data.
Use the Liquid syntax {{variable}} to represent dynamic substitution variables. The integration supports a subset of Liquid objects, and support may vary between platforms.
By default, when a user taps on a CTA in your Shopify store, Extole will load the sharing experience via a pop-up that overlays on top of the page.
If you prefer to land users on a separate referral page that has the sharing experience embedded onto the page, you can create a new page in Shopify and add a custom App Embed using the Shopify theme editor to embed the sharing experience.
[Example of an embedded referral page]Example of an embedded referral page
First, configure the following in your Extole campaign:
referral_page creative
[]
promote_destination URL ("Destination for Clicks on Promotions")
[]
Update each of your Marketing Zone CTAs to Redirect CTA Clicks to the Promote Destination
Then, create your page in Shopify and add an Extole CTA Tag app block to wherever you would like to embed the referral page experience. To load the Extole content, select Custom as the Zone in the Extole CTA Tag app block, and name the Custom Zone referral_page.
[]
Checkout Extensibility RequirementIn order to use Extole's Checkout Extension on your Shopify store, you must migrate your Thank You and Order Status pages to Shopify Plus' Checkout Extensibility UI.
Use the Checkout Extension to add a Referral CTA to your Thank You and Order Status pages.
Promotion Clicked event in Flow Builder. From there, select New Contentand click on the filter icon to select the Shopify Components option. From there, add the Shopify Checkout Extensionand apply changes to your campaign.
[]
[]
Navigate to the Extole App admin in Shopify and enable the Checkout Extension.
Then, to place the Checkout Extension on your Thank You and Order Status pages, navigate to the Theme Editor.
From the dropdown menu in the Theme Editor, select the "Thank You" or "Order Status" section.
Click "+ Add app block" in the Sections area.
Select the "Extole Checkout Extension" from the list. Once selected, the extension will be added to the page.
Repeat these steps for both the Thank You and Order Status pages.
You can then edit the Checkout Extension image and styling in the Extole Flow Campaign Editor.
By default, when you install the Extole app, a conversion pixel will be automatically added to your Thank You page to send Extole a conversion event. There is no action required to add the pixel to your page.
Follow the instructions below to automatically create Shopify discount rewards for your various programs.
Important NoteIf you are using these discount codes for your referral program, Extole recommends creating separate Discounts for advocates and friends.
After configuring your core settings, marketing tags, and rewards, you can optionally adjust the notification events that are sent to Extole every time an order is created, fulfilled, and canceled in Shopify. These events enable functionality like tracking, attribution, rewarding, reporting, and segmentation in the Extole platform, so its recommended to stay with the defaults and keep all notification events enabled.
In the latest version of this integration, there is no configuration needed for Pixel. When you install the integration, Pixel is automatically added to the checkout page.
Real-time notifications allow you to track key events in your program, such as when an order is created, fulfilled, or canceled.
To send additional notification events, follow Shopify's documentation for creating webhooks
JSON as the webhook format when creating your webhook in Shopifyhttps://api.extole.io/v5/events/{{event_name}}?access_token=XXXXXXXXXXXXXX
{{event_name}} with the name of the event you want to create in the Extole platform when sending this webhook - e.g order_canceled or list_optinXXXXXXXXXXXXXX with the Access Token you created in the Extole Security CenterWhen an online purchase is completed, you can specify which data parameters are sent to Extole. These data parameters enable essential tracking and reporting in the Extole platform.
partner_conversion_id: This parameter is essential for tracking. It's selected by default and cannot be deselected. It typically represents the order number or a unique identifier for the transaction.email, partner_user_id, first name, last name, locale, and coupon_code: These parameters provide more context about the customer and the transaction, which can be useful for segmenting and analyzing your data.If you want to track additional data that is specific to your business, you can indicate custom key-value pairs. For example, you might want to track the product category of the purchased items or the marketing channel that led to the referral.
We support multiple Shopify stores in a single Extole account. For example, if you have US Shopify and UK Shopify stores, you should take the following steps.
Once you've configured the app, preview your Shopify site and your Extole campaign and publish your changes to apply them to your live site.
We can work with you to get the app setup in your staging environment. Typically, this involves adding a test sandbox to the data we receive.
No. Your existing CTAs will work with the app and do not need to be re-implemented.
The app will track orders by default, but if you have set up a lot of custom tracking we can configure the app to work in conjunction with what you have done.
Cookie-based tracking in the app functions the same way as your existing Extole integration so if Extole is not currently being affected, the app won't change that.
We can continue to use the codes you have already given us. In addition, the app gives you the option to let Extole create codes on the fly for youso there's no need to upload coupons to Extole once the new rewards are configured.
Updated 3 months ago
| Web Proxy Viewer | New URL | Original Page |