Basket API – Dokumentation

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

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

API-Aufruf

https://www.domain.de/api//ACCESS-TOKEN/admin/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`	Eindeutige ID des Basket-Items
`orderid`	Interne ID der zugehörigen Transaktion
`timestamp`	Zeitpunkt der Transaktion
`ordertoken`	Bestellnummer der Transaktion
`trigger_id`	ID des Triggers, der der Transaktion zugeordnet ist
`is_basket`	Gibt an, ob es sich um ein Basket-Item handelt (`true` / `false`)
`basket_item_id`	Eindeutige ID des Basket-Items
`category`	Übergebene Kategorie des Shops
`productid`	ID des Produkts im Shop
`productname`	Name des Produkts im Shop
`amount`	Anzahl der gekauften Produkte
`price`	Stückpreis des Produkts
`original_price`	Ursprünglicher Stückpreis vor Änderungen
`status`	Status des Basket-Items
`total`	Gesamtpreis (Anzahl × Preis)
`commission`	Provision, die der Publisher für das Basket-Item erhält
`currency_rate`	Umrechnungsrate bei Fremdwährung
`currency`	Währung der Transaktion
`is_attributed`	Gibt an, ob eine Attribution 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