# Basket API Documentation

The Basket API is used for exporting and analyzing shopping cart data recorded via the partner program system. It allows you to retrieve detailed information on individual basket items in a structured CSV format for further processing.

The API can be accessed within the user interface under the **Data API** menu item.

---

### API Call

`https://<strong>www.domain.de</strong>/api//<strong>ACCESS-TOKEN</strong>/admin/<strong>ID</strong>/get-orders_baskets<strong>.csv</strong>`

<table data-path-to-node="7" id="bkmrk-value-description-ww"><thead><tr><td>**Value**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="7,1,0,0">**www.domain.de**</span></td><td><span data-path-to-node="7,1,1,0">Partner program system domain</span></td></tr><tr><td><span data-path-to-node="7,2,0,0">**ACCESS-TOKEN**</span></td><td><span data-path-to-node="7,2,1,0">User's Access Token</span></td></tr><tr><td><span data-path-to-node="7,3,0,0">**ID**</span></td><td><span data-path-to-node="7,3,1,0">User ID</span></td></tr><tr><td><span data-path-to-node="7,4,0,0">**.csv**</span></td><td><span data-path-to-node="7,4,1,0">Download file format</span></td></tr></tbody></table>

---

### Basket API Filtering

Various parameters can be used as filters for the Basket API. Below is an overview of all available parameters:

<table data-path-to-node="11" id="bkmrk-parameter-value-%2F-ex"><thead><tr><td>**Parameter**</td><td>**Value / Example**</td><td>**Description**</td></tr></thead><tbody><tr><td><span data-path-to-node="11,1,0,0">`condition[period][from]`</span></td><td><span data-path-to-node="11,1,1,0">01.01.2025</span></td><td><span data-path-to-node="11,1,2,0">Defines the **start date** of the time period</span></td></tr><tr><td><span data-path-to-node="11,2,0,0">`condition[period][to]`</span></td><td><span data-path-to-node="11,2,1,0">31.01.2025</span></td><td><span data-path-to-node="11,2,2,0">Defines the **end date** of the time period</span></td></tr><tr><td><span data-path-to-node="11,3,0,0">`condition[l:campaigns]`</span></td><td><span data-path-to-node="11,3,1,0">1</span></td><td><span data-path-to-node="11,3,2,0">Filters all baskets assigned to a specific campaign. Multiple values allowed.</span></td></tr><tr><td><span data-path-to-node="11,4,0,0">`condition[datemode]`</span></td><td>processing

  
payout

  
incoming

</td><td>Determines the type of date period:

  
• **processing**: Baskets validated within the period

  
• **payout**: Baskets paid out within the period

  
• **incoming**: Baskets recorded within the period (transaction date)

</td></tr></tbody></table>

**Example:**

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

---

### Field Definitions in the Basket API

The downloaded transactions (e.g., as a `.csv` file) contain the following columns:

