Transaktions API - Dokumentation

DieÜber Transaktionsdie Transaktions-API ermöglichtholen denSie strukturiertenalle ExportTransaktionen Ihres Partnerprogramms als Datei oder als JSON ab: mit Status, Umsatz, Provision, Publisher und Projekt. Damit lassen sich Abrechnung, Kostenauswertung und die AnalyseAnbindung vonexterner Transaktionen,Tools die(BI, imAttribution, RahmenData desWarehouse) Partnerprogramm-Systemsautomatisieren. erfasstDiese wurden.Seite beschreibt, wie Sie bieteteinen detaillierteZugang Einblickeeinrichten, wie der Aufruf aussieht, welche Filter es gibt und was in einzelnejeder TransaktionsvorgängeSpalte und unterstützt bei der Abrechnung, Erfolgsmessung sowie der Integration in interne oder externe Systeme.steht.

Die API kann im User-Interface unter dem Menüpunkt Daten-API verwendet werden.

---

API-AufrufÜberblick

---

Schritt 1: Zugang einrichten

Jeder Benutzer im System hat seinen eigenen API-Token. Der Token gibt genau die Daten frei, die dieser Benutzer auch in der Oberfläche sehen darf.

Für externe Tools und Dienstleister empfehlen wir immer einen eigenen Benutzer, nicht Ihren persönlichen Zugang. So bestimmen Sie selbst, was das Tool sieht, und können den Zugang jederzeit sperren oder den Token erneuern, ohne dass Ihr eigener Login betroffen ist.

Berechtigungsgruppe anlegen

Systemsteuerung → Berechtigungsgruppen öffnen und Neue Gruppe anlegen klicken. Einen sprechenden Namen vergeben, zum Beispiel API lesend. Nur das freigeben, was das Tool braucht: Berechtigung Einstellung Wofür Transaktionsliste ACCESS_READ Transaktions-API Export-Links yes Abruflinks auf der Seite Daten-API Publisher Daten anzeigen yes, wenn Publisher-Namen gebraucht werden Spalten publisher_prename, publisher_surname, publisher_searchtitle Statistiken, die abgerufen werden sollen ACCESS_READ nur bei Nutzung der Statistik-API alles andere ACCESS_DENY bzw. no

Was die einzelnen Rechte bedeuten, steht unter Berechtigungen für Nutzer des Systems einstellen.

Benutzer anlegen

Systemsteuerung → Benutzerverwaltung öffnen und einen neuen Benutzer anlegen. Name und E-Mail so wählen, dass klar ist, wofür der Zugang da ist, zum Beispiel API Kostenimport. Die eben angelegte Berechtigungsgruppe zuweisen und speichern.

Token ablesen

Als dieser Benutzer einloggen und API → Daten-API öffnen. Dort stehen der Token und die fertigen Abruflinks. Superuser sehen den Token auch direkt in der Benutzerverwaltung beim Benutzer, Feld API-Token (Auge-Symbol zum Einblenden).

Token erneuern: In der Benutzerverwaltung über das Pfeil-Symbol neben dem Token oder auf der Seite Daten-API über Neu generieren. Der alte Token ist danach sofort ungültig. Das externe Tool braucht dann den neuen Link.

Zugang beenden: Benutzer in der Benutzerverwaltung deaktivieren oder löschen. Der Token funktioniert danach nicht mehr.

---

Transaktions-Schritt 2: Der Aufruf

https://<Systemdomain>/api/<ACCESS-TOKEN>/admin/<BENUTZER-ID>/get-orders.<FORMAT>

Teil Inhalt <Systemdomain> Domain Ihres Systems, die Sie auch für den Login nutzen <ACCESS-TOKEN> API-Token des Benutzers aus Schritt 1 <BENUTZER-ID> ID dieses Benutzers <FORMAT> csv, json oder xml

Am einfachsten kopieren Sie den Link fertig von API Filterung→ Daten-API, Zeile Transaktionen. Token und Benutzer-ID sind dort schon eingesetzt.

