Awin Developers

https://help.awin.com/developers/docs
Admin
Developer documentation for Awin's tracking suite, covering client-side and server-side tracking,...
Tokens:178,563
Snippets:1,357
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install postback - iOS and Android (Awin Live Example)

Source: https://help.awin.com/developers/docs/singular

Live example of an install postback for iOS and Android with actual values.

```APIDOC
## GET /sread.php

### Description
Install postback for iOS and Android (Awin Live Example). Tracks app installs with real values.

### Method
GET

### Endpoint
/sread.php

### Parameters
#### Query Parameters
- **tt** (string) - Required - Tracking type, set to 'ns'.
- **tv** (string) - Required - Tracking version, set to '2'.
- **type** (string) - Required - Event type, set to 'ai' for app install.
- **merchant** (string) - Required - Merchant ID, e.g., '17634'.
- **amount** (string) - Required - Amount, set to '1'.
- **ref** (string) - Required - Reference, e.g., 'fdb7f765dde1ac0ae23023f9389053e45cc178d0'.
- **parts** (string) - Required - Parts, e.g., 'iOS_INSTALL:1'.
- **cks** (string) - Required - Coalesce value, e.g., '17634_1712341671_caa46a9dd8fcc9c30e25b82809a3689d'.
- **p30** (string) - Required - Partner parameter, set to 'singular'.
- **ch** (string) - Required - Channel, set to 'aw'.
- **re-engagement** (string) - Required - Re-engagement flag, set to '0'.

### Request Example
```plaintext
/sread.php?tt=ns&tv=2&type=ai&merchant=17634&amount=1&ref=fdb7f765dde1ac0ae23023f9389053e45cc178d0&parts=iOS_INSTALL:1&cks=17634_1712341671_caa46a9dd8fcc9c30e25b82809a3689d&p30=singular&ch=aw&re-engagement=0
```
```

--------------------------------

### Example dynamic tracking link with install and event callbacks

Source: https://help.awin.com/developers/docs/adjust

Full Adjust tracking URL with dynamic install_callback and event_callback parameters. Replace example progid 1001 with your Awin progid.

```plaintext
https://app.adjust.com/abc123_xyz456?campaign=Affiliates&adgroup=!!!dateDAY!!!&creative=!!!affid!!!&install_callback=https%3A%2F%2Fwww.awin1.com%2Fsread.php%3Ftt%3Dss%26tv%3D2%26type%3Dai%26merchant%3D1001%26amount%3D1%26ref%3D%7Badid%7D%26parts%3DAPPINST%3A1%26testmode%3D0%26cks%3D!!!awc!!!%26p1%3D%7Bcountry%7D%26p2%3D%7Bpartner_parameters%7D%26p3%3D!!!awc!!!%26p4%3DINSTALL%26p5%3D%7Bos_name%7D%26p6%3D%7Bgps_adid_md5%7D%26p7%3D%7Bidfa_md5%7D%26p8%3D%7Badid%7D%26p9%3D%7Bdevice_type%7D%26p30%3Dadjust&event_callback_me4jf0=https%3A%2F%2Fwww.awin1.com%2Fsread.php%3Ftt%3Dss%26tv%3D2%26type%3Dap%26merchant%3D1001%26amount%3D1%26ref%3D%7Badid%7D_Leadout_%7Bengagement_time%7D%26parts%3DLEADOUT%3A1%26testmode%3D0%26cks%3D!!!awc!!!%26p1%3D%7Bcountry%7D%26p2%3D%7Bpartner_parameters%7D%26p3%3D!!!awc!!!%26p4%3DLEADOUT%26p5%3D%7Bos_name%7D%26p6%3D%7Bgps_adid_md5%7D%26p7%3D%7Bidfa_md5%7D%26p8%3D%7Badid%7D%26p9%3D%7Bdevice_type%7D%26p30%3Dadjust&fallback=!!!redirectURL!!!
```

--------------------------------

### Install postback - iOS and Android (Awin Live Example)

Source: https://help.awin.com/developers/docs/singular

Live example of an install postback with actual values. The 'merchant' is 17634, 'ref' is a timestamp-based reference, 'parts' indicates iOS_INSTALL, and 'cks' is a checksum. 're-engagement=0' indicates a new install.

```plaintext
/sread.php?tt=ns&tv=2&type=ai&merchant=17634&amount=1&ref=fdb7f765dde1ac0ae23023f9389053e45cc178d0&parts=iOS_INSTALL:1&cks=17634_1712341671_caa46a9dd8fcc9c30e25b82809a3689d&p30=singular&ch=aw&re-engagement=0
```

--------------------------------

### GET request example URL with placeholders

Source: https://help.awin.com/developers/docs/transaction-notifications

Example URL for GET request. Awin replaces placeholders like !!!merchantId!!!, !!!clickRef!!!, !!!transactionId!!!, and !!!commission!!! with actual values.

