Skip to main content

Basket API – Dokumentation

Die Basket API wird zum Abruf von Baskets genutzt.

Alle APIs können im User-Interface unter dem Menüpunkt Daten-API verwendet werden.

API-Aufruf

https://www.domain.de/api//ACCESS-TOKEN/publisher/ID/get-orders_baskets.csv
Wert Beschreibung
www.domain.de System-Partnerprogramm
ACCESS-TOKEN Access Token des Users
ID User-ID
.csv Art des Downloads

Basket-API Filterung

Für die Basket API können verschiedene Parameter als Filter verwendet werden.
Nachfolgend eine Übersicht aller verfügbaren Parameter:

Parameter Wert / Beispiel Beschreibung
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 Filtert alle Baskets, die einer bestimmten Kampagne zugeordnet sind. Mehrfachnennung möglich.
condition[datemode] processing
payout
incoming		 Bestimmt die 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)

Beispiel:

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

Definition der Felder in der Basket-API

Die heruntergeladenen Transaktionen (z.B. als .csv) enthalten folgende Spalten:

Feldname Beschreibung

id

 Eindeutige

Einzigartige ID desder Basket-ItemsTransaktion.

orderidtimestamp

 Interne ID

Zeitpunkt der zugehörigenTransaktion.

Transaktion

timestamptrigger_type

 Zeitpunkt der

Art Transaktiondes Triggers (Fixvergütung, prozentuale Vergütung).

ordertokenebestid

 Bestellnummer der

Die Transaktionvollständig gehashte Bestellnummer.

coatoken

Teilweise gehashte Bestellnummer. Wird genutzt, wenn bspw. eine Transaktion

ordertoken

Die Bestellnummer der Transaktion

trigger_id

ID des

Trigger Triggers,ID, derwelche der Transaktion zugeordnet istwird.

is_basket

Gibt an, ob es sich um ein Basket-Item handelt (true / false)

basket_item_idbasket_item

Eindeutige ID des Basket-Items

category

Übergebene Kategorie des Shops

productid

Die ID des Produkts imaus Shopdem Shop.

productname

Der Name des Produkts imaus Shopdem Shop.

amount

Die Anzahl der gekauften Produkte im Shop.

price

Der Stückpreis des ProduktsProdukts.

original_price

Ursprünglicher

Der ursprüngliche Stückpreis voreines Produkts, bevor Änderungen vorgenommen wurden.

status

Der Status des Basket-ItemsArtikels.

total

Der Gesamtpreis (für die entsprechende Anzahl ×der Preis)Artikel.

commission

Provision, die der Publisher für das Basket-Item

erhält

currency_ratecommission_rate

Umrechnungsrate bei

Provisionsrate, Fremdwährungfür das Basket-Item

currencyattribution

Währung der

Die TransaktionAttribution pro Warenkorbitem.

is_attributedcurrency

Gibt an,

Die obWährung einedes AttributionShops.

vorliegt (true / false) attribution Art der Attribution pro Basket-Item attributed_price Attribuierter Preis pro Basket-Item attributed_total Attribuierter Preis × Anzahl trigger_value Provisionshöhe pro Basket-Item original_turnover Getrackter Umsatz price_brutto Brutto-Preis des Basket-Items