Parameter Guidance

Overview

This page will cover each parameter that our tags make use of, their definitions and best data integrity practices.

Some parameters are expanded out to their own pages as they require more information that can comfortably fit here.

Global Parameters

These parameters are global across all Awin tracking methods.

totalAmount

totalAmount is responsible for reporting the sale subtotal on a given transaction after any applicable discounts are applied.

We recommend that this value excludes tax, shipping, or relevant service charges. This value must be a float. No thousands separator is allowed and the decimal place must be a standard “dot” character.

Example: 1083.29

channel

For guidance on this parameter, please see our article on the Channel Parameter.

orderReference

orderReference should receive the related order identifier for a given transaction. We recommend that this value is one identifiable internally, by your team for the easiest comparison.

This value must be unique per transaction.

commissionGroupCode

commissionGroupCode should receive the desired Commission Group code for the transaction’s attribution.

These codes are defined and configured within the Awin UI.

If no group code is defined, this should be set to “DEFAULT”. This field is case and spelling sensitive. In the instance that there is a mismatch between the reported code and those configured in the Awin UI, DEFAULT will be attributed.

For more information on Commission Group codes, please see its related Article.

currencyCode

currencyCode should report the Conversion’s applicable currency. This value must be the ISO 4217 currency code for a given currency.

Multiple currencies may not be used on a single transaction.

If your site uses a single currency, you may hardcode this value. For example, if all transactions are completed in US Dollar, please hardcode this value as USD.

voucherCode

voucherCode should be populated with the related voucher / coupon code in use on a given transaction.

While populating this field is optional, you need to return the parameter even if empty.

This value must be URL-encoded and return a NULL value if empty.

isTest

isTest should be populated with “0” at all times unless otherwise instructed, especially in a Live program.

When set to “1”, conversions will not be processed.

S2S-Specific Parameters

These parameters are specific to Server-to-Server (S2S) tracking. Other, transaction-related, variables included in S2S tracking have identical definitions to those applicable for client-side tracking.

awc

awc should be populated with the associated Awin Click Checksum. This value is appended to the landing URL of each Awin redirect to your site and can be accessed via the UTM parameter &awc=.