Awin Tracking Suite

https://help.awin.com/docs/
Admin
Awin's Tracking Suite is a comprehensive solution designed to help advertisers accurately attribute...
Tokens:102,442
Snippets:742
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Postback - iOS and Android (Awin Live Example)

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

A live example of an install postback for Awin, demonstrating the parameters used for reporting app installations on iOS and Android. This includes specific merchant and checksum values.

```text
/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 Postbacks

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

Provides example postback URLs for both install and in-app events on iOS and Android platforms, including live examples.

```APIDOC
## Example Postbacks

### Install Postback - iOS and Android
```
/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
```

### Install Postback - iOS and Android (Awin Live Example)
```
/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
```

### In-app Postback
```
/sread.php?tt=ns&tv=2&type=ap&merchant={Merchant_ID}&amount={Transaction_Total}&ref={Order_Ref}&parts=INAPP-SALE:{Transaction_Total}&cks={coalesce,(awc),(cks)}&p1={TIMESTAMP}&ch=aw&cr={Currency}&p30=singular
```

### In-app Postback (Awin Live Example)
```
/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 HTML with Product Data for PLT

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

This example demonstrates a complete HTML form with product data populated in the textarea for Product Level Tracking. It includes two sample product rows, formatted according to the specified structure.

```html
<form style="display:none;" name="aw_basket_form">
<textarea wrap="physical" id="aw_basket">
AW:P|1001|AA000006|B000EMSUQA|The Knife – Silent Shout|5.55|2|B000EMSUQA|CD|Electronic Music
AW:P|1001|AA000006|B001N2Z41Y|Sigur Ros - Heima|14.99|1|B001N2Z41Y|DVD|Music DVD
</textarea>
</form>

```

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

### Multiple Product Tracking Example

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

This example illustrates how to send data for multiple products within a single conversion pixel request. Each product is assigned a sequential index in the `bd` array, allowing for detailed tracking of individual items in an order.

```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}}
```

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

### Awin GET Request URL Example

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

Example of a GET request URL for Awin, demonstrating the use of placeholders for transaction data. These placeholders are dynamically replaced by Awin with actual transaction values during processing.

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

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

### Install Postback - iOS and Android (Template)

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

A template for an install postback to be sent to Awin, supporting both iOS and Android. This postback reports app installation events.

```text
/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
```

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

### Example Conversion Pixel with Product Data

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

This is a concrete example of an HTML image tag used for tracking conversions, including specific product details. It demonstrates how the `bd` parameter is populated with actual values for two different products, along with other transaction-related parameters.

```html
<img border="0" height="0" src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=26.09&ch=aw&parts=CD:11.10|DVD:14.99&ref=AA000006&testmode=0&bd[0]=AW:P|1001|AA000006|B000EMSUQA|The Knife – Silent Shout|5.55|2|B000EMSUQA|CD|Electronic Music&bd[1]=AW:P|1001|AA000006|B001N2Z41Y|Sigur Ros - Heima|14.99|1|B001N2Z41Y|DVD|Music DVD" style="display:none;" width="0">
```

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

### Configure Installment and Subscription Payment Plans

Source: https://help.awin.com/docs/enhanced-feeds-publisher-faq

This example shows how to configure payment options for products, including installment plans with the number of months and amount, and subscription costs with period and amount details.

```json
{
  "price_and_availability": {
    "installment": {
      "months": 6,
      "amount": "50 BRL"
    },
    "subscription_cost": {
      "period": "month",
      "period_length": 12,
      "amount": "35.00 EUR"
    }
  }
}
```

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

### Example Tracking Requests with Product Data

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

These are example tracking requests that are generated when Product Level Tracking, Mastertag, and Conversion Tag are implemented correctly. The product data is URL-encoded and appended to the 'basket.php' URL.

```url
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
```

```url
https://www.awin1.com/basket.php?product_line=AW%3AP%7C1001%7CAA000006%7CB001N2Z41Y%7CSigur%20Ros%20-%20Heima%7C14.99%7C1%7CB001N2Z41Y%7CDVD%7CMusic%20DVD
```

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

### Install-based Tracking Setup

Source: https://help.awin.com/docs/button

Instructions for setting up install-based tracking for Button integration with Awin, including commission group setup and tracking URL parameters.

```APIDOC
## Install-based Tracking

