Not what you’re looking for?

Submit a Ticket
?

Partnerize Magento Integration

_____________________________________________________________________________________________________________________

This article will review:

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

_____________________________________________________________________________________________________________________

Index

Overview

Partnerize has a Magento application which allows brands that use Magento as their eCommerce platform to easily integrate their conversion tracking.  This integration uses a 1st party cookie tracking solution via a Partnerize tag. This ensures that the brand’s tracking is not reliant on 3rd party cookies, and is therefore ITP (and equivalent) compliant.  

The application enables brands to create and enable a Partnerize tag, which is then implemented onto all site pages.  The integration also implements a conversion tracking pixel to trigger at checkout, and automatically reads the transactional data from Magento to easily format the data, to be able to 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 Magento.

Implementation Steps

Install Application 

To install the application, follow the instructions provided below, searching for 'Partnerize' within the Magento Marketplace:

Configure Application 

Once the application has been installed, the configuration settings must be applied.  

__________________________________________________________________________________________________________________

NOTE:

Before configuring the cartridge, the below information is required, which can be obtained via the Partnerize platform: 

  • Application API Key (Settings > Account Settings > User Application Key)
  • User API Key (Settings > Account Settings > User API Key)
  • Brand ID (Settings > Brand Settings > Advertiser ID)
  • Campaign ID (This will be provided by the Partnerize Integrations Team)

If access to the Partnerize platform is required, contact your Partnerize Customer Success Manager for more information. 

____________________________________________________________________________________________________________________

Once this information had been obtained:

  • Access the Partnerize application via the Magento Admin Panel via Stores > Configuration > Partnerize > Conversion Tracking
  • There are four sections to review and configure:

Screenshot_2021-04-08_at_15.06.25.png

General Settings 

The General settings are where the previously obtained configuration information should be input: 

Screenshot_2021-04-01_at_10.54.54.png

  • Ensure that 'Enable Conversion Tracking' is set to 'Yes'
  • The 'Pixel URL' field should be pre-populated and should NOT be removed
  • Input the other required values
  • Click Save Config. This will automatically perform two actions:
    • Generate the Partnerize tag and deploy the JavaScript tag to all site pages
      • The tag will take approximately 15 minutes to propagate
    • Generate the conversion pixel tracking code and deploy the pixel to the store confirmation/check out pages
  • Go to Cache Management and flush the Magento cache for any cache types set to INVALIDATED, to apply the changes

Screenshot_2021-04-01_at_10.56.09.png

__________________________________________________________________________________________________________________

NOTE:

Partnerize has developed a first party pixel tracking solution which allows brands to track unique click referrals without the use of cookies, making it ITP compliant and a completely cookie-less tracking solution.

The First Party Tracking solution is a JavaScript tag which is placed into the bottom of the brands content on every page which a user may be redirected to and the resultant checkout page.  

____________________________________________________________________________________________________________________

Fields Settings

The Fields settings are where some additional pixel configuration can be applied:

Screenshot_2021-04-01_at_11.31.52.png

  • Category and SKU parameters will be populated with those fields by default.  If a different data parameter value should be passed into either Category or SKU, the alternative parameter can be chosen from the drop down
  • The Bundle Product option should be set based on how associated simple products should be tracked with Partnerize
  • Click Save Config to apply any changes
  • Go to Cache Management and flush the Magento cache for any cache types set to INVALIDATED, to apply the changes

Additional Fields Settings

The Additional Fields settings can be used to add more data parameters to the conversion pixel, should there be more granular transactional data available from the store data layer.  By default, the tracking pixel will include the following parameters:

  • conversionref (Order ID)
  • customertype
  • currency
  • country
  • voucher
  • category
  • sku
  • value
  • quantity

If more data parameters are available and are required to be added to the pixel, choose the Product Attribute from the drop down list, and specify the Partnerize parameter name that this should map to within the pixel:

Screenshot_2021-04-01_at_11.32.00.png

  • Click Save Config to apply any changes
  • Go to Cache Management and flush the Magento cache for any cache types set to INVALIDATED, to apply the changes

__________________________________________________________________________________________________________________

NOTE:

The values entered for Partnerize Field should be input as lower case, and any spaces separated by an underscore.  For example;

  • product_name
  • product_description
  • product_size

____________________________________________________________________________________________________________________

  • Click Save Config to apply any changes
  • Go to Cache Management and flush the Magento cache for any cache types set to INVALIDATED, to apply the changes

Conversion Tracking Pixel 

As part of the configuration, the Partnerize conversion pixel will also be implemented onto the brand website check out page, and will fire unconditionally (i.e. it will fire for ALL sales).  Therefore, the brand must ensure that there is a process in place for any cross channel duplication.  

The pixel will automatically read transactional data at check out, and format the pixel.  Example pixel below:

https://prf.hn/conversion/campaign:123456/conversionref:CC24000000050/customertype:new/voucher:testdiscount/currency:USD/country:GB/[category:Jackets/sku:MJ07-L-Yellow/value:46.08/quantity:1][category:Gear/sku:24-UG04/value:7.68/quantity:2][category:Shorts/sku:MSH01-36-Black/value:28.16/quantity:3]

If a Partnerize clickref has been set in the local storage cookie, the clickref will be retrieved and added to the pixel:

https://prf.hn/conversion/campaign:123456/conversionref:CC24000000050/customertype:new/voucher:testdiscount/currency:USD/country:GB/[category:Jackets/sku:MJ07-L-Yellow/value:46.08/quantity:1][category:Gear/sku:24-UG04/value:7.68/quantity:2][category:Shorts/sku:MSH01-36-Black/value:28.16/quantity:3]/clickref:1011lfFdsCjJ

__________________________________________________________________________________________________________________

NOTE:

Campaigns must have S2S tracking enabled to ensure that the Partnerize clickref is generated.  

____________________________________________________________________________________________________________________

Validation Settings

The Partnerize Magento application will automatically process transaction validations for returned/cancelled orders between Magento and Partnerize, to ensure that transaction statuses are in sync across the two platforms.  For example, if an order status in Magento has been set to CANCELLED, the conversion status will be automatically updated to ‘rejected’ within the Partnerize system.  

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 application will only handle full returns (i.e. all items within an order have been returned), or partial returns where all items of a single SKU have been returned.  If an item is set as partially refunded within Magento (i.e. >1 of the same item was purchased, but not all items were returned), the item statuses would need to be updated manually via the Partnerize platform to correctly reflect the correct status from Magento.

____________________________________________________________________________________________________________________

To enable the automated validation process:

  • Within the Magento Admin Panel, navigate to Stores > Conifguration > Partnerize > Conversion Tracking
  • Access Validation Settings:

Screenshot_2021-04-08_at_15.56.25.png

  • To enable automated validation processing, set 'Automate Conversion Validation' to 'Yes'
  • Set the 'Frequency for Conversion Validation' - options available are once or twice daily
  • Click Save Config
  • Go to Cache Management and flush the Magento cache for any cache types set to INVALIDATED, to apply the changes

Testing

Once the tags are deployed, they should be tested 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 source code from thank you page and order/transaction 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

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 Magento 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.  

Questions

If you have any technical questions with regards to this document, please contact our onboarding specialists at  integrations.support@partnerize.com 

Was this article helpful? 0 out of 0 found this helpful

Didn't get the answer you need?

Get in Touch