```xml
http://www.publisher-domain.com/!!!merchantId!!!/pixel.php?clk=!!!clickRef!!!&cnv=!!!transactionId!!!&com=!!!commission!!!
```

--------------------------------

### Install postback - iOS and Android

Source: https://help.awin.com/developers/docs/singular

Example postback URL for install tracking on iOS and Android. Uses placeholder values for merchant ID, timestamp, device install, and coalesce parameters.

```APIDOC
## GET /sread.php

### Description
Install postback for iOS and Android. Tracks app installs.

### Method
GET

### Endpoint
/sread.php

### Parameters
#### Query Parameters
- **tt** (string) - Required - Tracking type, set to 'ns'.
- **tv** (string) - Required - Tracking version, set to '2'.
- **type** (string) - Required - Event type, set to 'ai' for app install.
- **merchant** (string) - Required - Merchant ID.
- **amount** (string) - Required - Amount, set to '1'.
- **ref** (string) - Required - Reference, typically timestamp.
- **parts** (string) - Required - Parts, e.g., '{DEVICE_INSTALL}:1'.
- **cks** (string) - Required - Coalesce of 'awc' and 'cks'.
- **ch** (string) - Required - Channel, set to 'aw'.
- **p** (string) - Required - Partner, set to 'singular'.
- **re-engagement** (string) - Required - Re-engagement flag, set to '1'.

### Request Example
```plaintext
/sread.php?tt=ns&tv=2&type=ai&merchant={Merchant_ID}&amount=1&ref={TIMESTAMP}3&parts={DEVICE_INSTALL}:1&cks={coalesce,(awc),(cks)}&ch=aw&p=singular&re-engagement=1
```
```

--------------------------------

### Dynamic setup: install_callback parameter

Source: https://help.awin.com/developers/docs/adjust

Add install_callback parameter to Adjust tracking URL with URL-encoded Awin postback. Replace example progid 1001 in merchant parameter with your Awin progid.

```plaintext
install_callback=URL_ENCODED_AWIN_POSTBACK
```

```plaintext
install_callback=https%3A%2F%2Fwww.awin1.com%2Fsread.php%3Ftt%3Dss%26tv%3D2%26type%3Dai%26merchant%3D1001%26amount%3D1%26ref%3D%7Badid%7D%26parts%3DAPPINST%3A1%26testmode%3D0%26cks%3D!!!awc!!!%26p1%3D%7Bcountry%7D%26p2%3D%7Bpartner_parameters%7D%26p3%3D!!!awc!!!%26p4%3DINSTALL%26p5%3D%7Bos_name%7D%26p6%3D%7Bgps_adid_md5%7D%26p7%3D%7Bidfa_md5%7D%26p8%3D%7Badid%7D%26p9%3D%7Bdevice_type%7D%26p30%3Dadjust
```

--------------------------------

### Final output client code example with example values

Source: https://help.awin.com/developers/docs/implementing-sales-tracking

Static example showing the image pixel, JavaScript tracking, and master tag for a sale of £45.99 with voucher HALFPRICE. Replace merchant ID and other values with your own.

```xml
<!—Image Pixel - Mandatory --> 
<img src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=XXXXXX&amount=45.99&cr=GBP&ref=9-815162342a&parts=DEFAULT:45.99&vc=HALFPRICE&ch=aw&testmode=0"" border="0" width="0" height="0">

<!-- JavaScript Tracking - Mandatory -->
<script type="text/javascript">
//<![CDATA[ /*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};

/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "45.99";
AWIN.Tracking.Sale.orderRef = "9-815162342a";
AWIN.Tracking.Sale.parts = "DEFAULT:45.99";
AWIN.Tracking.Sale.voucher = "HALFPRICE";
AWIN.Tracking.Sale.currency = "GBP";
AWIN.Tracking.Sale.test = "0";
AWIN.Tracking.Sale.channel = "aw";
//]]>
</script>

<!--Master Tag add just before the closing </body> tag--> 
<script src="https://www.dwin1.com/XXXXXX.js"" type="text/javascript" defer="defer"></script>
```

--------------------------------

### Awin global postback URLs for Install, Lead, and In-app purchase

Source: https://help.awin.com/developers/docs/adjust

Awin postback URLs for install, lead, and in-app purchase events. Replace the example progid 1001 in the awin_program_code parameter with your specific Awin progid.

```plaintext
https://www.awin1.com/sread.php?tt=ss&tv=2&type=ai&merchant={{awin_program_code}}&amount=1&ref={adid}&parts={installCID}:1&testmode=0&cks={{awin_click_id}}&p2={os_name}&p30=adjust
```

```plaintext
https://www.awin1.com/sread.php?tt=ss&tv=2&type=ap&merchant={{awin_program_code}}&amount=1&ref={adid}_{event_name}&parts={labelFromAdJustDashBoard}:1&testmode=0&cks={{awin_click_id}}&p2={os_name}
```

