publisher/report/transaction-details
The transaction details resource allows affiliates to pull transaction data for each program they belong to.
| GET | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| startDate | A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored. |
yyyy-mm-dd | N/A | Yes |
| endDate | A valid date string in the ISO 8601 date format; any timestamp information that is present will be ignored. PLEASE NOTE: The period of time formed by the start date and the end date must not exceed 6 months. |
yyyy-mm-dd | N/A | Yes |
| website | If not included, reports will not contain website information. If the parameter value is 'all' the website information will be appended as the last row and the URL will be displayed. If a specific website ID is supplied the report will be refined to only contain results relevant to that website. | all, specific ID | N/A | No |
| includeCoupons | If included, reports will contain the coupons field. | 1,true | 0,false | No |
| deviceType | If included, reports will contain the device type. | 1,true | 0,false | No |
| newToFile | Filters transactions to show new to file or not new to file | 'yes', 'no' | N/A | No |
| removeCsvHeaders | Removes the CSV column headers from the report. | 1,true | 0,false | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| transaction_id | Transaction ID | |||
| order_id | Transaction Order ID | |||
| sid | Transaction SID | |||
| creative_type | Transaction Creative Type | one of: product, text, advanced, banner, contextual, newsletter, manual, generic, call, aggregate, skimlinks | ||
| sub_type | The sub-type of the advanced creative type | one of: flash, html, email, in-store, printable | ||
| commission | Transaction Commission Amount | |||
| sale_amount | Transaction Order Amount | |||
| type | Transaction Type | one of: bonus, lead, sale, click | ||
| date | Transaction Date | |||
| status | Transaction Status | one of: paid, pending, locked, delayed, unconfirmed | ||
| link_type | Link type | |||
| new_to_file | New to file | Available for Dynamic Tracking only | ||
| transaction_type | Transaction type | |||
| program_name | Program Name | |||
| program_id | Program ID | |||
| website (optional) | Website URL | URL from website tracking | ||
| coupons (optional) | Coupon codes sent with the transaction | Available for Dynamic Tracking Programs only | ||
| device_type (optional) | Device Type | one of: mobile, tablet, desktop | ||
| publisher_referral_url | This field associates the traffic and conversions with the URL you specified in your tracking links. | |||