Objects

`ActionTerm`

Information about the limits an advertiser has set up and the commission rates that apply for a specific action tracker.

Field	Type	Description
`actionTracker`	`ActionTracker!`	The action tracker this term applies to.
`commissions`	`[Commission!]!`	The commission rates and conditions that can apply for this action term.
`id`	`ID!`	Action Term ID.
`lockingMethod`	`LockingMethod!`	Determines how actions tracked under this term will be locked.
`performanceIncentives`	`[PerformanceIncentive!]!`	Performance-based commission adjustments that apply when certain thresholds are met.
`referralOccurrences`	`Long`	Number of referrals.
`referralPeriod`	`Long!`	Referral period in days.

`ActionTracker`

Describes an advertiser's integration point with CJ — the action tracker that fires when a commissionable event occurs.

Field	Type	Description
`description`	`String`	Action Tracker description.
`id`	`ID!`	Action Tracker ID.
`name`	`String!`	Action Tracker name.
`type`	`ActionTrackerType!`	Action Tracker type. See `ActionTrackerType` enum.

`Commission`

Different commission rates and conditions that can apply.

Field	Type	Description
`isViewThrough`	`Boolean!`	`true` if this commission applies to view-through attribution (transaction attributed to an ad view rather than a click).
`itemList`	`ItemList`	The item list this commission rate applies to, if any.
`promotionalProperties`	`[PromotionalProperty!]!`	The promotional properties (PIDs) to which this commission rate applies. Empty if this rate applies to all properties.
`rank`	`Long!`	Commission rank. Higher rank = higher priority. When multiple commissions match, the highest-ranked one applies.
`rate`	`CommissionRate!`	The rate paid when all conditions match.
`situation`	`CommissionSituation`	The situation condition that must be met for this rate to apply, if any.

`CommissionRate`

The rate that will get paid if all conditions match.

Field	Type	Description
`currency`	`String`	Currency for fixed commission types. `null` for percent-based commissions.
`type`	`CommissionRateType!`	Commission type. See `CommissionRateType` enum.
`value`	`BigDecimal!`	Commission value. Represents a percentage (e.g. `5` = 5%) for `PERCENT` type, or a fixed amount for `FIXED` and `FIXED_PER_ORDER` types.

`CommissionSituation`

A situation condition that an advertiser has set up to pay different commission rates based on certain conditions.

Field	Type	Description
`id`	`ID!`	Situation ID.
`name`	`String!`	Situation name.

`Contract`

Contract for an advertiser, including program terms.

Argument	Type	Description
advertiserId	ID!	Company id for Advertiser associated with this contract.
endTime	ISODateTime	Date for the contract end.
programTerms	ProgramTerms!	The conditions that are agreed upon for this contract.
startTime	ISODateTime	Date for the contract start.
status	ContractStatus!	Status of contract.

`ContractList`

List of contracts that match the query.

Field	Type	Description
`count`	`Long!`	Count of contracts returned in this response.
`resultList`	`[Contract!]!`	List of contracts matching the query, each including program terms.
`totalCount`	`Long!`	Total count of all available contracts matching the query, regardless of `limit`.

`ItemList`

Advertisers can group items into item lists and apply different commission rates to the list.

Field	Type	Description
`id`	`ID!`	Item List ID.
`name`	`String!`	Item List name.

`LockingMethod`

Determines how actions will be locked.

Field	Type	Description
`durationInDays`	`Long`	Number of days before locking for Fixed Duration type.
`type`	`LockingMethodType!`	Determines how actions will be locked.

`PerformanceIncentive`

Different commission rates depending on factors such as number of actions, amount of commission, amount of sales.

Field	Type	Description
`currency`	`String!`	Incentive currency for fixed incentives and thresholds based on commissions or sales amounts.
`reward`	`PerformanceIncentiveReward!`	The reward which gets applied once the performance incentive threshold is exceeded.
`threshold`	`PerformanceIncentiveThreshold!`	The threshold from which the performance incentive gets applied.

`PerformanceIncentiveReward`

The reward which gets applied once the performance incentive threshold is exceeded.