```plaintext
https://www.awin1.com/sread.php?tt=ss&tv=2&type=ap&merchant={{awin_program_code}}&amount={{revenue_float}}&ref={{orderId}}&parts={{cg}}&testmode=0&cks={{awin_click_id}}&cr={currency}&vc={vc}&p1={adid}&p2={os_name}&p30=adjust
```

--------------------------------

### Final output client code example with example values

Source: https://help.awin.com/developers/docs/implementing-leads-tracking

The rendered HTML output after PHP processing, showing example values for order reference and amount. Use this to verify the tracking implementation.

```xml
<!—Image Pixel - Mandatory -->
<img src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=XXXXXX&amount=1.00&cr=GBP&ref=1602161929.4418&parts=DEFAULT:1.00&vc=&ch=aw&testmode=0"" border="0" width="0" height="0">

<!-- JavaScript Tracking - Mandatory -->
<script type="text/javascript">
//<![CDATA[ /*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};

/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "1.00";
AWIN.Tracking.Sale.orderRef = "1602161929.4418";
AWIN.Tracking.Sale.parts = "DEFAULT:1.00";
AWIN.Tracking.Sale.currency = "GBP";
AWIN.Tracking.Sale.test = "0";
AWIN.Tracking.Sale.channel = "aw";
//]]>
</script>

<!--Master Tag add just before the closing </body> tag-->
<script src="https://www.dwin1.com/XXXXX.js"" type="text/javascript" defer="defer"></script>
```

--------------------------------

### Install postback - iOS and Android (placeholder)

Source: https://help.awin.com/developers/docs/singular

Postback URL template for tracking app installs on iOS and Android. Replace placeholders like {Merchant_ID}, {TIMESTAMP}, and {DEVICE_INSTALL} with actual values. The parameter 're-engagement=1' indicates a re-engagement install.

```plaintext
/sread.php?tt=ns&tv=2&type=ai&merchant={Merchant_ID}&amount=1&ref={TIMESTAMP}3&parts={DEVICE_INSTALL}:1&cks={coalesce,(awc),(cks)}&ch=aw&p=singular&re-engagement=1
```

--------------------------------

### In-app postback (Awin Live Example)

Source: https://help.awin.com/developers/docs/singular

Live example of an in-app postback with actual values.

```APIDOC
## GET /sread.php

### Description
In-app postback (Awin Live Example). Tracks in-app purchases with real values.

### Method
GET

### Endpoint
/sread.php

### Parameters
#### Query Parameters
- **tt** (string) - Required - Tracking type, set to 'ns'.
- **tv** (string) - Required - Tracking version, set to '2'.
- **type** (string) - Required - Event type, set to 'ap' for in-app purchase.
- **merchant** (string) - Required - Merchant ID, e.g., '17634'.
- **amount** (string) - Required - Transaction total, e.g., '89.89'.
- **ref** (string) - Required - Order reference, e.g., '54489364'.
- **parts** (string) - Required - Parts, e.g., 'INAPP-SALE:89.89'.
- **cks** (string) - Required - Coalesce value, e.g., '17634_1715712831_47e7a6cb689241c2660d93199bf22d3a'.
- **p1** (string) - Required - Timestamp, e.g., '3040f5a806d7948e657c8d8561c90a22'.
- **ch** (string) - Required - Channel, set to 'aw'.
- **cr** (string) - Required - Currency, e.g., 'BRL'.
- **p30** (string) - Required - Partner parameter, set to 'singular'.

### Request Example
```plaintext
/sread.php?tt=ns&tv=2&type=ap&merchant=17634&amount=89.89&ref=54489364&parts=INAPP-SALE:89.89&cks=17634_1715712831_47e7a6cb689241c2660d93199bf22d3a&p1=3040f5a806d7948e657c8d8561c90a22&ch=aw&cr=BRL&p30=singular
```
```

--------------------------------

### Dynamic setup: event_callback parameter

Source: https://help.awin.com/developers/docs/adjust

Add event_callback parameter with Adjust event token and URL-encoded Awin postback. Replace example progid 1001 in merchant parameter with your Awin progid.

```plaintext
event_callback_{replaceWithAdjustEventToken}=URL_ENCODED_AWIN_POSTBACK
```

```plaintext
&event_callback_me4jf0=https%3A%2F%2Fwww.awin1.com%2Fsread.php%3Ftt%3Dss%26tv%3D2%26type%3Dap%26merchant%3D1001%26amount%3D1%26ref%3D%7Badid%7D_Leadout_%7Bengagement_time%7D%26parts%3DLEADOUT%3A1%26testmode%3D0%26cks%3D!!!awc!!!%26p1%3D%7Bcountry%7D%26p2%3D%7Bpartner_parameters%7D%26p3%3D!!!awc!!!%26p4%3DLEADOUT%26p5%3D%7Bos_name%7D%26p6%3D%7Bgps_adid_md5%7D%26p7%3D%7Bidfa_md5%7D%26p8%3D%7Badid%7D%26p9%3D%7Bdevice_type%7D%26p30%3Dadjust
```