Beispiel: alle bestätigten und ausgezahlten Transaktionen aus Januar 2026 als JSON

https://<Systemdomain>/api/<ACCESS-TOKEN>/admin/<BENUTZER-ID>/get-orders.json?condition[l:status]=confirmed,paid&condition[period][from]=01.01.2026&condition[period][to]=31.01.2026&condition[datemode]=incoming

Mit curl:

curl -g "https://<Systemdomain>/api/<ACCESS-TOKEN>/admin/<BENUTZER-ID>/get-orders.csv?condition[period][from]=01.01.2026&condition[period][to]=31.01.2026" -o transaktionen.csv

-g ist nötig, damit curl die eckigen Klammern nicht selbst auswertet.

Antworten

Code Bedeutung 200 Daten kommen im gewählten Format. 401 Token oder Benutzer-ID passen nicht zusammen, oder der Token wurde erneuert. 404 Die Adresse stimmt nicht, meist ein Tippfehler im Pfad oder Format.

---

Schritt 3: Filtern

Alle Filter werden als Parameter an den Link gehängt und mit & verbunden.

Zeitraum

Parameter Beispiel Bedeutung condition[period][from] 01.01.2026 Startdatum condition[period][to] 31.01.2026 Enddatum condition[datemode] incoming Worauf sich der Zeitraum bezieht, siehe unten datemode Der Zeitraum gilt für incoming das Transaktionsdatum, also wann die Bestellung erfasst wurde processing das Datum der Bestätigung oder Stornierung payout das Auszahlungsdatum

Für Kostenauswertungen nach Bestelldatum nehmen Sie incoming, für die Transaktionstatsächlich APIausgezahlten könnenProvisionen verschiedeneeines ParameterMonats als Filter verwendet werden.
Nachfolgend eine Übersicht aller verfügbaren Parameter:payout.

Transaktions

Status

Parameter	Wert	Beispiel

BeschreibungLiefert condition[l:status] open condition[l:status]=openoffene Alle Transaktionen, welche als “Offen” im System hinterlegt sindTransaktionen
confirmed condition[l:status]=confirmedbestätigte Alle Transaktionen, welche als “Bestätigt” im System hinterlegt sindTransaktionen
paid condition[l:status]=paidausgezahlte Alle Transaktionen, welche als “Ausgezahlt” im System hinterlegt sindTransaktionen
canceled condition[l:status]=canceledstornierte Alle Transaktionen, welche als “Storniert” im System hinterlegt sindTransaktionen

Hinweis: Es ist eine Kombination aus mehrerenMehrere Status möglich.mit ZumKomma Beispiel:trennen: condition[l:status]=confirmed,paid

Kampagne

Parameter	Wert / Beispiel	BeschreibungBedeutung

condition[period][from] 01.01.2025 Definiert das Startdatum des Zeitraums condition[period][to] 31.01.2025 Definiert das Enddatum des Zeitraums condition[l:campaigns] 1 Filtertoder alle Baskets, die einer bestimmten Kampagne zugeordnet sind. Mehrfachnennung möglich. condition[datemode]1,3 processing
payout
incomingnur BestimmtTransaktionen diedieser Art des Zeitraums:
• processing: Baskets, die im Zeitraum validiert wurden
• payout: Baskets, die im Zeitraum ausgezahlt wurden
• incoming: Baskets, die im Zeitraum erfasst wurden (Transaktionsdatum)Kampagnen

Beispiel:

Definition derDie Felder in der Transaktions-API

Die heruntergeladenenDatei Transaktionenenthält (z.B.eine alsZeile .csv)je enthaltenTransaktion. folgendeBeträge Spalten:sind netto, sofern nicht anders angegeben.

Transaktion

FeldnameFeld	BeschreibungInhalt
id	Eindeutige ID der Transaktion in unserem System

