Basket API – Dokumentation

Die Basket API dient dem Export und der Analyse von Warenkorb-Daten, die über das Partnerprogramm-System erfasst wurden. Sie ermöglicht es, detaillierte Informationen zu einzelnen Basket-Items strukturiert als CSV-Datei abzurufen und weiterzuverarbeiten.

Die API kann 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:

Definition der Felder in der Basket-API

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

Feldname	Beschreibung
`id`	Einzigartige ID der Transaktion.
`timestamp`	Zeitpunkt der Transaktion.
`trigger_type`	Art des Triggers (Fixvergütung, prozentuale Vergütung).
`ebestid`	Die vollständig gehashte Bestellnummer.
`coatoken`	Teilweise gehashte Bestellnummer. Wird genutzt, wenn bspw. eine Transaktion
`ordertoken`	Die Bestellnummer der Transaktion
`trigger_id`	Trigger ID, welche der Transaktion zugeordnet wird.
`is_basket`	Gibt an, ob es sich um ein Basket-Item handelt (`true` / `false`)
`basket_item`	Eindeutige ID des Basket-Items
`category`	Übergebene Kategorie des Shops
`productid`	Die ID des Produkts aus dem Shop.
`productname`	Der Name des Produkts aus dem Shop.
`amount`	Die Anzahl der gekauften Produkte im Shop.
`price`	Der Stückpreis des Produkts.
`original_price`	Der ursprüngliche Stückpreis eines Produkts, bevor Änderungen vorgenommen wurden.
`status`	Der Status des Artikels.
`total`	Der Gesamtpreis für die entsprechende Anzahl der Artikel.
`commission`	Provision, für das Basket-Item
`commission_rate`	Provisionsrate, für das Basket-Item
`attribution`	Die Attribution pro Warenkorbitem.
`currency`	Die Währung des Shops.
`attributed_total`	Attribuierter Preis × Anzahl
`trigger_value`	Provisionshöhe pro Basket-Item
`original_turnover`	Getrackter Umsatz
`price_brutto`	Brutto-Preis des Basket-Items