--------------------------------

### Install postback URL

Source: https://help.awin.com/developers/docs/adjust

Postback URL for install events. Uses placeholders like {{awin_program_code}}, {{awin_click_id}}, and {adid} that Adjust will populate.

```plaintext
https://www.awin1.com/sread.php?tt=ss&tv=2&type=ai&merchant={{awin_program_code}}&amount=1&ref={adid}&parts={installCID}:1&testmode=0&cks={{awin_click_id}}&p1={adid}&p2={os_name}&p30=adjust
```

--------------------------------

### Mobile prefix example URL

Source: https://help.awin.com/developers/docs/adjust

Example Adjust tracking URL with Awin mobile prefix parameters. Replace the example progid '1001' with your specific Awin progid. The placeholders !!!dateDAY!!!, !!!affid!!!, !!!awc!!!, and !!!redirectURL!!! are populated by Adjust.

```plaintext
https://app.adjust.com/abc123_xyz456?campaign=Affiliates&amp;adgroup=!!!dateDAY!!!&amp;creative=!!!affid!!!&amp;awin_click_id=!!!awc!!!&amp;awin_program_code=1001&amp;deep_link=!!!redirectURL!!!&amp;redirect=!!!redirectURL!!!
```

--------------------------------

### Install postback URL

Source: https://help.awin.com/developers/docs/branch

URL template for the install postback. It includes placeholders for advertiser ID, timestamp, click ID, and OS. The 'parts' parameter is set to 'INSTALL:1'.

```plaintext
https://www.awin1.com/sread.php?tt=ss&tv=2&type=ai&merchant=${(ad_network.credentials.awin_advertiser_id)!}
&amount=1&ref=${(timestamp)!}&parts=INSTALL:1&testmode=0&cks=${(last_attributed_touch_data.~click_id)!}
&p1=${(user_data.os)!}
```

--------------------------------

### Example multiple products

Source: https://help.awin.com/developers/docs/product-level-tracking-2

Example showing how to include multiple products by using sequential bd array indices (bd[0], bd[1], bd[2]). Each product follows the same template structure. The array must be sequential for extra products.

```plaintext
&bd[0]=AW:P|{{advertiserId}}|{{orderReference}}|{{productId}}|{{productName}}|{{productItemPrice}}|{{productQuantity}}|{{productSku}}|{{commissionGroupCode}}|{{productCategory}}&bd[1]=AW:P|{{advertiserId}}|{{orderReference}}|{{productId}}|{{productName}}|{{productItemPrice}}|{{productQuantity}}|{{productSku}}|{{commissionGroupCode}}|{{productCategory}}&bd[2]=AW:P|{{advertiserId}}|{{orderReference}}|{{productId}}|{{productName}}|{{productItemPrice}}|{{productQuantity}}|{{productSku}}|{{commissionGroupCode}}|{{productCategory}}&p1={{customParameter1}}&p2={{customParameter2}}
```

--------------------------------

### Single custom parameter - Implementation example

Source: https://help.awin.com/developers/docs/custom-parameters

Complete example of a fall-back conversion pixel with a single custom parameter (p1=Next Day Delivery) and the corresponding JavaScript tracking code. Replace the example Advertiser ID (1001) in the first and last command line with yours.

```http
<img border="0" height="0" src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=7.50&ch=aw&p1=Next%20Day%20Delivery&parts=DEFAULT:7.50&ref=AA000005&testmode=0" style="display:none;" width="0">
<script type="text/javascript">
//<![CDATA[
/*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};
/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "7.50";
AWIN.Tracking.Sale.channel = "aw";
AWIN.Tracking.Sale.custom = ["Next Day Delivery"];
AWIN.Tracking.Sale.orderRef = "AA000005";
AWIN.Tracking.Sale.parts = "DEFAULT:7.50";
AWIN.Tracking.Sale.test = "0";
//]]>
</script>
<script defer="defer" src="https://www.dwin1.com/1001.js" type="text/javascript"></script>
```

--------------------------------

### Example data layer with actual values

Source: https://help.awin.com/developers/docs/gtm-practical-tips

Shows the data layer code with example values: total 5.99, currency GBP, ID 4-815162342, and promo code HALFPRICE. Use this as a reference for replacing placeholders.

```javascript
<script>
dataLayer = [{
'transactionTotal': "5.99",
'transactionCurrency': "GBP",
'transactionID': "4-815162342",
'transactionPromoCode': "HALFPRICE",
'event': "awin.dl.ready"
}];
</script>
```

--------------------------------

### PHP example with dynamic data for Awin leads tracking

Source: https://help.awin.com/developers/docs/implementing-leads-tracking

Client-side PHP example that generates dynamic order reference and amount for Awin leads tracking. Includes image pixel, JavaScript tracking parameters, and master tag. Replace merchant ID and other values as needed.

