The Commission Detail Service is a REST-based (Representational State Transfer) API that enables advertisers and publishers to access real-time commission and item-detail data. Advertisers and publishers that wish to receive commission reporting updates in near real-time or to request new commission data on a regular basis can use this API to create in-house tools that access real-time commission data from the CJ network. Developers may request data using multiple parameters to return specific results based on those request parameters.
Important: All information available at the time of the request is sent in the response. Not all advertisers report commissions on a real-time basis, which may result in the response not containing all commissions specified in the request.
Click the following links to display more specific information.
Refer to the following tables for a list of request parameters. All parameter names and values are case-insensitive.
|
Header |
Description |
|
authorization |
Your developer key obtained from the Web Services Developer Site. |
|
Parameter Name |
Comma-separated Values Allowed? |
Required or Optional? |
Description |
Examples |
|
date-type |
No |
Required
|
Use this parameter to specify the date parameter as either the event date or the posting date. Options include the following.
|
https://commission-detail.api.cj.com/v3/commissions?date-type=event https://commission-detail.api.cj.com/v3/commissions?date-type=posting |
|
cids |
Yes |
Optional |
Use this parameter to specify the CID of the joined advertiser or publisher |
https://commission-detail.api.cj.com/v3/commissions?date-type=posting&cids=2151177,1718228 |
|
action-types |
Yes |
Optional |
Use this parameter to specify a specific type of action. Options include the following.
|
https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=bonus https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=click https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=impression https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=sale https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=lead https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=advanced%20sale https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=advanced%20lead https://commission-detail.api.cj.com/v3/commissions?date-type=posting&action-types=performance%20incentive |
|
aids |
Yes |
Optional |
Use this parameter to specify ids for specifics Ad Ids. |
https://commission-detail.api.cj.com/v3/commissions?date-type=posting&aids=39585842,48264758 |
|
action-status |
No |
Optional |
Use this parameter to specify actions of a particular status. Options include the following.
|
https://commission-detail.api.cj.com/v3/commissions?date-type=event&action-status=new https://commission-detail.api.cj.com/v3/commissions?date-type=event&action-status=locked https://commission-detail.api.cj.com/v3/commissions?date-type=event&action-status=extended https://commission-detail.api.cj.com/v3/commissions?date-type=event&action-status=closed |
|
commission-id |
No |
Optional |
Use this parameter to specify the Commission ID. You can initially enter a request for data starting from midnight the previous day, which would look like: https://commission-detail.api.cj.com/v3/commissions?date-type=posting This request will send you all data from midnight yesterday up until now. Moving forward after that, send the most recent Comission ID you have received and our system sends you all new data since that Commission ID (the last request). |
https://commission-detail.api.cj.com/v3/commissions?date-type=posting&commission-id=927650599 |
|
website-ids |
Yes |
Optional |
Use this parameter to specify a particular Web site or set of Web sites. |
https://commission-detail.api.cj.com/v3/commissions?date-type=posting&website-id=9517534 |
|
Header |
Description |
|
authorization |
Your developer key obtained from the Web Services Developer Site. |
|
Parameter Name |
Comma-separated Values Allowed? |
Example |
|
item-detail |
Yes |
https://commission-detail.api.cj.com/v3/item-detail/696882235 |
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 insensitive.
|
Field Name |
Description |
|
action-status |
The associated action status for the item. |
|
action-type |
The associated action type for the item. |
|
aid |
The associated ad identification number. |
|
commission-id |
The associated commission identification number. |
|
country |
The country where the associated transaction occurred. |
|
event-date |
The associated event date for the item in UTC time zone. |
|
locking-date |
The associated date on which the commission is locked for extending or correcting. |
|
order-id |
The associated advertiser-assigned ID number for the transaction. |
|
original |
Displays either a '1' indicating an original transaction or a '0' indicating a non-original or correction transaction. |
|
original-action-id |
The identification number used for correlation between the original transaction and corrections. |
|
posting-date |
The associated post date for the item. |
|
website-id |
The associated publisher Web site identification number. |
|
cid |
The associated CID of the joined advertiser or publisher. |
|
advertiser-name |
The associated advertiser's program name. |
|
commission-amount |
The associated publisher commission amount. |
|
order-discount |
The discount associated with the order. |
|
sid |
(Available to publishers only). The associated publisher surfer identification number. |
|
sale-amount |
The associated advertiser sale amount. |
|
Field Name |
Description |
|
sku |
The SKU identification of the associated item. |
|
quantity |
The quantity of the specific item for the associated transaction. |
|
posting-date |
The posting date for the item in the associated transaction. |
|
sale-amount |
The monetary amount, in USD, associated with the specific item in the transaction. |
|
discount |
This discount associated with the item in the associated transaction. |