<table data-path-to-node="16" id="bkmrk-field-name-descripti"><thead><tr><td>**Field Name**</td><td>**Description**</td></tr></thead><tbody><tr><td>`<span data-path-to-node="16,1,0,0"><strong data-index-in-node="0" data-path-to-node="16,1,0,0">id</strong></span>`</td><td><span data-path-to-node="16,1,1,0">Unique ID of the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,2,0,0"><strong data-index-in-node="0" data-path-to-node="16,2,0,0">orderid</strong></span>`</td><td><span data-path-to-node="16,2,1,0">Internal ID of the associated transaction</span></td></tr><tr><td>`<span data-path-to-node="16,3,0,0"><strong data-index-in-node="0" data-path-to-node="16,3,0,0">timestamp</strong></span>`</td><td><span data-path-to-node="16,3,1,0">Timestamp of the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,4,0,0"><strong data-index-in-node="0" data-path-to-node="16,4,0,0">ordertoken</strong></span>`</td><td><span data-path-to-node="16,4,1,0">Order number of the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,5,0,0"><strong data-index-in-node="0" data-path-to-node="16,5,0,0">trigger_id</strong></span>`</td><td><span data-path-to-node="16,5,1,0">ID of the trigger assigned to the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,6,0,0"><strong data-index-in-node="0" data-path-to-node="16,6,0,0">is_basket</strong></span>`</td><td><span data-path-to-node="16,6,1,0">Indicates if it is a basket item (`true` / `false`)</span></td></tr><tr><td>`<span data-path-to-node="16,7,0,0"><strong data-index-in-node="0" data-path-to-node="16,7,0,0">basket_item_id</strong></span>`</td><td><span data-path-to-node="16,7,1,0">Unique ID of the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,8,0,0"><strong data-index-in-node="0" data-path-to-node="16,8,0,0">category</strong></span>`</td><td><span data-path-to-node="16,8,1,0">Category provided by the shop</span></td></tr><tr><td>`<span data-path-to-node="16,9,0,0"><strong data-index-in-node="0" data-path-to-node="16,9,0,0">productid</strong></span>`</td><td><span data-path-to-node="16,9,1,0">Product ID in the shop</span></td></tr><tr><td>`<span data-path-to-node="16,10,0,0"><strong data-index-in-node="0" data-path-to-node="16,10,0,0">productname</strong></span>`</td><td><span data-path-to-node="16,10,1,0">Name of the product in the shop</span></td></tr><tr><td>`<span data-path-to-node="16,11,0,0"><strong data-index-in-node="0" data-path-to-node="16,11,0,0">amount</strong></span>`</td><td><span data-path-to-node="16,11,1,0">Number of products purchased</span></td></tr><tr><td>`<span data-path-to-node="16,12,0,0"><strong data-index-in-node="0" data-path-to-node="16,12,0,0">price</strong></span>`</td><td><span data-path-to-node="16,12,1,0">Unit price of the product</span></td></tr><tr><td>`<span data-path-to-node="16,13,0,0"><strong data-index-in-node="0" data-path-to-node="16,13,0,0">original_price</strong></span>`</td><td><span data-path-to-node="16,13,1,0">Original unit price before changes</span></td></tr><tr><td>`<span data-path-to-node="16,14,0,0"><strong data-index-in-node="0" data-path-to-node="16,14,0,0">status</strong></span>`</td><td><span data-path-to-node="16,14,1,0">Status of the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,15,0,0"><strong data-index-in-node="0" data-path-to-node="16,15,0,0">total</strong></span>`</td><td><span data-path-to-node="16,15,1,0">Total price (Quantity × Price)</span></td></tr><tr><td>`<span data-path-to-node="16,16,0,0"><strong data-index-in-node="0" data-path-to-node="16,16,0,0">commission</strong></span>`</td><td><span data-path-to-node="16,16,1,0">Commission the publisher receives for the basket item</span></td></tr><tr><td>`<span data-path-to-node="16,17,0,0"><strong data-index-in-node="0" data-path-to-node="16,17,0,0">currency_rate</strong></span>`</td><td><span data-path-to-node="16,17,1,0">Conversion rate for foreign currencies</span></td></tr><tr><td>`<span data-path-to-node="16,18,0,0"><strong data-index-in-node="0" data-path-to-node="16,18,0,0">currency</strong></span>`</td><td><span data-path-to-node="16,18,1,0">Currency of the transaction</span></td></tr><tr><td>`<span data-path-to-node="16,19,0,0"><strong data-index-in-node="0" data-path-to-node="16,19,0,0">is_attributed</strong></span>`</td><td><span data-path-to-node="16,19,1,0">Indicates whether attribution applies (`true` / `false`)</span></td></tr><tr><td>`<span data-path-to-node="16,20,0,0"><strong data-index-in-node="0" data-path-to-node="16,20,0,0">attribution</strong></span>`</td><td><span data-path-to-node="16,20,1,0">Type of attribution per basket item</span></td></tr><tr><td>`<span data-path-to-node="16,21,0,0"><strong data-index-in-node="0" data-path-to-node="16,21,0,0">attributed_price</strong></span>`</td><td><span data-path-to-node="16,21,1,0">Attributed price per basket item</span></td></tr><tr><td>`<span data-path-to-node="16,22,0,0"><strong data-index-in-node="0" data-path-to-node="16,22,0,0">attributed_total</strong></span>`</td><td><span data-path-to-node="16,22,1,0">Attributed price × Quantity</span></td></tr><tr><td>`<span data-path-to-node="16,23,0,0"><strong data-index-in-node="0" data-path-to-node="16,23,0,0">trigger_value</strong></span>`</td><td><span data-path-to-node="16,23,1,0">Commission amount per basket item</span></td></tr><tr><td>`<span data-path-to-node="16,24,0,0"><strong data-index-in-node="0" data-path-to-node="16,24,0,0">original_turnover</strong></span>`</td><td><span data-path-to-node="16,24,1,0">Tracked revenue</span></td></tr><tr><td>`<span data-path-to-node="16,25,0,0"><strong data-index-in-node="0" data-path-to-node="16,25,0,0">price_brutto</strong></span>`</td><td><span data-path-to-node="16,25,1,0">Gross price of the basket item</span></td></tr></tbody></table>