```php
<!—Image Pixel - Mandatory --> 
<img src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=XXXXX&amount=1.00&cr=GBP&ref=<?php echo microtime(true); ?>&parts=DEFAULT:1.00&vc=&ch=aw&testmode=0" border="0" width="0" height="0">

<!-- JavaScript Tracking - Mandatory --> 
<script type="text/javascript">
//<![CDATA[ /*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};

/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "1.00";
AWIN.Tracking.Sale.orderRef = "<?php echo microtime(true); ?>";
AWIN.Tracking.Sale.parts = "DEFAULT:1.00";
AWIN.Tracking.Sale.currency = "GBP";
AWIN.Tracking.Sale.test = "0";
AWIN.Tracking.Sale.channel = "aw";
//]]>
</script>

<!--Master Tag add just before the closing </body> tag-->
<script src="https://www.dwin1.com/XXXXX.js"" type="text/javascript" defer="defer"></script>
```

--------------------------------

### Callback URL example

Source: https://help.awin.com/developers/docs/transaction-notifications

Example URL where Awin sends transaction data. Must be reachable on ports 80 or 443.

```xml
https://www.yourdomain.com/awin/transaction-handler.php
```

--------------------------------

### Example array of custom parameters

Source: https://help.awin.com/developers/docs/gtm-practical-tips

This plaintext array demonstrates the expected format for the Custom Parameters field. Note that parameter 1 is reserved for the tracking method, so your data starts from parameter 2 onward.

```plaintext
[“t-shirt“, “new_customer“, “same_day_shipping“]
```

--------------------------------

### Fall-back conversion pixel implementation example

Source: https://help.awin.com/developers/docs/customer-acquisition

Example of the fall-back conversion pixel with the customerAcquisition parameter applied to the tracking URL.

```http
<img border="0" height="0" src="https://www.awin1.com/sread.img?&customeracquisition={{customerAcquisition}}" />
```

--------------------------------

### Multiple custom parameters - Implementation example

Source: https://help.awin.com/developers/docs/custom-parameters

Complete example of a fall-back conversion pixel with multiple custom parameters (p1=Special Delivery, p2=Royal Mail, p3=5.99) and the corresponding JavaScript tracking code. Replace the example advertiser id (1001) in the first and last command line with yours.

```http
<img border="0" height="0" src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=7.50&ch=aw&p1=Special%20Delivery&p2=Royal%20Mail&p3=5.99parts=DEFAULT:7.50&ref=AA000005&testmode=0" style="display:none;" width="0">
<script type="text/javascript">
//<![CDATA[
/*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};
/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "7.50";
AWIN.Tracking.Sale.channel = "aw";
AWIN.Tracking.Sale.custom = ["Special Delivery", "Royal Mail", "5.99"];
AWIN.Tracking.Sale.orderRef = "AA000005";
AWIN.Tracking.Sale.parts = "DEFAULT:7.50";
AWIN.Tracking.Sale.test = "0";
//]]>
</script>
<script defer="defer" src="https://www.dwin1.com/1001.js" type="text/javascript"></script>
```

--------------------------------

### Example tracking requests for product-level tracking

Source: https://help.awin.com/developers/docs/product-level-tracking-2

Shows the expected tracking request URLs to awin1.com/basket.php with product_line parameters. The URLs are URL-encoded versions of the product data. Depending on the advertiser program setup, requests may be directed to the alternative tracking domain zenaps.com.

```plaintext
https://www.awin1.com/basket.php?product_line=AW%3AP%7C1001%7CAA000006%7CB000EMSUQA%7CThe%20Knife%20-%20Silent%20Shout%7C5.55%7C2%7CB000EMSUQA%7CCD%7CElectronic%20Music
https://www.awin1.com/basket.php?product_line=AW%3AP%7C1001%7CAA000006%7CB001N2Z41Y%7CSigur%20Ros%20-%20Heima%7C14.99%7C1%7CB001N2Z41Y%7CDVD%7CMusic%20DVD
```

--------------------------------

### Example XML product entry

Source: https://help.awin.com/developers/docs/hosting-feeds

A complete example of a single product in the Awin XML feed format, using Awin XML labels. Includes fields like pid, name, price, currency, and image URLs. Note the closing tag is </products> in the source, which appears to be a typo.

