# 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

<div class="contain-inline-size rounded-2xl relative bg-token-sidebar-surface-primary" id="bkmrk-https%3A%2F%2Fwww.domain.d"><div class="overflow-y-auto p-4" dir="ltr">https://**www.<span class="hljs-keyword">domain</span>.de**/api//**<span class="hljs-keyword">ACCESS</span>-TOKEN**/<span class="hljs-keyword">admin</span>/**ID**/<span class="hljs-keyword">get</span>-orders_baskets**.csv**</div></div><div class="overflow-y-auto p-4" dir="ltr" id="bkmrk--1"></div><div class="overflow-y-auto p-4" dir="ltr" id="bkmrk-wert-beschreibung-ww"><table class="w-fit min-w-(--thread-content-width)" data-end="1483" data-start="768" style="width: 62.1429%; height: 154.406px;"><thead data-end="814" data-start="768"><tr data-end="814" data-start="768" style="height: 29.7969px;"><th data-col-size="sm" data-end="780" data-start="768" style="width: 41.6309%; height: 29.7969px;">Wert</th><th data-col-size="xl" data-end="814" data-start="798" style="width: 58.3691%; height: 29.7969px;">Beschreibung</th></tr></thead><tbody data-end="1483" data-start="864"><tr data-end="953" data-start="864" style="height: 35.2188px;"><td data-col-size="sm" data-end="892" data-start="864" style="width: 41.6309%; height: 35.2188px;">www.domain.de</td><td data-col-size="xl" data-end="953" data-start="907" style="width: 58.3691%; height: 35.2188px;">System-Partnerprogramm</td></tr><tr style="height: 29.7969px;"><td style="width: 41.6309%; height: 29.7969px;">ACCESS-TOKEN</td><td style="width: 58.3691%; height: 29.7969px;">Access Token des Users</td></tr><tr style="height: 29.7969px;"><td style="width: 41.6309%; height: 29.7969px;">ID</td><td style="width: 58.3691%; height: 29.7969px;">User-ID</td></tr><tr style="height: 29.7969px;"><td style="width: 41.6309%; height: 29.7969px;">.csv</td><td style="width: 58.3691%; height: 29.7969px;">Art des Downloads</td></tr></tbody></table>

</div>---

## Basket-API Filterung

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

<table class="w-fit min-w-(--thread-content-width)" data-end="1483" data-start="768" id="bkmrk-parameter-wert-%2F-bei" style="width: 100%;"><thead data-end="814" data-start="768"><tr data-end="814" data-start="768"><th data-col-size="sm" data-end="780" data-start="768" style="width: 22.5268%;">Parameter</th><th data-col-size="sm" data-end="798" data-start="780" style="width: 12.0373%;">Wert / Beispiel</th><th data-col-size="xl" data-end="814" data-start="798" style="width: 65.4359%;">Beschreibung</th></tr></thead><tbody data-end="1483" data-start="864"><tr data-end="953" data-start="864"><td data-col-size="sm" data-end="892" data-start="864" style="width: 22.5268%;">`condition[period][from]`</td><td data-col-size="sm" data-end="907" data-start="892" style="width: 12.0373%;">`01.01.2025`</td><td data-col-size="xl" data-end="953" data-start="907" style="width: 65.4359%;">Definiert das **Startdatum** des Zeitraums</td></tr><tr data-end="1039" data-start="954"><td data-col-size="sm" data-end="980" data-start="954" style="width: 22.5268%;">`condition[period][to]`</td><td data-col-size="sm" data-end="995" data-start="980" style="width: 12.0373%;">`31.01.2025`</td><td data-col-size="xl" data-end="1039" data-start="995" style="width: 65.4359%;">Definiert das **Enddatum** des Zeitraums</td></tr><tr data-end="1174" data-start="1040"><td data-col-size="sm" data-end="1067" data-start="1040" style="width: 22.5268%;">`condition[l:campaigns]`</td><td data-col-size="sm" data-end="1073" data-start="1067" style="width: 12.0373%;">`1`</td><td data-col-size="xl" data-end="1174" data-start="1073" style="width: 65.4359%;">Filtert alle Baskets, die einer bestimmten **Kampagne** zugeordnet sind. Mehrfachnennung möglich.</td></tr><tr data-end="1483" data-start="1175"><td data-col-size="sm" data-end="1199" data-start="1175" style="width: 22.5268%;">`condition[datemode]`</td><td data-col-size="sm" data-end="1240" data-start="1199" style="width: 12.0373%;">`processing`  
`payout`  
`incoming`</td><td data-col-size="xl" data-end="1483" data-start="1240" style="width: 65.4359%;">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)</td></tr></tbody></table>

