- 16 Jan 2025
- DarkLight
WooCommerce (WordPress)
- Updated on 16 Jan 2025
- DarkLight
Compatibility Notice
The Awin plugin has only been validated with standard WooCommerce themes. We provide no guarantee that the plugin will be compatible with other themes.
Supported Tracking Types & Features
Method and feature support notes are based on the latest available plugin version. If a feature is not present on your shop, please ensure you have updated the Awin plugin.
Each of these tracking methods is required for compliance with our Tracking Policy. To review the Awin Tracking Policy, please reach out to your Awin point-of-contact.
✅ Conversion Tag
✅ Fall-back Conversion Pixel
✅ Server-to-Server (S2S)
✅ Deduplication
✅ Customer Acquisition
✅ WordPress Multisite
Installation and Configuration
Current Plugin Version: 1.2.0, compatible with WordPress 3.5 - 6.4.5 versions (PHP versions 7.3 and higher).
The most efficient way to integrate Awin’s tracking with your site is to use our provided WooCommerce plugin, available in the WooCommerce Plugins directory.
After you’ve installed the plugin, you’ll need to set your Advertiser ID. If you’re unsure, you should have received this ID from your assigned integrator or you can find it in the Awin UI > Account > Overview
.
The Awin plugin for WooCommerce stores includes our Hybrid tracking solution with its benefits. The plugin will trigger the tracking tags on order confirmation pages and the tracking tags will include all aspects of tracking, including the Awin Mastertag on all pages, client-side conversion tags, fallback image pixel and server-to-server tracking.
Stuck? Check out our WooCommerce Integration video tutorial:
Tracking Features
The plugin utilizes the source
query parameter from the landing page URL and passes this value along to the channel parameter of our tracking request for deduplication purposes.
It is important to note that only the source
query parameter will be used for deduplication, not the more commonly used utm_source
parameter. You should ensure that the source parameter is correctly configured for your program. Your Awin point of contact can assist you with changes to this configuration.
To implement this on Awin’s side, a source=aw
query parameter will be appended as standard with WooCommerce plugin setups under Default Query String Append in the Tracking Settings.
Additionally, the plugin creates a cookie named source
to store the value of the source
parameter. This value will update accordingly each time the value of this parameter changes in the URL.
If you are configuring other channels, please ensure that they’re reporting to the
source
parameter with the proper value. (e.g. source=email, source=fb, source=na, etc.)
Customer Acquisition information is included in the tracking of the WooCommerce plugin. This will reflect whether the customer that placed the order was a new or an existing, returning customer. The customer acquisition parameter in the tracking will be set on base of the $customer_orders variable in WooCommerce.
Product Level Tracking (PLT) information is sent via the plugin’s tracking tags and follows the default format of an Awin PLT dataset:
AW:P|{{advertiserId}}|{{orderReference}}|{{productId}}|{{productName}}|{{productItemPrice}}|{{productQuantity}}|{{productSku}}|{{commissionGroupCode}}|{{productCategory}}
Usage of Awin Consent Signals is one of the six core elements of Awin’s Tracking Policy. The WooCommerce plugin does currently not support native consent handling using Awin Consent Signals.
The preferred method of consent handling is an advertiser led decision, but we strongly recommend using Awin Consent Signals, and please also see more information on Consent Framework.
The WooCommerce plugin has enhanced functionality to support both WordPress single-site and multisite installations.
Product Feed
We are currently in the process of developing the Product Feed feature for the WooCommerce plugin to offer a seamless integration experience. While this feature is being built, you can use the third-party tool as an alternative. For setup instructions, please refer to this documentation.
Testing your Tracking
Please see our article on testing your Integration for further instruction.
FAQ
The channel
parameter in my test transaction does not return aw
.
channel
parameter in my test transaction does not return aw
.WordPress’ own Floating Bar (referred to as adminbar
) sometimes interferes with our channel parameter. Instead of ch=aw
, it records the channel as adminbar
.
Solution: Reinstall the Plugin and run another test transaction.
The MasterTag is firing intermittently on my website.
In some cases, the Awin MasterTag domain dwin1.com
is added to the DNS Prefetching configuration of the website.
Solution: Review your website’s DNS Prefetching configuration. We advise that dwin1.com is removed from prefetching.
If the issue persists, the plugin source-code should be amended. You can find more information in the attached PDF on how to do so.
Lazy Loading is blocking Awin’s tracking on my website.
From WordPress 5.5 onwards, Lazy Loading is enabled by default. This is known as native lazy-loading
.
Solution: First, identify if Lazy Loading is being triggered by WordPress or a third-party plugin. If WordPress is doing so, please reach out to your assigned Awin technical contact.
If WordPress is not the cause of Lazy Loading, please review all plugins enabled on the site to identify the location. Some plugins will allow you to disable this feature.
The MasterTag and Conversion Tag seem to be blocked / not firing.
Assuming that Lazy Loading is not the cause, there are a number of potential reasons for why the tags may not be firing. Popular ad-blocking extensions and even browsers such as Safari often prevent client-side tags from firing.
Solution: Please contact your assigned Awin technical contact.
The “Settings” option is missing in the plugin.
WordPress may present graphical errors when installing plugins related to server-side changes that plugins can apply.
Solution: Access your admin panel on a different browser or try incognito mode to refresh related page caching.
What voucher codes formats are accepted by Awin?
There are some special characters that will not be received by the Awin platform.
Solution: Review our Voucher parameter guidelines in our Conversion Tag article.
Conversion tags are only coming through partially
This can be related to the usage of Elementor, WP Rocket or WP Engine on your WooCommerce website.
Elementor
Elementor is a website builder that can be used to customize and amend the checkout pages for WooCommerce stores. Please contact your assigned Awin technical contact when your WooCommerce store checkout flow is customized with Elementor, as this might be the reason why the tracking is incomplete.
WP Rocket and WP Engine
Page caching might prevent our tracking from working as intended and this can be amended in WP Rocket and/or WP Engine if you are using these plugins.
Solution: Page caching should be disabled whenever the Awin awc query parameter is included in the page URL. To check if the page URL containing the awc parameter will be excluded from the page cache when using WP Rocket, you can follow these steps:
1. Access WP Rocket Settings: Log in to your WordPress dashboard and navigate to the WP Rocket settings.
2. Cache Exclusion: In the WP Rocket settings, look for the section where you can exclude specific URLs from being cached. This is typically found under the "Advanced Rules" or "Cache" tab.
3. Add Exclusion Rule: Add a rule to exclude URLs containing the awc parameter. You can do this by specifying a pattern that matches URLs with the awc parameter. For example, you might add a rule like awc= to exclude any URL that contains the awc parameter.
4. Save Changes: Save the changes to the WP Rocket settings to apply the exclusion rule.
5. Test the Configuration: After saving the changes, test the configuration by visiting a page with the awc parameter in the URL. Check if the page is being excluded from the cache as expected.
Please also see WP Rocket Knowledge Base for further information on this. Similarly, when using WP Engine, the cache exclusion list in WP Engine can be updated to not cache any URL with the awc argument.