ordertoken Ihre Bestellnummer, wie sie beim Tracking übergeben wurde ebestid Verschlüsselte Bestellnummer, wie der Publisher sie sieht type Art der Transaktion, zum Beispiel Sale, Lead oder View status Status0 deroffen, Transaktion1 bestätigt, 2 storniert, 3 ausgezahlt sub_status Ihr eigener Bearbeitungsstatus cancel_reason Stornogrund visibility Sichtbarkeit für den Publisher timestamp Zeitpunkt der Transaktion campaign_idorder_timestamp Kampagne,Zeitpunkt des Bestellaufrufs action_timestamp Zeitpunkt des Klicks oder Views, der zur Bestellung führte status_change_date Datum der letzten Statusänderung last_change Zeitpunkt der letzten Änderung payoutdate Auszahlungsdatum description Beschreibung, die mit der Transaktion zugeordnetübergeben wurde basket_items Anzahl der Artikel im Warenkorb

Umsatz und Provision

Feld Inhalt turnover Provisionsrelevanter Bestellwert turnover_brutto Bestellwert inklusive Steuern source_turnover Bestellwert, wie er ursprünglich übergeben wurde original_turnover Bestellwert in der Währung der Bestellung attributed_turnover Anteiliger Bestellwert, wenn ein Attributionsmodell aktiv ist order_currency Währung der Bestellung commission Provision des Publishers, aktueller Stand nach dem Sales-Abgleich source_commission Provision zum Zeitpunkt der Transaktion, ändert sich nicht attribution Betrag der gezahlten Attribution delivered_tagcode_count Anzahl der ausgeführten Tags delivered_tagcode_serversided_url Übermittelter Server-Side-Trackingcall ordertoken Vom Advertiser übermittelte Bestellnummer source Quelle der Transaktion project_id ID des Projekts, dem die Transaktion zugeordnet wurde admedia_id Werbemittel-ID, über die die Transaktion erzeugt wurde type Typ der Transaktion (z.B. Sale, Lead, View) commission Provision, die dem Publisher zugeordnet wurde (wird beim Salesabgleich geupdated)  source_commission Ursprüngliche Provision (wird nicht geupdated) commission_group_id Provisionsgruppe, in der sich der Publisher bei Transaktionserzeugung befand trigger_id Trigger-ID, dieTrigger der Transaktion zugeordnet ist description Beschreibung, die bei der Transaktion übermittelt wurde trigger_value Vergütung, die in der entsprechenden Trigger-ID zum Zeitpunkt der Transaktion hinterlegt war trigger_type Art des Triggers (Fixvergütung oder prozentuale Vergütung) turnover Provisionsrelevanter Bestellwert attributed_turnover Attribuierter Bestellwert (falls Attributionsmodell aktiv) original_turnover Bestellwert in der Advertiser-Währung action_id Action-ID, die bei der Transaktion übermittelt wurde salary_id ID des Auszahlungsvorgangs, in dem die Transaktion abgerechnet wurde session_id Session-ID, die bei der Transaktion übermittelt wurde order_currency Währung der Bestellung status_change_date Datum der letzten Statusänderung cancel_reason Stornogrund, falls die Transaktion storniert wurde source_turnover Vom Advertiser übermittelter Bestellwert last_change Timestamp der letzten Änderung der Transaktion user_agent Clientinformationen des Nutzers, der die Transaktion ausgelöst hat order_actions_id Interner Verweis auf den provisionsrelevanten Klick oder Postview bonus_id ID eines Bonus-Laufs customer_journey_status Interne Kennziffer zur Customer Journey ebestid Gehashte Bestellnummer zur Anzeige für den Publisher order_timestamp Timestamp des Orderaufrufs action_timestamp Timestamp der Action, die zur Order führte trigger_title Name des Triggers payoutdatetrigger_type AuszahlungsdatumFixvergütung oder prozentuale Vergütung trigger_value Vergütung, die zum Zeitpunkt der Transaktion im Trigger hinterlegt war commission_group_id Provisionsgruppe des Publishers zum Zeitpunkt der Transaktion campaign_group_title TitelName dieser Provisionsgruppe salary_id Auszahlung, mit der Provisionsgruppedie Transaktion abgerechnet wurde bonus_id Bonuslauf, falls die Transaktion aus einem Bonus stammt