Field	Type	Description
`commissionType`	`PerformanceIncentiveRewardCommissionType!`	Type of commission associated to the performance incentive.
`type`	`PerformanceIncentiveRewardType!`	Type of reward associated to the performance incentive.
`value`	`BigDecimal!`	Reward value

`PerformanceIncentiveThreshold`

The threshold from which the performance incentive gets applied.

Field	Type	Description
`type`	`PerformanceIncentiveThresholdType!`	Type of threshold associated to the performance incentive.
`value`	`BigDecimal!`	Threshold value.

`ProgramTerms`

The conditions that are agreed upon for this contract.

Field	Type	Description
actionTerms	[ActionTerm!]!	List of action terms.
id	ID!	Program Terms id.
isDefault	Boolean!	Default program terms gets assigned automatically when entering a relationship with the advertiser.
name	String!	Program Terms name.
specialTerms	SpecialTerms	Special terms and conditions that apply to this program term. These are specified by the advertiser and are outside of the standard program term rules.

`PromotionalProperty`

The promotional properties to which this commission rate applies

Field	Type	Description
`id`	`ID!`	Promotional property id.
`name`	`String!`	Promotional property name.

`PublisherQueries`

Publisher related operations.

Field	Type	Description
contracts	ContractList!	Returns one or more contracts filtered according to the supplied arguments.

Argument	Type	Description
filters	ContractFilters	Optional set of filters.
limit	Int	How many contracts to request at once.
offset	Int	Offset in the list of contracts.
publisherId	ID!	Publisher to query for.

`SpecialTerms`

Special terms and conditions that apply to this program term. These are specified by the advertiser and are outside of the standard program term rules.

Field	Type	Description
`body`	`String`	Body text of the special terms.
`name`	`String`	Name of the special terms.

Input Objects

`ContractFilters`

Optional set of filters

Field	Type	Description
advertiserId	ID	If given, will return all contracts with this specific advertiser
activeAfter	ISODateTime	If given, will return all contracts that are active after this given time
activeBefore	ISODateTime	If given, will return all contracts that are active before this given time

Enums

`ActionTrackerType`

Value	Description
item_sale	Item Sale action tracker
item_lead	Item Lead action tracker
sim_lead	Simple Lead action tracker
sim_sale	Simple Sale action tracker
click	Click action tracker
imp	Impression action tracker

`CommissionRateType`

Commission Type

Value	Description
FIXED_PER_ORDER	Fixed per order commission
FIXED	Fixed per item commission
PERCENT	Percent commission

`ContractStatus`

Value	Description
PENDING_REVERSION	Pending reversion contract
PENDING_OFFER	Pending publisher accept contract
CANCELLED	Cancelled contract
EXPIRED	Expired contract
ACTIVE	Active contract

`LockingMethodType`

Determines how actions will be locked

Value	Description
FIXED_DURATION	Actions will be locked the specified number of days after event date
OPEN_ENDED	Actions will be locked by advertisers
FIXED_DATE	Actions will be locked after the 10th of the month
IMMEDIATE	Actions will be locked as soon as they are posted or otherwise determined by CJ

`PerformanceIncentiveRewardCommissionType`

Type of commission associated to the performance incentive

Value	Description
FIXED	When adjusted commission is expressed as a fixed amount, either increase to or bonus
PERCENT	When adjusted commission is expressed as percent

`PerformanceIncentiveRewardType`

Type of reward associated to the performance incentive

Value	Description
ONE_TIME_BONUS	One time bonus applied on top of existing commission
INCREASE_COMMISSION_TO	New value of commission after applying performance incentive

`PerformanceIncentiveThresholdType`

Type of threshold associated to the performance incentive

Value	Description
TOTAL_SALES_AMOUNT	Threshold is based on amount of sales in given currency
TOTAL_COMMISSIONS	Threshold is based on amount of commission in given currency
NUMBER_OF_ACTIONS	Threshold is based on number of actions

Scalars

Name	Description
BigDecimal	The `BigDecimal` scalar type represents signed fractional values with arbitrary precision.
Boolean	The `Boolean` scalar type represents `true` or `false`.
ID	The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
ISODateTime	ISO 8601 datetime. e.g. '1999-12-31T23:59:59Z'
Int	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Long	The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.
String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.