advertiser/transaction
The transaction resource allows you to create and correct transactions. Programs with basic tracking should use the basic tracking documentation. Programs with itemized tracking should use the itemized tracking documentation. Programs with dynamic tracking should use the dynamic tracking documentation.
Basic Tracking
This is the resource for basic tracking advertisers to correct their existing transactions.
| PUT | ||||
|---|---|---|---|---|
| Put Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| order_id |
(Order ID) A unique ID, supplied by the advertiser, identifying transaction. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_) |
Character (50) | N/A | Yes |
| amount |
"SALE" based transactions, this value will replace the original transaction's amount and will be used to recalculate the publisher's earned commission. "LEAD" AND "CPC" based transactions, this value will replace the original transaction's amount and is used primarily for reporting purposes. NOTE: Do not include dollar signs ($) or commas (,) in this field. |
* Decimal | N/A | Yes |
| reason |
Please use one of the following codes for the reason you are correcting the transaction: 1 - Invalid credit card number |
1,2,3,4,6,7,10,11,8 | N/A | Yes |
| affiliate_commission |
"SALE" based transactions, this value will be ignored completely. "LEAD" AND "CPC" based transactions, this value will be the new dollar amount that will be paid out to publisher. NOTE: Do not include dollar signs ($) or commas (,) in this field. |
* Decimal | N/A | Required for CPC and Lead transactions |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
Itemized Tracking
This is the resource for itemized tracking advertisers to correct their existing transactions
| PUT | ||||
|---|---|---|---|---|
| Put Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| order_id |
(Order ID) A unique ID, supplied by the advertiser, identifying transaction. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_) |
Character (50) | N/A | Yes |
| items[] |
An array containing individual items (also in array format) for the order. |
N/A | Yes | |
| items[n][id] |
A unique ID, supplied by the advertiser, identifying the item. Otherwise known as the product ID, or SKU. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_) |
Character (50) | N/A | Yes |
| items[n][amount] |
"SALE" based transactions, this value is the new sale amount for the single item. "LEAD" based transactions, this value is the flat dollar amount of a single lead and becomes the new amount paid to the publisher after it is multiplied by the quantity. NOTE: Do not include dollar signs ($) or commas (,) in this field. |
* Decimal | N/A | Yes |
| items[n][quantity] |
The number of items; must be an integer. |
* Integer | N/A | Yes |
| items[n][reason] |
Please use one of the following codes for the reason you are correcting the transaction: 1 - Invalid credit card number |
1,2,3,4,6,7,10,11,8 | N/A | Yes |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
* Values shown are placeholder values. Please replace with actual data.
Dynamic Tracking
This is the resource for dynamic tracking advertisers to create new transactions.
| POST | ||||
|---|---|---|---|---|
| Post Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| type | The transaction type: Sale (1) or Lead (2). | 1.2 | 1 | No |
| publisher_id | The publisher id from the transaction. | Integer | N/A | Yes |
| order_id | (Order ID) A unique ID, supplied by the advertiser, identifying transaction. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes (-), underscores (_) |
Character (50) | N/A | Yes |
| items[] | An array containing individual items (also in array format) for the order. | N/A | Yes | |
| items[n][id] | A unique ID, supplied by the advertiser, identifying the item. Otherwise known as the product ID, or SKU. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes (-), underscores (_) |
Character (50) | N/A | Yes |
| items[n][amount] | The sale amount of the ITEM_ID. The unit price should reflect any coupon or discount that is applied to an order and should be before shipping and taxes. |
* Decimal | N/A | Yes |
| items[n][quantity] | The quantity of ITEM_ID ordered. Must be a non-negative integer. |
* Integer | N/A | Yes |
| items[n][category] | The category ID that is meaningful to you for ITEM_ID. | Character (64) | N/A | No |
| created | The datetime the transaction took place. | yyyy-mm-dd hh:mm:ss | N/A | Yes |
| currency | The currency of the item prices being passed for the order. When not supplied, amounts are assumed to be in the program's native currency. Accepted values are the three-letter abbreviations of the currencies supported by our platform: USD, CAD, GBP, EUR, AUD, CNY, JPY, INR, KRW, SGD, RUB, TRY, BRL, MXN, ARS, CHF, HKD. |
Character (3) | N/A | Yes |
| new_to_file | Whether or not the customer that placed the order is a new customer in your system using whatever business logic you deem appropriate. Note: This value should be 1 (one) if the customer is new or 0 (zero) if the customer is not new. |
Boolean | N/A | No |
| coupons[] | An array containing individual coupons. This is used to ensure credit is given to the owner of the personalized creative, rather than someone who may have used it without permission. If a list is provided, the first valid code will be used. If a valid code is not provided, the sale will be attributed as normal. This also may affect commissions if you have a Coupon Rule set up in the applied Term. Note: This feature requires additional setup by your Account Manager. |
N/A | No | |
| segment | Custom Segment can be used to pass any attributed that is meaningful to you with the order. | Character (64) | N/A | No |
| click_ids[] | A collection of click ids associated with the transaction. | N/A | No | |
| google_click_ids[] | A collection of google click ids associated with the transaction. | N/A | No | |
This is the resource for dynamic tracking advertisers to correct their existing transactions
| PUT | ||||
|---|---|---|---|---|
| Put Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| order_id |
(Order ID) A unique ID, supplied by the advertiser, identifying transaction. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_) |
Character (50) | N/A | Yes |
| items[] |
An array containing individual items (also in array format) for the order. |
N/A | Yes | |
| items[n][id] |
A unique ID, supplied by the advertiser, identifying the item. Otherwise known as the product ID, or SKU. Allowed Characters: Alpha-Numerics (A-Za-z0-9), dashes(-), underscores(_) |
Character (50) | N/A | Yes |
| items[n][amount] |
The sale amount of the ITEM_ID. The unit price should reflect any coupon or discount that is applied to an order, and should be before shipping and taxes. For full returns or cancellations, this field should be set to zero (0) |
* Decimal | N/A | Yes |
| items[n][quantity] |
The quantity of ITEM_ID ordered. Must be a non-negative integer. |
* Integer | N/A | Yes |
| items[n][category] |
The category ID that is meaningful to you for ITEM_ID. |
Character (64) | N/A | No |
| items[n][reason] |
Please use one of the following codes for the reason you are correcting the transaction: 1 - Invalid credit card number |
1,2,3,4,6,7,10,11,8 | N/A | No |
| currency |
The currency of the item prices being passed for the order. When not supplied, amounts are assumed to be in the program's native currency. are the three-letter abbreviations of the currencies supported by our platform: USD, CAD, GBP, EUR, AUD, CNY, JPY, INR, KRW, SGD, RUB, TRY, BRL, MXN, ARS, CHF, HKD. |
Character (3) | N/A | Yes |
| new_to_file |
Whether or not the customer that placed the order is a new customer in your system using whatever business logic you deem appropriate. Note: This value should be 1 (one) if the customer is new or 0 (zero) if the customer is not new. |
Boolean | N/A | No |
| coupons[] |
An array containing individual coupons. This is used to ensure credit is given to the owner of the personalized creative, rather than someone who may have used it without permission. If a list is provided, the first valid code will be used. If a valid code is not provided, the sale will be attributed as normal. This also may affect commissions if you have a Coupon Rule set up in the applied Term. Note: This feature requires additional setup by your Account Manager. Modifying Coupons does not affect owner attribution, only potentially the commissions earned. |
N/A | No | |
| segment |
Custom Segment can be used to pass any attributed that is meaningful to you with the order. |
Character (64) | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| N/A | ||||
* Values shown are placeholder values. Please replace with actual data.