Die Transaktions API wird zum Aufruf der Transaktionen genutzt. Hierfür muss folgender Parameter an den API-Aufruf angehangen werden:
API | Parameter |
|---|---|
Transaktionen | get-orders |
Beispiel: https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv
Für die Transaktions API gibt es zusätzliche Parameter, die abgefragt werden können. Nachfolgend eine Aufstellung aller Parameter:
Transaktionsstatus
Parameter | Wert | Beschreibung | Beispiel |
|---|---|---|---|
condition[l:status] | open | Alle Transaktionen, welche als “Offen” im System hinterlegt sind | condition[I:status]=open |
| confirmed | Alle Transaktionen, welche als “Bestätigt” im System hinterlegt sind. | condition[I:status]=confirmed |
| paid | Alle Transaktionen, welche als “Ausgezahlt” im System hinterlegt sind. | condition[I:status]=paid |
| canceled | Alle Transaktionen, welche als “Storniert” im System hinterlegt sind. | condition[I:status]=canceled |
Info: Es ist eine Kombination aus mehreren Status möglich. Zum Beispiel: condition[l:status]=confirmed,paid
Weitere Transaktions-API Filter
Parameter | Wert | Beschreibung | Beispiel |
|---|---|---|---|
condition[l:publisher] | Zahlenwert, entsprechend des Projekts | Alle Transaktionen, welche dem entsprechenden Publisher zugeordnet sind. | condition[l:publisher]=1001 |
condition[l:mandant] | Zahlenwert, entsprechend des Mandanten | Alle Transaktionen, welche dem entsprechenden Mandanten zugeordnet sind. | condition[l:mandant]=1 |
condition[l:advertiser] | Zahlenwert, entsprechend der Advertiser-ID | Alle Transaktionen, welche dem entsprechenden Advertiser zugeordnet sind. | condition[l:advertiser]=1 |
condition[l:projects] | Zahlenwert, entsprechend des Projekts | Alle Transaktionen, welche unter der entsprechenden Projekt-ID des Programms hinterlegt sind. | condition[l:projects]=50001 |
condition[l:campaigns] | Zahlenwert, entsprechend der Kampagne | Alle Transaktionen, welche unter der entsprechenden Kampagne des Programms hinterlegt sind. | condition[l:campaigns]=1 |
[datemode] | incoming = Erstellungsdatum processing = Bearbeitungsdatum payout = Auszahlungsdatum | Alle Transaktionen, welche in einem bestimmten Zeitraum erstellt/ bearbeitet/ ausgezahlt worden sind. | [datemode]=processing |
Definition der Felder in der Transaktions-API
Die Spaltennamen der heruntergeladenen Transaktionen beinhalten folgende Parameter:
id | Einzigartige ID der Transaktion. |
status | Status der Transaktion. |
timestamp | Zeitpunkt der Transaktion. |
campaign_id | Kampagne, welcher der Transaktion zugeordnet wurde. |
attribution | Betrag der gezahlten Attribution. |
delivered_tagcode_count | Anzahl der ausgeführten Tags. |
delivered_tagcode_serversided_url | Übermittelter Serversided Trackingcall. |
ordertoken | Vom Advertiser übermittelte Bestellnummer. |
source | Quelle der Transaktion. |
project_id | Projekt ID, welche die Transaktion zugeordnet wurde. |
admedia_id | Werbemittel-ID über die die Transaktion erzeugt wurde. |
type | Der Typ der Transaktion wie zum Beispiel Sale oder View. |
commission | Provision, welche dem Publisher zugeordnet wurde. |
commission_group_id | Provisionsgruppe, in der sich der Publisher befand, als Transaktion erzeugt wurde. |
trigger_id | Trigger ID, welche der Transaktion zugeordnet wird. |
description | Beschreibung, welche bei der Transaktion übermittelt wurde. |
trigger_value | Die Vergütung, welche in der entsprechenden Trigger ID zum Zeitpunkt der Transaktion hinterlegt war. |
trigger_type | Art des Triggers (Fixvergütung, prozentuale Vergütung). |
turnover | Provisionsrelevanter Bestellwert |
original_turnover | Bestellwert in der Advertiser-Währung |
action_id | Action ID, welche bei der Transaktion übermittelt wurde. |
salary_id | ID des Auszahlungsvorgangs, in welchem die Transaktion abgerechnet wurde |
session_id | Session ID, welche bei der Transaktion übermittel wurde. |
order_currency | Währung der Bestellung. |
status_change_date | Bei späteren Änderungen der Transaktion wird dieser Wert an das entsprechende Datum angepasst. |
cancel_reason | Wenn die Transaktions storniert wurde, wird hier der Stornogrund hinterlegt. |
source_turnover | Vom Advertiser übermittelter Bestellwert. |
last_change | Timestamp der letzten Transaktionsänderung. |
user_agent | Clientinformation des Nutzers, welcher die Transaktion erzeugt hat. |
order_actions_id | Interner Verweis auf den provisionsrelevaten Klick / Postview. |
bonus_id | Die ID eines Bonus-Laufes. |
customer_journey_status | Interne Kennziffer. |
ebestid | Gehashte Bestellnummer zur Anzeige für den Publisher. |
order_timestamp | Timestamp des Orderaufrufs. |
action_timestamp | Timestamp der Action, welche zur Order führte. |
trigger_title | Name des Trägers. |
payoutdate | Auszahlungsdatum. |
campaign_group_title | Titel der Provisionsgruppe. |
project_title | Name des Projekts, welchem die Transaktion zugeschrieben wurde. |
campaign_title | Name der Kampagne, die der Transaktion zugeordnet wird. |
advertiser_id | Die ID des Advertisers, welchem die Transaktion zugeordnet wird. |
publisher_id | Die ID des Publishers, welchem die Transaktion zu |
referrer | Die Seite au der der Klick erzeugt wurde, der später zur Transaktion geführt hat. |
country | Land in der die Transaktion erzeugt wurde. |
subid | Subid, welche bei der Transaktion übermittel wurde. |
publisher_prename | Vorname des Publishers. Wird anhand der Publisher ID aus dem System gezogen. |
publisher_surname | Nachname des Publishers. Wird anhand der Publisher ID aus dem System gezogen. |
publisher_searchtitle | Suchtitel des Publihsers. Wird anhand der Publisher ID aus dem System gezogen. |
basket_items | Anzahl der Artikel im Warenkorb. |
sub_status | Advertiser-Interner Status zur Verwaltung der Transaktion. |
visibility | Sichtbarkeit für den Publisher. |