Shopify (beta)
Shopify is a cloud-based e-commerce platform that lets businesses of all sizes build and manage online stores, handle payments, and sell across multiple channels. Didomi has a native application available in the Shopify App Store that enables your organization to quickly deploy the Didomi CMP on a Shopify store. In this article, we will cover:
Prerequisites
Before continuing please ensure that your organization has satisfied the following prerequisites:
Shopify account
Didomi account
Published Didomi consent notice
Shopify consent categories
In the table below, find additional information regarding Shopify's Customer Privacy API and the consent categories that it supports. During the configuration of the Didomi app for Shopify, your organization will map purposes in your consent notice to these Shopify consent categories.
Analytics
Cookies to understand how customers interact with the site.
Marketing
Cookies to provide ads and marketing communications based on customer interests.
Preferences
Cookies that remember customer preferences, such as country or language, to personalize visits to the website.
Sale of Data
Indicates whether the store can share a visitorʼs data with third-parties (recommended for US specific purposes only). Click here for more information
Install Didomi application on Shopify store
Log into your organization's Shopify account with your credentials.
From the admin portal of a Shopify store, click + Add on the left-hand panel underneath the Apps header.
Click the Shopify App Store link.
Use the provided search field to search for Didomi Cookie Consent and select it from the results. Click Install on the page and follow any subsequent instructions.
The Didomi CMP application will be available under the Apps header in the left-hand panel.
Connect Didomi account to Shopify
Navigate to the Didomi CMP app installed on your Shopify store and click Connect to Didomi on the subsequent page.
If not yet logged into your Didomi account, follow the prompts to log into your organization's Didomi account.
Once your user account has been authenticated, use the provided drop-down menu to select the organization you wish to connect to your Shopify store. Click Connect this organization when finished.
Configure Shopify consent notice settings
With your organization's Didomi account connected to Shopify, you can now select and configure a Didomi consent notice to launch on your Shopify store. To start, navigate to the Choose Theme tab and use the provided drop-down menu to select a theme with an Active status.
After a theme is selected, navigate to the left-hand panel and select Settings underneath the Didomi app section.
On the subsequent Settings page, the Select a notice panel will list all published Didomi consent notices for your organization. Use the provided search field to locate your desired consent notice and select it by clicking the radio button to the left of the notice name.
With a consent notice selected, navigate to the Purpose mapping panel. For each purpose included in the consent notice, select a Shopify consent category that should be mapped to the purpose.
Multiple consent notice purposes can be mapped to the same Shopify consent category and the end-user's decision on purposes will determine whether the Shopify consent category is set to true|yes or false|no in the Shopify Customer Privacy API.
All consent notice purposes will need to be mapped to a Shopify consent category. However, not all Shopify consent categories need to be included in the mapping. Click Save when finished.
The selected consent notice will be displayed on your Shopify store in the region(s) you have configured in the Didomi console for the consent notice.
Configure Data sharing opt-out page - U.S. privacy regulations
If your organization targets end-users in the United States where data sale regulations apply (e.g. California), you can enable the Shopify opt-out mechanism that will add a link and page to your store so that end-users can easily prevent their data from being shared to third-parties.
Click Settings on the left-hand panel of the admin view of your Shopify store.
Select Customer privacy on the left-hand panel and then click Data sharing opt out page.
On the following page, use the Regions and content section to select where the opt-out page is active and the content of the opt-out page. Your organization can choose from Shopify's automated settings or to manually configure the applicable regions and content of the opt-out page.
Next, navigate to the Navigation section and use the provided drop-down menu to select where the link to the opt-out page should be for end-users in the applicable regions.
Click Save when finished to confirm the edits.
Configure pixel permissions
A pixel is a small snippet of code embedded on a webpage or in an app that sends data to a third-party server when triggered, typically to track user behavior, measure ad conversions, or enable re-targeting.
With the consent notice successfully added and configured in your Shopify store, your organization will now need to set the permissions for any pixels that require consent data so that they only fire when the appropriate Shopify consent categories are enabled.
To set the permissions of a pixel, click Settings on the left-hand panel of the admin view of your Shopify store.
Select Customer events on the left-hand panel of the subsequent page.
Use the provided workflows to either add a custom pixel or select an existing pixel on the list.
Navigate to the Customer privacy section for the pixel and expand the accordions for Permission and Data sale.
Use the provided fields to set the Shopify consent categories that need to be enabled by the end-user for the pixel to trigger successfully. Review the table for more information:
Marketing Analytics Preferences
Opt-in
These consent categories are set to no by default and are only set to yes when the end-user selects the purpose in the consent notice that is mapped to the respective category.
Sale of data (Data collected qualifies as data sale)
Opt-out
When either of the following permissions is enabled for the pixel the consent category is set to yes by default:
Data collected qualifies as data sale
Data collected qualifies as data sale and supports limited data use
In order to set the Sale of data consent category to no the end-user will need to either:
Reject the purpose that is mapped to the Sale of data consent category in the Shopify store consent notice
Reject the Sale of Data consent category in the Shopify checkout banner
Click Save when finished.
Test Shopify integration
Navigate to your organization's Shopify store and confirm the following tests:
Consent notice not displayed in excluded regions
From the end-user's experience of your Shopify store, verify that the consent notice does not appear in region(s) that have been excluded in the Didomi consent notice configuration.
When a region is excluded (and therefore the consent notice is not displayed), your organization can open the browser's developer tools and use the following method calls to verify the expected output for the Didomi API and Shopify Customer Privacy API, respectively.
Use the Didomi.getCurrentUserStatus() method call to return the current end-user's consent status for Didomi.
Since consent is not required and a consent notice was not displayed, the method call should return an object where consent for all purposes and all vendors are set to true.
Use the Shopify.customerPrivacy.currentVisitorConsent() method call to return the current end-user's consent status for Shopify.
Since consent is not required and a consent notice was not displayed, the method call should return an object where consent for each Shopify consent category is set to yes.
Didomi consent signals
For regions where consent collection is necessary (and therefore the region is included and a consent notice is displayed), your organization will want to check that the end-user's consent decisions are captured correctly in the Didomi API.
Navigate to your Shopify store as an end-user and confirm that your selected Didomi consent notice is displayed on the page.
Make consent choices via the consent notice and submit the response.
Open the browser's developer tools and use the Didomi.getCurrentUserStatus() method call to return the current end-user's consent status for Didomi. Ensure that your selections are reflected in the settings in the purposes object.
Shopify consent categories
For regions where consent collection is necessary (and therefore the region is included and a consent notice is displayed), your organization will want to check that the end-user's consent decisions are mapped and captured correctly in the Shopify Customer Privacy API.
Navigate to your Shopify store as an end-user and confirm that your selected Didomi consent notice is displayed on the page.
Make consent choices via the consent notice and submit the response.
Open the browser's developer tools and use the Shopify.customerPrivacy.currentVisitorConsent() method call to return the current end-user's consent status for the Shopify Customer Privacy API. Ensure that your selections are reflected in the Shopify consent categories as configured in the mapping performed between Didomi consent purposes and Shopify consent categories.
Resources
See the following articles for more information on configuring your Didomi integration with Shopify:
Last updated