```xml
<products>
<product>
<pid>Z187552zGDNst2b</pid>
<name>example single offer abc123</name>
<purl>https://shop-advertiserdomain.com/product/37f2c197a930?utm_source=awin&utm_medium=affiliate&utm_campaign=product-data-feed&utm_content=product-ads&utm_term=!!!productid!!!</purl>
<price>99.00</price>
<delcost>9.00</delcost>
<currency>EUR</currency>
<brand>examplebrandname</brand>
<category>examplecategoryname</category>
<colour>beige</colour>
<condition>new or refurbished</condition>
<deltime>7-12 days</deltime>
<desc>this product offer is the best, because...</desc>
<lang>EN</lang>
<basket_link>https://shop-advertiserdomain.com/product/37f2c197a930?add-to-cart=1&utm_source=awin&utm_medium=affiliate&utm_campaign=product-data-feed&utm_content=product-ads&utm_term=!!!productid!!!</basket_link>
<instock>1</instock>
<weboffer>1</weboffer>
<forsale>1</forsale>
<imgurl>https://images.cdn....com/...v0-middle.jpg</imgurl>
<thumburl>https://images.cdn....com/...v0-very-small-preview.jpg</thumburl>
<large_image>https://images.cdn....com/...v0-large.jpg</large_image>
<alternate_image>
https://images.cdn....com/...v1.jpg</alternate_image>
<modelno>ABC-387V3a</modelno>
</product>
<products>
```

--------------------------------

### Conversion Tag Example with Channel Parameter

Source: https://help.awin.com/developers/docs/channel-parameter

Complete example of the Awin Conversion Tag with channel set to 'email'. Includes the tracking pixel and script block with transaction parameters.

```html
<img border="0" height="0" src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=8.33&ch=email&parts=DEFAULT:8.33&ref=AA000001&testmode=0" style="display:none;" width="0">
<script type="text/javascript">
//<![CDATA[
/*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};
/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "8.33";
AWIN.Tracking.Sale.channel = "email";
AWIN.Tracking.Sale.orderRef = "AA000001";
AWIN.Tracking.Sale.parts = "DEFAULT:8.33";
AWIN.Tracking.Sale.currency = "GBP";
AWIN.Tracking.Sale.voucher = "10OFF";
AWIN.Tracking.Sale.test = "0";
//]]>
</script>
```

--------------------------------

### Example product JSON

Source: https://help.awin.com/developers/docs/enhanced-feeds-prod-spec

A single valid product in JSON format. The source notes there should be no new lines within the product's JSON.

```json
{"id":"16817108","title":"Organic Cotton Men's T-Shirt - Blue - M","description":"Made from 100% organic cotton, this classic red men's polo has a slim fit and signature logo embroidered on the left chest. Machine wash cold; imported.","link":"https://www.example.com/writing/pens","image_link":"http://www.example.com/image1.jpg","additional_image_link":["http://www.example.com/image1.jpg","http://www.example.com/image2.jpg"],"mobile_link":"https://www.m.example.com/writing/pens","google_product_category":"Apparel & Accessories > Clothing > Dresses","product_type":"Home > Women > Dresses > Maxi Dresses","gtin":"3243567980126","mpn":"EXA12345MPLE","brand":"Google","identifier_exists":"yes","availability":"in_stock","availability_date":"2023-12-25T13:00-0800","expiration_date":"2023-12-26T13:00-0800","price":"15.00 GBP","sale_price":"5.00 GBP","sale_price_effective_date":"2022-02-24T13:00-0800/2022-03-29T15:30-0800","cost_of_goods_sold":"3526.63 USD","unit_pricing_measure":"750 ml","unit_pricing_base_measure":"100 ml","installment":{"months":6,"amount":"50 BRL"},"subscription_cost":{"period":"month","period_length":12,"amount":"35.00 EUR"},"loyalty_program":{"program_label":"Label A","loyalty_points":"0.5"},"condition":"new","adult":"yes","multipack":20,"is_bundle":false,"energy_efficiency_class":"A+","min_energy_efficiency_class":"A+","max_energy_efficiency_class":"D","age_group":"adult","color":"yellow","gender":"unisex","material":"Cotton/polyester/elastane","pattern":"Striped","size":"L","size_type":["regular","plus"],"size_system":"UK","item_group_id":"AB12345","product_length":"14 cm","product_width":"14 cm","product_height":"14 cm","product_weight":"173 g","product_detail":[{"section_name":"General","attribute_name":"Product Type","attribute_value":"Digital player"},{"attribute_name":"Product Type","attribute_value":"Digital Video"}],"product_highlight":["Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies","Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies","Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies"],"certification":{"certification_authority":"European_Commission","certification_name":"EPREL","certification_code":"Moose","certification_value":"Goose"},"shipping":{"country":"US","region":"US","postal_code":"80302","service":"Overnight","price":"16.00 USD","min_handling_time":"1","max_handling_time":"1","min_transit_time":"3","max_transit_time":"3"},"shipping_weight":"3 kg","shipping_length":"20 in","shipping_width":"40 cm","shipping_height":"20 in","ships_from_country":"DE","min_handling_time":1,"max_handling_time":10,"tax":[{"country":"US","region":"CA","postal_code":"94043","rate":8.75,"tax_ship":"yes"}]}
```

--------------------------------

### Fall-back Conversion Pixel & Server-to-Server Example with Multiple Commission Groups

Source: https://help.awin.com/developers/docs/commission-groups