### Description
Setup commission group on Awin for **APP_INSTALL**. Add `&type=ai` into the tracking calls.

### Request
Button should pass back the following tracking URL:

```
https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=6091&ch=aw&testmode=0&amount=19.99&parts=APP_INSTALL:1.00&ref={GPS_ADID}&cr=GBP&cks=3797_1535473580_501804673273d9b1926be9dcd560e9f1&type=ai
```

### Parameters
- `parts` (string) - Commission group, e.g., `APP_INSTALL:1.00`.
- `ref` (string) - Placeholder for GPS ADID, e.g., `{GPS_ADID}`.
- `type` (string) - Set to `ai` for install-based tracking.
```

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

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

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

A live example of an in-app postback for Awin, showing the parameters for reporting transactions. This includes specific merchant, amount, reference, and currency values.

```text
/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
```

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

### Install Postback

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

This postback URL is used to track app installs. It sends install-related data to Awin.

```APIDOC
## Install Postback

### Description
This endpoint tracks app installs by sending relevant data to Awin.

### Method
GET

### Endpoint
`https://www.awin1.com/sread.php`

### Query Parameters
- **tt** (string) - Required - Tracking tag type.
- **tv** (string) - Required - Tracking tag version.
- **type** (string) - Required - Postback type, `ai` for install.
- **merchant** (string) - Required - Your Awin program code.
- **amount** (string) - Required - Typically set to `1` for installs.
- **ref** (string) - Required - Reference ID, usually theadid.
- **parts** (string) - Required - Parts of the postback, e.g., `{installCID}:1`.
- **testmode** (string) - Optional - Set to `0` for live tracking, `1` for test mode.
- **cks** (string) - Required - Awin click ID.
- **p1** (string) - Required - Additional parameter, often the adid.
- **p2** (string) - Required - Additional parameter, often the OS name.
- **p30** (string) - Required - Identifies the attribution tool, e.g., `adjust`.

### Request Example
```
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
```

### Response
#### Success Response (200)
This endpoint typically returns a minimal response or redirects. The success is indicated by Awin receiving and processing the tracking data.
```

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

### Full Implementation Example with Customer Acquisition (JavaScript and HTTP)

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

This comprehensive example illustrates the integration of the `customerAcquisition` parameter within an Awin tracking setup. It includes both the HTML image tag for the Fall-back Conversion Pixel and the JavaScript code for setting transaction details, including 'NEW' for the customer acquisition type.

```http
<img border="0" height="0" src="https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=1001&amount=7.50&ch=aw&parts=DEFAULT:7.50&ref=AA000005&testmode=0&customeracquisition=NEW&vc=10PERCENTOFF" style="display:none;" width="0">

```

```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.orderRef = "AA000005";
AWIN.Tracking.Sale.parts = "DEFAULT:7.50";
AWIN.Tracking.Sale.test = "0";
AWIN.Tracking.Sale.voucher = "10PERCENTOFF";
AWIN.Tracking.Sale.customerAcquisition = "NEW";
//]]>

```

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

### Sale-based Tracking Setup

Source: https://help.awin.com/docs/button

Instructions for setting up sale-based tracking for Button integration with Awin, including commission group setup and tracking URL parameters.

```APIDOC
## Sale-based Tracking

### Description
Setup commission group on Awin for **APP_DEFAULT**. Adding `&type=ap` into the tracking calls allows Awin reports to identify ‘In App’ activity without the need for app-based commission groups.

### Request
Button should pass back the following tracking URL:

```
https://www.awin1.com/sread.img?tt=ns&tv=2&merchant=6091&ch=aw&testmode=0&amount=19.99&parts=APP_DEFAULT:19.99&ref=383028169256&cr=GBP&cks=3797_1535473580_501804673273d9b1926be9dcd560e9f1&type=ap
```

### Parameters
- `amount` (float) - The sale amount.
- `parts` (string) - Commission group and amount, e.g., `APP_DEFAULT:19.99`.
- `type` (string) - Set to `ap` to identify In App activity.
```

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

### Conversion Tag Examples

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

Provides practical examples of how to implement the Conversion Tag, including direct declaration before MasterTag append and dynamic triggering after MasterTag append.

```APIDOC
## Conversion Tag Examples

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

This example shows how to declare the `AWIN.Tracking.Sale` object directly on the confirmation page before the MasterTag is loaded.

```javascript
<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>
```

### Example #2 - Trigger conversion after MasterTag append

This example demonstrates how to declare and trigger the conversion if the MasterTag is loaded asynchronously (e.g., via AJAX). It checks for the existence of the AWIN object before proceeding.

```javascript
if (typeof AWIN != "undefined" && typeof AWIN.Tracking != "undefined") {
 	AWIN.Tracking.Sale = {};
 	AWIN.Tracking.Sale.amount = parseFloat(fTotalAmount).toFixed(2);
 	AWIN.Tracking.Sale.channel = sChannel;
 	AWIN.Tracking.Sale.orderRef = sOrderReference;
 	AWIN.Tracking.Sale.parts = "DEFAULT:" + parseFloat(fTotalAmount).toFixed(2);
 	AWIN.Tracking.Sale.currency = sCurrency;
 	AWIN.Tracking.Sale.voucher = sVoucherCode;
 	AWIN.Tracking.Sale.test = "0";
 	AWIN.Tracking.run();
}
```
```

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

### Example: Single Custom Parameter Implementation in Awin (HTML/JavaScript)

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

An example illustrating the implementation of a single custom parameter within an Awin conversion tracking setup. It includes both the fallback pixel (<img> tag) and the JavaScript conversion tag, showing how to pass 'Next Day Delivery' as a custom parameter.

```HTML
<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>
```

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

### Product Level Tracking with Conversion Pixels

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

This section details how to implement Product Level Tracking by populating the `bd` array within the pixel's URL request string. Each product should be a separate GET query parameter.

```APIDOC
## Product Level Tracking Implementation

### Description
This endpoint allows for detailed tracking of individual products within a transaction using conversion pixels. It involves populating the `bd` array with product-specific information.

