_________________________________________________________________________________

This article will review:

• How the Partnerize Shopify Integration functions
• How to install the application and enable all features
• What tracking features are included
• Access to additional technical documentation

_________________________________________________________________________________

Index

• Overview
• Cookie Consent
• Traditional Storefront vs. Headless Storefront
• Implementation Steps
• Tracking Parameters
• Testing
• Validation
• Next Steps

Overview

Partnerize's Shopify application provides seamless integration for brands using Shopify — whether as a full eCommerce platform (Traditional Storefront) or just for checkout (Headless Storefront). It captures conversion data using first-party cookie tracking and Shopify webhooks, ensuring accurate, reliable tracking without relying on third-party cookies.

The application creates a pixel, which is then implemented onto all site pages to ensure that first-party cookies are stored with information on the last click from a partner. Conversion information is then sent from checkout using webhooks directly to the Partnerize API. These webhooks automatically read the transactional data from Shopify and send it to Partnerize for purchase tracking, which reduces the need for any complex integration and development work.

In addition to conversion tracking, the integration will also handle the validation of transactions where items have been returned, based on the transaction statuses within Shopify.

_________________________________________________________________________________

Cookie Consent

Partnerize's first party tracking relies on a click ID (clickref) being stored either client or server side as a 1st party cookie. If the clickref isn't stored, then in most cases, Partnerize is unable to attribute the conversion to a click and the sale won't be attributed.

While the treatment of cookies on a client's website is ultimately a decision for that client, some cash-back and loyalty partners have informed Partnerize that they may choose not to work with advertisers who restrict the cookies for their programs until after a website visitor provides affirmative consent.

However, any desired changes to cookie consent settings can easily be implemented for your Partnerize affiliate program.  Please see technical options here.

_________________________________________________________________________________

Traditional Shopify Storefront vs. Headless Shopify Storefront

There are two options for integrating with Partnerize via the Shopify app: 

1. Traditional Shopify Storefront : 
   • What is it : 
     • Advertisers use Shopify as their full eCommerce platform (front end / back end) which is hosted and built by Shopify
     • Pages like product, homepage, collections are all controlled in Shopify
   • Implementation Note : 
     • Simply download the Partnerize’s Shopify app 
2. Headless Shopify Storefront : 
   • What is it : 
     • Advertisers use Shopify for their eCommerce backend (e.g., product management, order processing, and checkout)
     • Front-end website is custom built and not controlled by Shopify 
   • Implementation Note
     • Download the Partnerize’s Shopify app 
     • Since front-end is not controlled by Shopify (de-coupled), additional Partnerize Tag is required 

________________________________________________________________________________________

Implementation Steps

1 Install Application

1.1 Advertisers upgrading to the latest Shopify app: 

Advertisers that are currently integrated via the Shopify app and upgrading to the latest version must also uninstall the older version of the app to ensure that tracking is not duplicated. To uninstall:

• In Shopify, navigate to Settings -> App and sales channels -> Click on the 3 dots -> Uninstall

If you are not in extensibility checkout, you must also remove the pixel script: 

• Settings -> Checkout -> At the bottom, “Order status page additional scripts”.

1.2 Advertisers installing the Shopify app for the first time:

• Within the Shopify App Store, locate the Partnerize app 
• Click 'Add app'
• Choose the store for which the app should be installed
• Click Install App:

________________________________________________________________________________________

2 Configure Application

Once the application has been installed, the configuration screen is split into two sections:

• Partnerize Account Information
• Tax Settings
  • This option will only be displayed if a specific store setting is enabled.  This is covered in more detail below

❗NOTE: In order to configure you must have access to the Partnerize platform to obtain specific details, contact your Partnerize Customer Success Manager for more information.  

2.1 Partnerize Account Information:

The below information is required to configure the app, which can be obtained via the Partnerize platform: 

• User Key : (Settings > Your Account > User application key) (first key)
• API Key : (Settings > Your Account > User API key) (second key)
• Brand ID : (Settings > Brand and Program > Advertiser ID)
• Campaign ID : (Campaign drop down > Settings > ID at top left)

Input the required values and click Save.

❗NOTE: If an error is returned stating "You do not have "update" access on this resource", check that the keys and IDs entered are correct. 

2.2 Tax Settings:

The purpose of this setting is to ensure that the correct item value tracks for each item within a transaction.  The overall store settings dictate whether or not the tracked item value will include taxes.  If the brand wants to ensure that the NET item value is tracked (value minus any taxes), then this setting should be used.

To ensure that any taxes are deducted from the tracked value, the 'Track NET item value' setting should be enabled, and then the local tax value should be entered as a percentage (i.e. 20% as shown in the above example).  This will then be automatically deducted from the item values.  Click Save.