Example of the parts parameter in fall-back conversion pixel or server-to-server tracking, using CD and DVD commission groups with amounts 11.10 and 14.99.

```http
...&parts=CD:11.10|DVD:14.99...
```

--------------------------------

### PHP server-side tracking example for leads

Source: https://help.awin.com/developers/docs/implementing-leads-tracking

A simple PHP example for server-side tracking of leads. It constructs a URL to the Awin sread.php endpoint with parameters like merchant, amount, channel, currency, order reference, parts, and click checksum, then sends it via cURL. The code is executed when the thank-you page is requested and is not visible client-side.

```php
<?php

$AwAdvID = "1001"; // replace with your Awin advertiser ID - exampleID here: 1001
$totalAmount = "1.00"; // in case of leads mostly static one (for one lead)
$cookieName = "source"; // Name of the cookie to use for last click referrer de-duplication
$currencyCode = "GBP";
$orderReference = microtime(true);
$commissiongroupcode = "DEFAULT";
$voucherCode = "";
$cks = $_COOKIE["awc"]; // Populate the Awin click checksum if one is associated with the conversion
 
if (isset($_COOKIE[$cookieName])) {
$paidchannel = $_COOKIE[$cookieName]; // for other paid channels only
} else {
$paidchannel = "aw"; // No paid channel assisted
}
 
$url = "https://www.awin1.com/sread.php?tt=ss&tv=2";
$url .= "&merchant=" . $AwAdvID; 
$url .="&amount=" . $totalAmount;
$url .="&ch=" . $paidchannel;
$url .="&cr=" . $currencyCode;
$url .="&ref=" . $orderReference;
$url .="&parts=" . $commissiongroupcode;
$url .=":" . $totalAmount;
$url .= "&testmode=0&vc=" . $voucherCode;
$url .="&cks=" . $cks; // Populate the Awin click checksum if one is associated with the conversion
 
$c = curl_init();
curl_setopt($c, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
curl_setopt($c, CURLOPT_URL, $url);
curl_exec($c);
curl_close($c);

?>
```

--------------------------------

### In-app postback (Awin Live Example)

Source: https://help.awin.com/developers/docs/singular

Live example of an in-app postback with actual values. The 'merchant' is 17634, 'amount' is 89.89, 'ref' is an order reference, 'parts' indicates INAPP-SALE, and 'cks' is a checksum. 'cr=BRL' indicates the currency.

```plaintext
/sread.php?tt=ns&tv=2&type=ap&merchant=17634&amount=89.89&ref=54489364&parts=INAPP-SALE:89.89&cks=17634_1715712831_47e7a6cb689241c2660d93199bf22d3a&p1=3040f5a806d7948e657c8d8561c90a22&ch=aw&cr=BRL&p30=singular
```

--------------------------------

### Example Tracking Requests

Source: https://help.awin.com/developers/docs/conversion-tag

Example tracking requests generated when the Conversion Tag and MasterTag are correctly implemented. Requests may be directed to alternative domain zenaps.com and the number of unique request types can vary from two to five.

```http
https://www.awin1.com/sread.php?a=1001&b=8.33&cr=GBP&c=AA000001&d=DEFAULT:8.33&vc=&t=0&ch=aw&cks=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa&l=https%3A//advertiser-domain.com/confirmation.php&tv=2&tt=ia
https://www.awin1.com/sread.js?a=1001&b=8.33&cr=GBP&c=AA000001&d=DEFAULT:8.33&vc=&t=0&ch=aw&cks=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa&l=https%3A//advertiser-domain.com/confirmation.php&tv=2&tt=js
https://www.awin1.com/sread.php?a=1001&b=8.33&cr=GBP&c=AA000001&d=DEFAULT%3A8.33&vc=&t=0&cks=1001_1403695822_a430d81e22c9e8687f423efcf024fbaa&atp=&tv=2&tt=et&l=https%3A%2F%2Fwww.advertiser-domain.com%2Fconfirmation.php&ch=aw
https://www.awin1.com/alt.php?mid=1001&gv=1&a=1001&b=8.33&cr=EUR&c=AA000001&d=DEFAULT:8.33&vc=&t=0&ch=aw&l=https%3A//www.advertiser-domain.com%2Fconfirmation.php
https://www.awin1.com/m/1001.gif
```

--------------------------------

### Multi-platform Adjust link with Awin parameters

Source: https://help.awin.com/developers/docs/adjust

Example Adjust tracking URL combining platform 1 and platform 2 link tokens, with Awin parameters for campaign, adgroup, creative, click ID, program code, deep link, redirect, and fallback. Replace the example progid 1001 with your Awin program code.

```plaintext
https://app.adjust.com/abc123_xyz456?campaign=Affiliates&adgroup=!!!dateDAY!!!&creative=!!!affid!!!&awin_click_id=!!!awc!!!&awin_program_code=1001&deep_link=exampleshop-com%3A%2F%2Fhome&redirect=!!!redirectURL!!!&fallback=!!!redirectURL!!!
```

