Transaction API Documentation

The Transaction API enables the structured export and analysis of transactions recorded within the partner program system. It provides detailed insights into individual transaction processes and assists with billing, performance measurement, and integration into internal or external systems.

The API can be accessed within the user interface under the Data API menu item.

API Call

https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv

Value	Description
www.domain.de	System domain
ACCESS-TOKEN	User's Access Token
ID	User ID
.csv	Download file format

Transaction API Filtering

Various parameters can be used as filters for the Transaction API. Below is an overview of all available parameters:

Transaction Status

Parameter	Value	Example	Description
`condition[l:status]`	`open`	`condition[l:status]=open`	All transactions defined as "Open" in the system
	`confirmed`	`condition[l:status]=confirmed`	All transactions defined as "Confirmed" in the system
	`paid`	`condition[l:status]=paid`	All transactions defined as "Paid" in the system
	`canceled`	`condition[l:status]=canceled`	All transactions defined as "Canceled" in the system

Note: A combination of multiple statuses is possible. For example: condition[l:status]=confirmed,paid

General Filters

Parameter	Value / Example	Description
`condition[period][from]`	01.01.2025	Defines the start date of the time period
`condition[period][to]`	31.01.2025	Defines the end date of the time period
`condition[l:campaigns]`	1	Filters all baskets assigned to a specific campaign. Multiple values allowed.
`condition[datemode]`	processing payout incoming	Determines the type of date period: • processing: Baskets validated within the period • payout: Baskets paid out within the period • incoming: Baskets recorded within the period (transaction date)

Example:

condition[period][from]=01.01.2025&condition[period][to]=31.01.2025&condition[datemode]=processing

Field Definitions in the Transaction API

The downloaded transactions (e.g., as a .csv file) contain the following columns:

Field Name	Description
`id`	Unique ID of the transaction
`status`	Status of the transaction 0 - open 1 - confirmed 2 - cancelled 3 - paid
`timestamp`	Timestamp of the transaction
`campaign_id`	Campaign to which the transaction was assigned
`attribution`	Amount of the paid attribution
`delivered_tagcode_count`	Number of executed tags
`delivered_tagcode_serversided_url`	Transmitted server-side tracking call
`ordertoken`	Order number transmitted by the advertiser
`source`	Source of the transaction
`project_id`	ID of the project to which the transaction was assigned
`admedia_id`	Ad media ID through which the transaction was generated
`type`	Type of transaction (e.g., Sale, Lead, View)
`commission`	Commission assigned to the publisher (will be updated when the order is changed)
`source_commission`	First commission value assigned to the publisher (will not be updated)
`commission_group_id`	Commission group the publisher belonged to when the transaction was generated
`trigger_id`	Trigger ID assigned to the transaction
`description`	Description transmitted with the transaction
`trigger_value`	Remuneration rate defined in the corresponding trigger ID at the time of the transaction
`trigger_type`	Type of trigger (fixed remuneration or percentage remuneration)
`turnover`	Commission-relevant order value
`attributed_turnover`	Attributed turnover (if attribution model is active)
`original_turnover`	Order value in the advertiser's currency
`action_id`	Action ID transmitted with the transaction
`salary_id`	ID of the payout process in which the transaction was settled
`session_id`	Session ID transmitted with the transaction
`order_currency`	Currency of the order
`status_change_date`	Date of the last status change
`cancel_reason`	Reason for cancellation, if the transaction was canceled
`source_turnover`	Order value transmitted by the advertiser (will not be updated)
`last_change`	Timestamp of the last change to the transaction
`user_agent`	Client information of the user who triggered the transaction
`order_actions_id`	Internal reference to the commission-relevant click or post-view
`bonus_id`	ID of a bonus run
`customer_journey_status`	Internal key figure for the customer journey
`ebestid`	Hashed order number displayed to the publisher
`order_timestamp`	Timestamp of the order call
`action_timestamp`	Timestamp of the action that led to the order
`trigger_title`	Name of the trigger
`payoutdate`	Payout date
`campaign_group_title`	Title of the commission group
`project_title`	Name of the project to which the transaction was assigned
`campaign_title`	Name of the campaign assigned to the transaction
`advertiser_id`	ID of the advertiser to whom the transaction was assigned
`advertiser_title`	Name of the advertiser to whom the transaction was assigned
`publisher_id`	ID of the publisher to whom the transaction was assigned
`referrer`	Page where the click-triggering event occurred
`country`	Country where the transaction was generated
`subid`	Sub-ID transmitted with the transaction
`publisher_prename`	First name of the publisher (from system data)
`publisher_surname`	Last name of the publisher (from system data)
`publisher_searchtitle`	Search title of the publisher (from system data)
`basket_items`	Number of items in the shopping cart
`sub_status`	Advertiser's internal status for managing the transaction
`visibility`	Visibility for the publisher
`external_sources_entity_id`	(Account) Id of the external source
`external_sources_currency_code`	Currency Code imported from the external source
`external_sources_currency_rate`	Currency Rate according to the external sources currency code and internal currency code
`external_sources_turnover`	Turnover imported from the external source
`source_project_id`	Publisher/Project id imported from the external source
`source_project_title`	Publisher/Project title imported from the external source
`turnover_brutto`	Turnover including tax