<div class="_tableContainer_1rjym_1" id="bkmrk-parameter-wert-%2F-bei-1"><div class="group _tableWrapper_1rjym_13 flex w-fit flex-col-reverse" tabindex="-1">  
</div></div>**Beispiel:**

<div class="group _tableWrapper_1rjym_13 flex w-fit flex-col-reverse" id="bkmrk-condition%5Bperiod%5D%5Bfr" tabindex="-1"><div class="contain-inline-size rounded-2xl relative bg-token-sidebar-surface-primary"><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-keyword">condition</span>[<span class="hljs-keyword">period</span>][<span class="hljs-keyword">from</span>]<span class="hljs-operator">=</span><span class="hljs-number">01.01</span><span class="hljs-number">.2025</span><span class="hljs-operator">&</span><span class="hljs-keyword">condition</span>[<span class="hljs-keyword">period</span>][<span class="hljs-keyword">to</span>]<span class="hljs-operator">=</span><span class="hljs-number">31.01</span><span class="hljs-number">.2025</span><span class="hljs-operator">&</span><span class="hljs-keyword">condition</span>[datemode]<span class="hljs-operator">=</span>processing`</div></div>---

</div>## Definition der Felder in der Basket-API

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

<div class="group _tableWrapper_1rjym_13 flex w-fit flex-col-reverse" id="bkmrk-feldname-beschreibun" tabindex="-1"><div class="_tableContainer_1rjym_1"><div class="group _tableWrapper_1rjym_13 flex w-fit flex-col-reverse" tabindex="-1"><table class="w-fit min-w-(--thread-content-width)" data-end="3132" data-start="1742"><thead data-end="1769" data-start="1742"><tr data-end="1769" data-start="1742"><th data-col-size="sm" data-end="1753" data-start="1742">Feldname</th><th data-col-size="md" data-end="1769" data-start="1753">Beschreibung</th></tr></thead><tbody data-end="3132" data-start="1800"><tr data-end="1841" data-start="1800"><td data-col-size="sm" data-end="1807" data-start="1800">`id`</td><td data-col-size="md" data-end="1841" data-start="1807">Eindeutige ID des Basket-Items</td></tr><tr data-end="1896" data-start="1842"><td data-col-size="sm" data-end="1854" data-start="1842">`orderid`</td><td data-col-size="md" data-end="1896" data-start="1854">Interne ID der zugehörigen Transaktion</td></tr><tr data-end="1940" data-start="1897"><td data-col-size="sm" data-end="1911" data-start="1897">`timestamp`</td><td data-col-size="md" data-end="1940" data-start="1911">Zeitpunkt der Transaktion</td></tr><tr data-end="1989" data-start="1941"><td data-col-size="sm" data-end="1956" data-start="1941">`ordertoken`</td><td data-col-size="md" data-end="1989" data-start="1956">Bestellnummer der Transaktion</td></tr><tr data-end="2060" data-start="1990"><td data-col-size="sm" data-end="2005" data-start="1990">`trigger_id`</td><td data-col-size="md" data-end="2060" data-start="2005">ID des Triggers, der der Transaktion zugeordnet ist</td></tr><tr data-end="2144" data-start="2061"><td data-col-size="sm" data-end="2075" data-start="2061">`is_basket`</td><td data-col-size="md" data-end="2144" data-start="2075">Gibt an, ob es sich um ein Basket-Item handelt (`true` / `false`)</td></tr><tr data-end="2198" data-start="2145"><td data-col-size="sm" data-end="2164" data-start="2145">`basket_item_id`</td><td data-col-size="md" data-end="2198" data-start="2164">Eindeutige ID des Basket-Items</td></tr><tr data-end="2246" data-start="2199"><td data-col-size="sm" data-end="2212" data-start="2199">`category`</td><td data-col-size="md" data-end="2246" data-start="2212">Übergebene Kategorie des Shops</td></tr><tr data-end="2288" data-start="2247"><td data-col-size="sm" data-end="2261" data-start="2247">`productid`</td><td data-col-size="md" data-end="2288" data-start="2261">ID des Produkts im Shop</td></tr><tr data-end="2334" data-start="2289"><td data-col-size="sm" data-end="2305" data-start="2289">`productname`</td><td data-col-size="md" data-end="2334" data-start="2305">Name des Produkts im Shop</td></tr><tr data-end="2379" data-start="2335"><td data-col-size="sm" data-end="2346" data-start="2335">`amount`</td><td data-col-size="md" data-end="2379" data-start="2346">Anzahl der gekauften Produkte</td></tr><tr data-end="2417" data-start="2380"><td data-col-size="sm" data-end="2390" data-start="2380">`price`</td><td data-col-size="md" data-end="2417" data-start="2390">Stückpreis des Produkts</td></tr><tr data-end="2481" data-start="2418"><td data-col-size="sm" data-end="2437" data-start="2418">`original_price`</td><td data-col-size="md" data-end="2481" data-start="2437">Ursprünglicher Stückpreis vor Änderungen</td></tr><tr data-end="2520" data-start="2482"><td data-col-size="sm" data-end="2493" data-start="2482">`status`</td><td data-col-size="md" data-end="2520" data-start="2493">Status des Basket-Items</td></tr><tr data-end="2563" data-start="2521"><td data-col-size="sm" data-end="2531" data-start="2521">`total`</td><td data-col-size="md" data-end="2563" data-start="2531">Gesamtpreis (Anzahl × Preis)</td></tr><tr data-end="2638" data-start="2564"><td data-col-size="sm" data-end="2579" data-start="2564">`commission`</td><td data-col-size="md" data-end="2638" data-start="2579">Provision, die der Publisher für das Basket-Item erhält</td></tr><tr data-end="2693" data-start="2639"><td data-col-size="sm" data-end="2657" data-start="2639">`currency_rate`</td><td data-col-size="md" data-end="2693" data-start="2657">Umrechnungsrate bei Fremdwährung</td></tr><tr data-end="2734" data-start="2694"><td data-col-size="sm" data-end="2707" data-start="2694">`currency`</td><td data-col-size="md" data-end="2734" data-start="2707">Währung der Transaktion</td></tr><tr data-end="2813" data-start="2735"><td data-col-size="sm" data-end="2753" data-start="2735">`is_attributed`</td><td data-col-size="md" data-end="2813" data-start="2753">Gibt an, ob eine Attribution vorliegt (`true` / `false`)</td></tr><tr data-end="2869" data-start="2814"><td data-col-size="sm" data-end="2830" data-start="2814">`attribution`</td><td data-col-size="md" data-end="2869" data-start="2830">Art der Attribution pro Basket-Item</td></tr><tr data-end="2930" data-start="2870"><td data-col-size="sm" data-end="2891" data-start="2870">`attributed_price`</td><td data-col-size="md" data-end="2930" data-start="2891">Attribuierter Preis pro Basket-Item</td></tr><tr data-end="2984" data-start="2931"><td data-col-size="sm" data-end="2952" data-start="2931">`attributed_total`</td><td data-col-size="md" data-end="2984" data-start="2952">Attribuierter Preis × Anzahl</td></tr><tr data-end="3037" data-start="2985"><td data-col-size="sm" data-end="3003" data-start="2985">`trigger_value`</td><td data-col-size="md" data-end="3037" data-start="3003">Provisionshöhe pro Basket-Item</td></tr><tr data-end="3081" data-start="3038"><td data-col-size="sm" data-end="3060" data-start="3038">`original_turnover`</td><td data-col-size="md" data-end="3081" data-start="3060">Getrackter Umsatz</td></tr><tr data-end="3132" data-start="3082"><td data-col-size="sm" data-end="3099" data-start="3082">`price_brutto`</td><td data-col-size="md" data-end="3132" data-start="3099">Brutto-Preis des Basket-Items</td></tr></tbody></table>

</div></div></div>