--------------------------------

### device_product_json example for Nokia Lumia 735 Black

Source: https://help.awin.com/developers/docs/telco-data-feeds-mobile-phones-json-fields

Example JSON structure for the device_product_json field, showing a product with ID, name, brand, brand ID, type, and type ID. Use this to understand the nested fields and how to group products by product_id.

```json
{
  "product_id": "2021",
  "product_name": "Lumia",
  "product_brand": "Nokia",
  "product_brand_id": "20",
  "product_type": "Mobile Phone",
  "product_type_id": "1"
}
```

--------------------------------

### Example #1 - Declare conversion before MasterTag append

Source: https://help.awin.com/developers/docs/conversion-tag

Example of declaring the Conversion Tag in an HTML script block before the MasterTag loads. Uses sample values for amount, channel, order reference, parts, currency, voucher, and test.

```xml
<script type="text/javascript">
/*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};
/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "8.33";
AWIN.Tracking.Sale.channel = "aw";
AWIN.Tracking.Sale.orderRef = "AA000001";
AWIN.Tracking.Sale.parts = "DEFAULT:8.33";
AWIN.Tracking.Sale.currency = "GBP";
AWIN.Tracking.Sale.voucher = "10OFF";
AWIN.Tracking.Sale.test = "0";
</script>
```

--------------------------------

### Conversion Tag Example with Multiple Commission Groups

Source: https://help.awin.com/developers/docs/commission-groups

Complete example of the conversion tag setting the parts parameter with two commission groups (CD and DVD). The amounts 11.10 and 14.99 sum to the order subtotal 26.09.

```javascript
//<![CDATA[
/*** Do not change ***/
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};
/*** Set your transaction parameters ***/
AWIN.Tracking.Sale.amount = "26.09";
AWIN.Tracking.Sale.channel = "aw";
AWIN.Tracking.Sale.currency = "EUR";
AWIN.Tracking.Sale.orderRef = "AA000006";
AWIN.Tracking.Sale.parts = "CD:11.10|DVD:14.99";
AWIN.Tracking.Sale.test = "0";
AWIN.Tracking.Sale.voucher = "10OFF";
//]]>
```

--------------------------------

### PHP server-side tracking example

Source: https://help.awin.com/developers/docs/implementing-sales-tracking

A simple PHP example for server-side tracking that sends a conversion request to Awin's sread.php endpoint. It uses the 'source' cookie for paid channel de-duplication and includes parameters like merchant, amount, currency, order reference, commission group, and click checksum. The code is executed on the thank-you page and is not visible in client-side source.

```php
<?php
$AwAdvID = "1001"; // replace with your Awin advertiser ID - exampleID here: 1001
$totalAmount = "1.00"; // in case of leads mostly static one (for one lead)
$cookieName = "source"; // Name of the cookie to use for last click referrer de-duplication
$currencyCode = "GBP";
$orderReference = microtime(true);
$commissiongroupcode = "DEFAULT";
$voucherCode = "";
$cks = $_COOKIE["awc"]; // Populate the Awin click checksum if one is associated with the conversion

if (isset($_COOKIE[$cookieName])) {
$paidchannel = $_COOKIE[$cookieName]; // for other paid channels only
} else {
$paidchannel = "aw"; // No paid channel assisted
}

$url = "https://www.awin1.com/sread.php?tt=ss&tv=2";
$url .= "&merchant=" . $AwAdvID; 
$url .="&amount=" . $totalAmount;
$url .="&ch=" . $paidchannel;
$url .="&cr=" . $currencyCode;
$url .="&ref=" . $orderReference;
$url .="&parts=" . $commissiongroupcode;
$url .=":" . $totalAmount;
$url .= "&testmode=0&vc=" . $voucherCode;
$url .="&cks=" . $cks; // Populate the Awin click checksum if one is associated with the conversion

$c = curl_init();
curl_setopt($c, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
curl_setopt($c, CURLOPT_URL, $url);
curl_exec($c);
curl_close($c);
?>
```

--------------------------------

### deal_type_json example

Source: https://help.awin.com/developers/docs/telco-data-feeds-mobile-phones-json-fields

Example JSON object for the deal_type_json field, showing deal_type_id and deal_type_name. The deal_type_id is stable and can be used for filtering/grouping.

```json
{
  "deal_type_id": "0",
  "deal_type_name": "Consumer"
}
```

--------------------------------

### Practical Tip - Preserve existing AWIN properties

Source: https://help.awin.com/developers/docs/conversion-tag

Recommended way to initialize AWIN objects to preserve existing properties like AWIN.Tracking.AdvertiserConsent and prevent data loss. Avoid reinitializing with empty objects.

```javascript
...
var AWIN = AWIN || {};
AWIN.Tracking = AWIN.Tracking || {};
AWIN.Tracking.Sale = {};
...
```
Tokens:
Raw