The Item-based Details Report Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to request item sale or return details from Commission Junction. Developers may request data using their valid developer key and the Original Action ID (or a list of IDs in CSV format). You may obtain the Original Action ID from the response field of the Daily Publisher Commission Report Service.
In addition to item-based details, the Item-based Details Report Service returns a history of the transactions for the associated request. This history helps to correlate correction transactions to the original transactions when SKU level information is not available.
Refer to the following sections of this topic for more specific information.
Note: Refer to https://pubcommission.api.cj.com for the most recent version of the Item-based Details Report Service WSDL. The WSDL provides all the programmatic information you need to use this API. The hand-edited version provides the information in a readable format; however, to ensure maximum compatibility with the system, use the AXIS version when developing your application.
Refer to the following table for a list of the required and optional request parameters. All parameter names and values are case sensitive.
|
Parameter Name |
Value |
Req? |
Description |
|
developerKey |
String |
Required |
Your developer key obtained from the Web Services Developer Site. |
|
originalActionIds |
String |
Required |
The Original Action ID from the responce field of the Daily Publisher Commission Report Service used to correlate with the original action and obtain SKU level information and a transaction history. You may enter more than one original Action ID (comma seperated). |
The response includes information about the general response, as well as specific information for each record in the response. All parameter names and values are case sensitive.
The response includes the following information about the overall set of results in the response.
|
Field Name |
Value |
Description |
|
PublisherCommissionDetailResponse |
Array |
This is an array containing one element for every original action id provided in the request. Each element is of type OriginalActionDetail. |
This response is an array containing one element for each transaction (original and corrected) of the original action specified. Each element is of type TransactionDetail.
|
Field Name |
Value |
Description |
|
TransactionDetail |
Array |
Each TransactionDetail element is an array of the two following object types.
|
The response includes the following objects for each transaction (original and corrected) of the specified original action.
|
Field Name |
Value |
Description |
|
ItemDetails[] |
Array |
This is an array containing one element for every item in the transaction. Each element is an object which consists of item details. |
|
PublisherCommission |
Object |
This object consists of same response fields as the Daily Publisher Commission Report Service. |
The response includes the following fields for each item in the Transaction Detail.
|
Field Name |
Value |
Description |
|
sku |
Long |
The SKU identification of the associated item. |
|
amount |
Double |
The monetary amount, in USD, associated with the specific item in the transaction. |
|
quantity |
Integer |
The quantity of the specific item for the associated transaction. |
|
postingDate |
Date |
The posting date for the item in the associated transaction. |
|
Id |
Long |
The identification number for the associated item transaction |
|
Error |
Description |
|
Not Authenticated |
The system could not authenticate your developer key. |