Request Types
- 04 Nov 2024
- DarkLight
Request Types
- Updated on 04 Nov 2024
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Request Type - Transaction Notification
GET Request
The transaction data will be delivered as a GET request to the URL you have specified and placeholders can be utilised to modify the path or request part of the URL to make the request dynamic. The macros are case sensitive, please make sure to configure them as mentioned below.
Placeholders
Placeholder | Description | Example |
| The Publisher ID associated to the transaction | 45628 |
| The Creative ID linked to the converting click | 291555 |
| Click/View identifier/reference specified by the Publisher. See Publisher ClickRef | LINKCMP2013-06 |
| Click/View identifier/reference specified by the Publisher. See Publisher ClickRef | LINKCMP2013-06 |
| Click/View identifier/reference specified by the Publisher. See Publisher ClickRef | LINKCMP2013-06 |
| Click/View identifier/reference specified by the Publisher. See Publisher ClickRef | LINKCMP2013-06 |
| Click/View identifier/reference specified by the Publisher. See Publisher ClickRef | LINKCMP2013-06 |
| Click/View identifier/reference specified by the Publisher. See Publisher ClickRef | LINKCMP2013-06 |
| Click date in format | 2013-06-13 12:00:00 |
| Click date in format | 2013-06-13 12:00:00 |
| Commission amount awarded for the transaction | 1.64 |
| Commission group breakdown associated with the transaction (in JSON format) | See below under POST Request (JSON) / Example Data |
| The creative group ID linked to the converting click | 137726 |
| The Advertiser program ID that the transaction belongs to | 3661 |
| Search engine phrase. It is extracted from the referrer of the click. | Electronic music |
| Product breakdown associated with the transaction (in JSON format) | See below under POST Request (JSON) / Example Data |
| Search engine name. It is extracted from the referrer of the click. | MSN Live Search |
| Total sale amount in the currency of the Advertiser program (!!!transactionCurrency!!!) | 26.09 |
| Transaction date in format | 2013-06-13 12:05:00 |
| Our unique Transaction ID | 105956531 |
| Referring click URL | |
| 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 |
| 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 |
| The total sale amount in the original purchase currency (!!!trackedCurrency!!!) | 20.04 |
Example URL
http://www.publisher-domain.com/!!!merchantId!!!/pixel.php?clk=!!!clickRef!!!&cnv=!!!transactionId!!!&com=!!!commission!!!POST Request (JSON)
The transaction data will be delivered as a JSON package using a POST request named AwinTransactionPush to the URL you have specified. Not all keys are available & sent for all transactions (e.g. clickRef2 is only available for the transaction if this was passed in the winning click). Expected content-type is "application/x-www-form-urlencoded; charset=UTF-8".
Example Data
echo $_POST["AwinTransactionPush"];
=
{"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 \u2013 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"}]}
JSON Decoded Example Data
var_dump(json_decode($_POST["AwinTransactionPush"], true));
=
array(17) {
["transactionId"]=>
string(9) "105956531"
["transactionDate"]=>
string(19) "2013-06-13 12:05:00"
["transactionCurrency"]=>
string(3) "GBP"
["transactionAmount"]=>
string(5) "26.09"
["trackedCurrency"]=>
string(3) "EUR"
["trackedAmount"]=>
string(5) "34.04"
["affiliateId"]=>
string(6) "45628"
["merchantId"]=>
string(4) "3661"
["groupId"]=>
string(1) "0"
["bannerId"]=>
string(1) "0"
["clickRef"]=>
string(14) "LINKCMP2013-06"
["clickRef4"]=>
string(12) "User82828211"
["clickThroughTime"]=>
string(19) "2013-06-13 12:00:00"
["commission"]=>
string(4) "1.64"
["clickTime"]=>
string(19) "2013-06-13 12:00:00"
["url"]=>
string(55) "http://www.publisher-domain.com/advertiser/product/"
["phrase"]=>
string(16) "Electronic music"
["searchEngine"]=>
string(15) "MSN Live Search"
["commissionGroups"]=>
array(2) {
[0]=>
array(4) {
["id"]=>
string(5) "47963"
["name"]=>
string(2) "CD"
["code"]=>
string(2) "CD"
["description"]=>
string(2) "CD"
}
[1]=>
array(4) {
["id"]=>
string(5) "47965"
["name"]=>
string(3) "DVD"
["code"]=>
string(3) "DVD"
["description"]=>
string(3) "DVD"
}
}
["products"]=>
array(2) {
[0]=>
array(7) {
["productName"]=>
string(26) "The Knife – Silent Shout"
["unitPrice"]=>
string(4) "5.55"
["skuType"]=>
string(0) ""
["skuCode"]=>
string(10) "B000EMSUQA"
["quantity"]=>
string(1) "2"
["category"]=>
string(16) "Electronic Music"
["cgId"]=>
string(5) "47963"
}
[1]=>
array(7) {
["productName"]=>
string(17) "Sigur Ros - Heima"
["unitPrice"]=>
string(5) "14.99"
["skuType"]=>
string(0) ""
["skuCode"]=>
string(10) "B000EMSUQA"
["quantity"]=>
string(1) "1"
["category"]=>
string(9) "Music DVD"
["cgId"]=>
string(5) "47965"
}
}
}Was this article helpful?