Transaction Notifications

Set up Notifications using Callback method

Log into Awin and go to Toolbox > Transaction Notifications

Enabling Transaction Notifications

If you don't see the "Transaction Notifications" option in your navigation raise a support ticket here to request access.

Working with Callback URL’s might proof technically difficult to some. If you are unfamiliar try setting up notifications via Zapier. For detailed instructions see this page.

There are four settings which need to be considered:

Call-back URL: Enter the URL where Awin will send transaction data. This could be a script on your server (e.g., PHP, Node.js). Ensure your server is set up to handle incoming requests on ports 80 or 443. Example:

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

Call-back method: Here you can choose if you want to get the data delivered as a GET or POST request.

Product Data: Tick this box if you wish for data about the actual products bought to be passed back. Data will be delivered for GET and POST method. This is dependent on the Advertiser implementing Product Level Tracking - and furthermore actively sharing this data with Publishers - which may not always be the case.

Click Source Data: Enable this to receive information about the initial click that led to the transaction.

After configuring these settings, click Submit. A confirmation message will indicate that your changes have been successfully saved.

Request Type

There are two types of requests possible. A GET request allows you to return the results as part of an URL whereas the POST method returns the results in a JSON format which then allows you to easily parse that data and store it in other places like Excel files for example.

POST Request

GET Request

In a GET request, transaction data is sent as URL parameters. You can use placeholders (macros) in your URL, which Awin will replace with actual transaction values.

Example URL

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

Common Placeholders

Placeholder	Description	Example
`!!!affiliateId!!!`	The Publisher ID associated to the transaction	45628
`!!!bannerId!!!`	The Creative ID linked to the converting click	291555
`!!!clickRef!!!`	Click/View identifier/reference specified by the Publisher. See Publisher ClickRef	LINKCMP2013-06
`!!!clickRef2!!!`	Click/View identifier/reference specified by the Publisher. See Publisher ClickRef	LINKCMP2013-06
`!!!clickRef3!!!`	Click/View identifier/reference specified by the Publisher. See Publisher ClickRef	LINKCMP2013-06
`!!!clickRef4!!!`	Click/View identifier/reference specified by the Publisher. See Publisher ClickRef	LINKCMP2013-06
`!!!clickRef5!!!`	Click/View identifier/reference specified by the Publisher. See Publisher ClickRef	LINKCMP2013-06
`!!!clickRef6!!!`	Click/View identifier/reference specified by the Publisher. See Publisher ClickRef	LINKCMP2013-06
`!!!clickThroughTime!!!`	Click date in format `%Y-%m-%d %H:%i:%s` (timezone: UTC)	2013-06-13 12:00:00
`!!!clickTime!!!`	Click date in format `%Y-%m-%d %H:%i:%s` (timezone: UTC)	2013-06-13 12:00:00
`!!!commission!!!`	Commission amount awarded for the transaction	1.64
`!!!commissionGroups!!!`	Commission group breakdown associated with the transaction (in JSON format)	See below table for example response
`!!!groupId!!!`	The creative group ID linked to the converting click	137726
`!!!merchantId!!!`	The Advertiser program ID that the transaction belongs to	3661
`!!!phrase!!!`	Search engine phrase. It is extracted from the referrer of the click.	Electronic music
`!!!products!!!`	Product breakdown associated with the transaction (in JSON format)	See below table for example response
`!!!searchEngine!!!`	Search engine name. It is extracted from the referrer of the click.	MSN Live Search
`!!!transactionAmount!!!`	Total sale amount in the currency of the Advertiser program (!!!transactionCurrency!!!)	26.09
`!!!transactionDate!!!`	Transaction date in format `%Y-%m-%d %H:%i:%s` (timezone: UTC)	2013-06-13 12:05:00
`!!!transactionId!!!`	Our unique Transaction ID	105956531
`!!!url!!!`	Referring click URL	http://www.publisher-domain.com/advertiser/product/
`!!!transactionCurrency!!!`	The Advertiser's program currency. This is the currency of the affiliate transaction (!!!transactionAmount!!! and !!!commission!!!). This is the 3 digit uppercase currency code	GBP
`!!!trackedCurrency!!!`	The original currency in which the purchase was made. This is only available if it's a different currency compared to the Advertiser's program currency. This is the 3 digit uppercase currency code	EUR
`!!!trackedAmount!!!`	The total sale amount in the original purchase currency (!!!trackedCurrency!!!)	20.04

Example of !!!products!!! response:

plt_products[0][productName]: Octopus  
plt_products[0][unitPrice]: 1.00  
plt_products[0][skuType]:   
plt_products[0][skuCode]: 101  
plt_products[0][quantity]: 1  
plt_products[0][category]: Food  
plt_products[0][cgId]:   

plt_products[1][productName]: Fish, best of  
plt_products[1][unitPrice]: 9.00  
plt_products[1][skuType]:   
plt_products[1][skuCode]: 200  
plt_products[1][quantity]: 1  
plt_products[1][category]: Tonträger  
plt_products[1][cgId]:

Example of !!!CommissionGroups!!! response:

commissiongroups[0][id]: 194218  
commissiongroups[0][name]: Default  
commissiongroups[0][code]: DEFAULT  
commissiongroups[0][description]: Default  
commissiongroups[0][commissionAmount]: 0.06  
commissiongroups[0][amount]: 1.00  

commissiongroups[1][id]: 276235  
commissiongroups[1][name]: DVD  
commissiongroups[1][code]: DVD  
commissiongroups[1][description]: DVD  
commissiongroups[1][commissionAmount]: 0.90  
commissiongroups[1][amount]: 9.00

POST Request (JSON)

In a POST request, Awin sends a JSON payload to your specified URL. The content-type is application/x-www-form-urlencoded; charset=UTF-8.

Returning the response

echo $_POST["AwinTransactionPush"];

Example Response

{
  "transactionId": "105956531",
  "transactionDate": "2013-06-13 12:05:00",
  "transactionCurrency": "GBP",
  "transactionAmount": "26.09",
  "affiliateId": "45628",
  "merchantId": "3661",
  "groupId": "0",
  "bannerId": "0",
  "clickRef": "LINKCMP2013-06",
  "clickThroughTime": "2013-06-13 12:00:00",
  "ip": "127.0.0.1",
  "commission": "1.64",
  "clickTime": "2013-06-13 12:00:00",
  "url": "http://www.publisher-domain.com/advertiser/product/",
  "phrase": "Electronic music",
  "searchEngine": "MSN Live Search",
  "commissionGroups": [
    {
      "id": "47963",
      "name": "CD",
      "code": "CD",
      "description": "CD"
    },
    {
      "id": "47965",
      "name": "DVD",
      "code": "DVD",
      "description": "DVD"
    }
  ],
  "products": [
    {
      "productName": "The Knife – Silent Shout",
      "unitPrice": "5.55",
      "skuType": "",
      "skuCode": "B000EMSUQA",
      "quantity": "2",
      "category": "Electronic Music",
      "cgId": "47963"
    },
    {
      "productName": "Sigur Ros - Heima",
      "unitPrice": "14.99",
      "skuType": "",
      "skuCode": "B000EMSUQA",
      "quantity": "1",
      "category": "Music DVD",
      "cgId": "47965"
    }
  ]
}