This section will only appear if the 'All prices include tax' setting is enabled with the 'Taxes and duties' section of the Shopify store.  This is a store level setting and is independent to the Partnerize application:

_________________________________________________________________________________

3 Conversion Tracking Webhook 

As part of the configuration, Shopify will send Partnerize a webhook for every conversion unconditionally.

_________________________________________________________________________________

4 Additional Partnerize Tag ( Headless Storefront Only )

Advertisers that solely use Shopify for their backend products/checkout (Headless) require an additional step to capture our unique Partnerize ID (“clickref”) and store it as a first-party cookie. This involves implementing an additional javascript (Partnerize Tag) on each of your website’s pages in addition to installing the Shopify app.

4.1 Where Is the Partnerize Tag Located?

The Partnerize Tag can be managed in the platform using the Partnerize Tag setup interface, which can be located in the Settings section of the drop-down menu at the left end of the top menu.

4.2 Partnerize tags

Here you can create and manage tags for your websites.  To create a tag, click Create a new tag +

Enter a name for the tag in the Value field, then click Save at the bottom of the screen. The new tag will now be added to the list of displayed tags, and set to a status of Enabled.

❗NOTE:  Once you create the tag, make sure you enable 1st party tracking on the list of features. Please reach out to Partnerize support if you have issues enabling as this is required to activate the “clickref” capturing. 

4.3 Implementation of Partnerize tag

Copy the JS code from the right-hand side of the dashboard and place it on ALL pages of the site.  The following should help you determine which pages the tag should be present on:

• Any page of which an inbound referral may land on
• The checkout confirmation page

Example Partnerize landing page tag

<script src="https://pzapi-kg.com/b/XXXXX/YYYYY.js"></script>

• The domain (pzapi-kg.com) may differ for your exact tag
• XXXXX will be replaced by the brand ID
• YYYYY will be replaced by a specific tag ID

❗NOTE:  JS code placement is recommended within the <head>

_______________________________________________________________________

Tracking Parameters

Partnerize’s Shopify App captures the following data points for each conversion

❗NOTE:  If you need to track additional data points, please consult with Partnerize support to explore your options. Post-sale modifications will be required.

_______________________________________________________________________

Testing

Testing should be done by submitting a test transaction via the brand’s live website.  A non-session test should be performed, which simulates a returning customer who originally followed a partner link but purchased at a later date. Providing the sale is made within the cookie period of the brand, the transaction should track successfully.

Testing Instructions

• Follow a test partner link. To obtain a link, go to the ‘Partners’ section of the Partnerize platform, locate the ‘test’ partner account, copy the tracking link and paste it into the browser window.  Email integrations.support@partnerize.com if you cannot locate the link
• Let browser load page
• Once loaded, exit browser
• Reopen browser and go directly to brand site without following test link
• Purchase multiple items (if applicable)
• Save order number with purchase costs
• Provide order ID to integrations.support@partnerize.com

Expected Outcome

• Transactions is recorded in the Partnerize dashboard
• All parameters are populated correctly, and that the conversion call is correctly formatted.  The following parameters should be checked closely:
  • Value - Ensure that this is populated with the NET item value for each item
  • Currency - Ensure that this is populated with the correct currency used at point of sale
  • Clickref - Check that the most recent clickref has been passed into the parameter
• Check that the tracking solution has been fired from the live confirmation page

_________________________________________________________________________________

Validations

The Partnerize Shopify application will automatically process transaction validations for returned items between Shopify and Partnerize, to ensure that transaction statuses are in sync across the two platforms. For example, if an order status in Shopify has been set to REFUND, whether this is for all items within the order or only individual items within the order, the conversion item status will be automatically updated to ‘rejected’ within the Partnerize system. The validations are performed using a webhook that gets fired from Shopify every time an order changes i.e. returns. This change will be reflected in the Partnerize system shortly after the update within Shopify.

Approvals would need to be handled separately within the Partnerize platform, by either;

• Manually approving any transactions which remain in a pending status
• Setting a force approval period, to automatically approve any remaining pending transactions after a specified number of days, typically once the returns period has passed

❗NOTE:

The validations job will only sync the statuses between Shopify and Partnerize once the Shopify status for the item/order is set to REFUNDED, not RETURNED.

_________________________________________________________________________________

Next Steps

• Request a campaign_id from the Partnerize Integration team.  Email integrations.support@partnerize.com if you do not already have this.
• Install the Shopify application and apply all configuration settings using the instructions above.  Inform the Partnerize Integration team once this has been completed
• Perform testing using the above instructions - Transactions will need to be submitted via the brand’s live website, so that the implementation can be fully tested.