Publisher, Projekt und Kampagne

Feld Inhalt publisher_id ID des Publishers publisher_prename, publisher_surname Vor- und Nachname des Publishers publisher_searchtitle Suchtitel des Publishers project_id ID des Projekts (Website oder Kanal des Publishers) project_title Name des Projekts,Projekts dem dieTransaktioncampaign_id zugeordnetID wurdeder Kampagne campaign_title Name der Kampagne, die der Transaktion zugeordnet wurdeKampagne advertiser_id ID des Advertisers, dem die Transaktion zugeordnet wurdeAdvertisers advertiser_title Name des Advertisers, dem die Transaktion zugeordnet wurdeAdvertisers publisher_idadmedia_id IDWerbemittel, desüber Publishers, demdas die Transaktion zugeordnetentstand wurde subid Sub-ID, die der Publisher mitgegeben hat

Herkunft und Tracking

Feld Inhalt source Quelle der Transaktion referrer Seite, auf der dergeklickt klickauslösende Vorgang stattfandwurde country Land, in dem die Transaktion erzeugt wurde subid Sub-ID, die bei der Transaktion übermittelt wurde publisher_prename Vorname des Publishers (aus Systemdaten) publisher_surname Nachname des Publishers (aus Systemdaten) publisher_searchtitle Suchtitel des Publishers (aus Systemdaten) basket_items Anzahl der Artikel im Warenkorb sub_status Advertiser-interner Status zur VerwaltungLand der Transaktion visibilityuser_agent SichtbarkeitBrowser fürund denGerät Publisherdes external_sources_entity_id
(Account) Id der externen QuelleKunden external_sources_currency_code
session_id WährungscodeSession-ID, die mit der Transaktion übergeben wurde action_id Action-ID, die mit der Transaktion übergeben wurde order_actions_id Verweis auf den provisionsrelevanten Klick oder View customer_journey_status Kennziffer zur Customer Journey delivered_tagcode_count Anzahl der ausgespielten Tags delivered_tagcode_serversided_url Übermittelter serverseitiger Trackingaufruf

Externe Quellen

Nur gefüllt, wenn Transaktionen aus einem angebundenen Netzwerk oder einer externen Quelle stammen.

Feld Inhalt external_sources_entity_id Konto-ID in der externen Quelle external_sources_currency_rate
external_sources_turnover UmrechnungsrateBestellwert anhandlaut desexterner external_sources_currency_code und der internen WährungQuelle external_sources_turnover
external_sources_currency_code BestellwertWährung ausin der externen Quelle source_project_id
external_sources_currency_rate Publisher/Project-Umrechnungskurs in Ihre Systemwährung source_project_id Publisher- oder Projekt-ID ausin der externen Quelle source_project_title
Publisher/Project-NamePublisher- ausoder Projektname in der externen Quelle turnover_brutto
Bestellwert inkl. Steuern komme ich an die Affiliate-Kosten je Publisher? Bestätigte und ausgezahlte Transaktionen abrufen (condition[l:status]=confirmed,paid) und die Spalte commission je publisher_id oder project_title summieren. Offene Transaktionen können sich im Sales-Abgleich noch ändern.

Brauche ich nur Summen statt einzelner Transaktionen? Dafür ist die Statistik-API da, zum Beispiel get-statistic_publisher oder get-statistic_daily.

Wie oft darf ich abrufen? Einmal pro Stunde oder einmal pro Nacht reicht für fast alle Fälle. Rufen Sie lieber kurze Zeiträume häufiger ab als ein ganzes Jahr auf einmal.

Das Tool bekommt plötzlich 401. Der Token wurde erneuert oder der Benutzer deaktiviert. Neuen Link von der Seite Daten-API holen und im Tool hinterlegen.