### Method
GET (Implicitly, as it's part of a URL request string)

### Endpoint
Tracking Pixel URL (e.g., `https://www.awin1.com/sread.img?...`)

### Parameters
#### Query Parameters
- **bd[n]** (string) - Required - Represents a single product row in the basket. The array must be sequential (e.g., `bd[0]`, `bd[1]`).
  - The parameter value must be URL-encoded, or individual non-numerical values within the parameter must be URL-encoded.
  - Format: `AW:P|advertiserId|orderReference|productId|productName|productItemPrice|productQuantity|productSku|commissionGroupCode|productCategory`
- **p1** (string) - Optional - Custom parameter 1.
- **p2** (string) - Optional - Custom parameter 2.

#### Product Row (`bd[n]`) Fields:
- **advertiserId** (string) - Required - The applicable Awin advertiser programme ID.
- **orderReference** (string) - Required - The unique booking/order reference. Must be URL-encoded.
- **productId** (string) - Required - The applicable, unique product ID. Must be URL-encoded.
- **productName** (string) - Required - The applicable product name. Must be URL-encoded.
- **productItemPrice** (float) - Required - The price for a single quantity of this product (after discounts, before taxes). Format: `1083.29`.
- **productQuantity** (integer) - Required - The number of unique products purchased in this order. Example: `1`.
- **productSku** (string) - Optional - The product's SKU. If not used, leave blank. Must be URL-encoded.
- **commissionGroupCode** (string) - Required - The commission group code for the product. Use `DEFAULT` if not applicable or for Awin Access clients. Must match `AWIN.Tracking.Sale.parts` if used.
- **productCategory** (string) - Optional - The category the product belongs to. If not used, leave blank. Must be URL-encoded.

### Request Example (Multiple Products)
```
&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}}
```

### Response
This endpoint doesn't return a direct response body in the traditional sense. It's a tracking mechanism. Successful tracking is usually confirmed by the advertiser's system or through Awin's reporting.

#### Success Response (Implicit)
Pixel fires successfully and data is recorded by the tracking system.

#### Response Example (Conceptual - Tracking confirmation is external)
```json
{
  "status": "tracking_recorded"
}
```

### Error Handling
- Pixels with HTTP header size exceeding 8kb will be rejected.
- Character lengths longer than ~7500 (2048 for IE11) for the entire pixel URL can cause issues, especially with long product names. Consider URL-encoding array values only, not the separator pipes, to manage character limits.
```

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

### Install Postback URL

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

This is the URL structure for configuring the install postback event in Awin when using Branch tracking.

```APIDOC
## Install postback

### Endpoint
`https://www.awin1.com/sread.php`

### Query Parameters
- **tt** (string) - Required - Tracking type
- **tv** (string) - Required - Tracking version
- **type** (string) - Required - Event type (ai for install)
- **merchant** (string) - Required - Awin Merchant ID
- **amount** (string) - Required - Always '1' for installs
- **ref** (string) - Required - Timestamp
- **parts** (string) - Required - INSTALL:1
- **testmode** (string) - Optional - Test mode flag (0 for production)
- **cks** (string) - Required - Click ID from Branch
- **p1** (string) - Required - User's operating system
```

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

### Kochava Install Postback URL

Source: https://help.awin.com/docs/kochava

This is the postback URL template for tracking app installs via Kochava. It includes parameters for Awin merchant ID, Kochava device ID, click ID, and platform-specific details. The 'parts' parameter is used to define the commission for an install.

```url
https://www.awin1.com/sread.php?tt=ss&tv=2&merchant={awin.merchant_id}&amount=1&ch=aw&ref={kochava_device_id}&parts=INSTALL_{platform}:1&cks={click_id}&testmode=0&type=ai&p1={platform}&p2={os_version}&p3={device_type}&p4={country}&p30=kochava
```

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

### Advertiser Data Feed Example

Source: https://help.awin.com/docs/product-feed-list-download

This section displays an example of the data available for advertisers, including their ID, name, region, membership status, and details about their product feeds.

```APIDOC
## GET /websites/help_awin/advertiser_data

### Description
Retrieves an example output of advertiser data and their product feed information.

### Method
GET

### Endpoint
/websites/help_awin/advertiser_data

### Parameters
#### Query Parameters
- **format** (string) - Optional - The desired output format (e.g., 'csv', 'json').
- **apikey** (string) - Required - Your unique API key for authentication.
- **fid** (integer) - Required - The Feed ID for the specific product feed.
- **language** (string) - Optional - The language for the feed data (e.g., 'en').
- **delimiter** (string) - Optional - The delimiter character for CSV format.
- **compression** (string) - Optional - The compression type for the feed (e.g., 'gzip').
- **adultcontent** (integer) - Optional - Flag to include adult content (1 for yes, 0 for no).
- **columns** (string) - Optional - Comma-separated list of specific columns to include in the feed.

### Request Example
```json
{
  "message": "Example request for advertiser data. Specific parameters depend on the API implementation."
}
```

### Response
#### Success Response (200)
- **Advertiser ID** (integer) - Unique identifier for the advertiser.
- **Advertiser Name** (string) - The name of the advertiser.
- **Primary Region** (string) - The primary region associated with the advertiser.
- **Membership Status** (string) - The current membership status of the advertiser.
- **Feed ID** (integer) - Unique identifier for the advertiser's product feed.
- **Feed Name** (string) - The name of the product feed.
- **Language** (string) - The language of the feed data.
- **Vertical** (string) - The industry vertical of the advertiser.
- **Last Imported** (datetime) - The timestamp of the last data import.
- **URL** (string) - The URL to access the advertiser's data feed.

#### Response Example
```json
[
  {
    "Advertiser ID": 9,
    "Advertiser Name": "Fragrancedirect",
    "Primary Region": "GB",
    "Membership Status": "Not Joined",
    "Feed ID": 9,
    "Feed Name": "IR product feed",
    "Language": "English",
    "Vertical": null,
    "Last Imported": "2017-07-09 07:07:32",
    "URL": "http://datafeed.api.productserve.com/datafeed/download/apikey/_apikey_here_/fid/9/format/csv/language/en/delimiter/%2C/compression/gzip/adultcontent/1/columns/aw_deep_link%2Cproduct_name%2Caw_product_id%2Cmerchant_product_id%2Cmerchant_image_url%2Cdescription%2Cmerchant_category%2Csearch_price%2Cmerchant_name%2Cmerchant_id%2Ccategory_name%2Ccategory_id%2Caw_image_url%2Ccurrency%2Cstore_price%2Cdelivery_cost%2Cmerchant_deep_link%2Clanguage%2Clast_updated%2Cbrand_name%2Cbrand_id%2Ccolour%2Cproduct_short_description%2Cspecifications%2Ccondition%2Cproduct_model%2Cmodel_number%2Cdimensions%2Ckeywords%2Cpromotional_text%2Cproduct_type%2Ccommission_group%2Cmerchant_product_category_path%2Cmerchant_product_second_category%2Cmerchant_product_third_category%2Crrp_price%2Csaving%2Csavings_percent%2Cbase_price%2Cbase_price_amount%2Cbase_price_text%2Cproduct_price_old%2Cdelivery_restrictions%2Cdelivery_weight%2Cwarranty%2Cterms_of_contract%2Cdelivery_time%2Cin_stock%2Cstock_quantity%2Cvalid_from%2Cvalid_to%2Cis_for_sale%2Cweb_offer%2Cpre_order%2Cstock_status%2Csize_stock_status%2Csize_stock_amount%2Cmerchant_thumb_url%2Clarge_image%2Calternate_image%2Caw_thumb_url%2Calternate_image_two%2Calternate_image_three%2Creviews%2Caverage_rating%2Crating%2Cnumber_stars%2Cnumber_available%2Ccustom_1%2Ccustom_2%2Ccustom_3%2Ccustom_4%2Ccustom_5%2Ccustom_6%2Ccustom_7%2Ccustom_8%2Ccustom_9%2Cean%2Cisbn%2Cupc%2Cmpn%2Cparent_product_id%2Cproduct_GTIN%2Cbasket_link"
  },
  {
    "Advertiser ID": 61,
    "Advertiser Name": "TheDrinkShop",
    "Primary Region": "GB",
    "Membership Status": "Not Joined",
    "Feed ID": 61,
    "Feed Name": "Default",
    "Language": "English",
    "Vertical": null,
    "Last Imported": "2017-07-10 07:07:32",
    "URL": "http://datafeed.api.productserve.com/datafeed/download/apikey/_apikey_here_/fid/61/format/csv/language/en/delimiter/%2C/compression/gzip/adultcontent/1/columns/aw_deep_link%2Cproduct_name%2Caw_product_id%2Cmerchant_product_id%2Cmerchant_image_url%2Cdescription%2Cmerchant_category%2Csearch_price%2Cmerchant_name%2Cmerchant_id%2Ccategory_name%2Ccategory_id%2Caw_image_url%2Ccurrency%2Cstore_price%2Cdelivery_cost%2Cmerchant_deep_link%2Clanguage%2Clast_updated%2Cbrand_name%2Cbrand_id%2Ccolour%2Cproduct_short_description%2Cspecifications%2Ccondition%2Cproduct_model%2Cmodel_number%2Cdimensions%2Ckeywords%2Cpromotional_text%2Cproduct_type%2Ccommission_group%2Cmerchant_product_category_path%2Cmerchant_product_second_category%2Cmerchant_product_third_category%2Crrp_price%2Csaving%2Csavings_percent%2Cbase_price%2Cbase_price_amount%2Cbase_price_text%2Cproduct_price_old%2Cdelivery_restrictions%2Cdelivery_weight%2Cwarranty%2Cterms_of_contract%2Cdelivery_time%2Cin_stock%2Cstock_quantity%2Cvalid_from%2Cvalid_to%2Cis_for_sale%2Cweb_offer%2Cpre_order%2Cstock_status%2Csize_stock_status%2Csize_stock_amount%2Cmerchant_thumb_url%2Clarge_image%2Calternate_image%2Caw_thumb_url%2Calternate_image_two%2Calternate_image_three%2Creviews%2Caverage_rating%2Crating%2Cnumber_stars%2Cnumber_available%2Ccustom_1%2Ccustom_2%2Ccustom_3%2Ccustom_4%2Ccustom_5%2Ccustom_6%2Ccustom_7%2Ccustom_8%2Ccustom_9%2Cean%2Cisbn%2Cupc%2Cmpn%2Cparent_product_id%2Cproduct_GTIN%2Cbasket_link"
  },
  {
    "Advertiser ID": 129,
    "Advertiser Name": "InterRose",
    "Primary Region": "GB",
    "Membership Status": "Not Joined",
    "Feed ID": 129,
    "Feed Name": "Default",
    "Language": "English",
    "Vertical": null,
    "Last Imported": "2017-07-11 07:07:32",
    "URL": "http://datafeed.api.productserve.com/datafeed/download/apikey/_apikey_here_/fid/129/format/csv/language/en/delimiter/%2C/compression/gzip/adultcontent/1/columns/aw_deep_link%2Cproduct_name%2Caw_product_id%2Cmerchant_product_id%2Cmerchant_image_url%2Cdescription%2Cmerchant_category%2Csearch_price%2Cmerchant_name%2Cmerchant_id%2Ccategory_name%2Ccategory_id%2Caw_image_url%2Ccurrency%2Cstore_price%2Cdelivery_cost%2Cmerchant_deep_link%2Clanguage%2Clast_updated%2Cbrand_name%2Cbrand_id%2Ccolour%2Cproduct_short_description%2Cspecifications%2Ccondition%2Cproduct_model%2Cmodel_number%2Cdimensions%2Ckeywords%2Cpromotional_text%2Cproduct_type%2Ccommission_group%2Cmerchant_product_category_path%2Cmerchant_product_second_category%2Cmerchant_product_third_category%2Crrp_price%2Csaving%2Csavings_percent%2Cbase_price%2Cbase_price_amount%2Cbase_price_text%2Cproduct_price_old%2Cdelivery_restrictions%2Cdelivery_weight%2Cwarranty%2Cterms_of_contract%2Cdelivery_time%2Cin_stock%2Cstock_quantity%2Cvalid_from%2Cvalid_to%2Cis_for_sale%2Cweb_offer%2Cpre_order%2Cstock_status%2Csize_stock_status%2Csize_stock_amount%2Cmerchant_thumb_url%2Clarge_image%2Calternate_image%2Caw_thumb_url%2Calternate_image_two%2Calternate_image_three%2Creviews%2Caverage_rating%2Crating%2Cnumber_stars%2Cnumber_available%2Ccustom_1%2Ccustom_2%2Ccustom_3%2Ccustom_4%2Ccustom_5%2Ccustom_6%2Ccustom_7%2Ccustom_8%2Ccustom_9%2Cean%2Cisbn%2Cupc%2Cmpn%2Cparent_product_id%2Cproduct_GTIN%2Cbasket_link"
  }
]
```

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

### Branch SDK Purchase Event Example

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

Example of how to log a purchase event using the Branch SDK with commission group data.

```APIDOC
## Integrating Branch SDK for Purchases

### Request Body Example
```javascript
let event = BranchEvent.standardEvent(.purchase);
event.cg = "NEW:34.00“;
// Other event properties can be set here
```

### Notes
Ensure the `parts` parameter within the postback is updated accordingly: `_& parts=${ (event__****_data.cg_**** _)!}_`
```

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

### Example Tracking Link for Awin

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

An example of a tracking link generated for Awin, including parameters for attribution and user identification. This link is used to track user engagement and attribute conversions.

```text
https://posthaus.sng.link/Adch7/t46t?_dl=posthaus%3A%2F%2Fposthaus.com.br%2F&_smtype=3&pcid=!!!id!!!&cl=!!!awc!!!&psn=!!!companyname!!!&psid=!!!affid!!!&pcrid=!!!linkid!!!
```

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

### Installment Payment JSON Example

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

Example of installment payment plan details in JSON. This optional field includes the number of months and the amount per installment.

```json
{
  "installment":{
    "months":6,
    "amount":"50 BRL"
  }
}
```

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

### Postback URLs

Source: https://help.awin.com/docs/kochava

Details of postback URLs for 'Install' and 'Purchase' events when using Kochava.

```APIDOC
## Postback details and commission groups

### Install

#### Description
Postback URL template for tracking app installs.

#### Method
Not Applicable (URL Template)

#### Endpoint
`https://www.awin1.com/sread.php`

#### Query Parameters
- **tt** (string) - Tracking type parameter.
- **tv** (string) - Tracking version parameter.
- **merchant** (string) - Awin Merchant ID.
- **amount** (string) - Fixed value '1' for install events.
- **ch** (string) - Channel parameter.
- **ref** (string) - Kochava device ID.
- **parts** (string) - Defines the event type and commission rate (e.g., `INSTALL_{platform}:1`).
- **cks** (string) - Click ID.
- **testmode** (string) - Test mode flag (0 for off).
- **type** (string) - Event type ('ai' for app install).
- **p1** (string) - Platform.
- **p2** (string) - OS version.
- **p3** (string) - Device type.
- **p4** (string) - Country.
- **p30** (string) - Source identifier ('kochava').

### Purchase

#### Description
Postback URL template for tracking in-app purchases.

#### Method
Not Applicable (URL Template)

#### Endpoint
`https://www.awin1.com/sread.php`

#### Query Parameters
- **tt** (string) - Tracking type parameter.
- **tv** (string) - Tracking version parameter.
- **merchant** (string) - Awin Merchant ID.
- **amount** (string) - Event value (purchase amount).
- **ch** (string) - Channel parameter.
- **ref** (string) - Awin order ID.
- **parts** (string) - Defines commission group and event value (e.g., `{awin.commission_code}:{event_value}`).
- **cks** (string) - Click ID.
- **p1** (string) - Platform.
- **type** (string) - Event type ('ap' for app purchase).
- **cr** (string) - Currency.
- **vc** (string) - Awin voucher code.
- **p2** (string) - Device version.
- **p3** (string) - Device type.
- **p4** (string) - Country.
- **p5** (string) - Kochava device ID.
- **p30** (string) - Source identifier ('kochava').

### Commission Group Configuration

#### Description
Details on how to configure commission groups for purchases.

#### Method
Not Applicable (Configuration Guidance)

#### Parameters
- **COMMISSION GROUP CODE** (field) - Enter a static commission group code or the parameter name from event metadata if multiple commission groups are used.

#### Notes
If using a parameter for commission groups, ensure it's named `commission_group` and specified in the 'COMMISSION GROUP CODE' field.
```

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

### Sale Price Effective Date JSON Example

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

Example for the effective date range of a sale price in JSON. This recommended field uses ISO 8601 format to specify the start and end of the sale period.

```json
{
  "sale_price_effective_date":"2022-02-24T13:00-0800/2022-03-29T15:30-0800"
}
```
Tokens:
Raw