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://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders_baskets.csv
| Value | Description |
| www.domain.de | Partner program system domain |
| ACCESS-TOKEN | User's Access Token |
| ID | User ID |
| .csv | Download file format |
Basket API Filtering
Various parameters can be used as filters for the Basket API. Below is an overview of all available parameters:
| Parameter | Value / Example | Description |
condition[period][from] |
01.01.2025 | Defines the start date of the time period |
condition[period][to] |
31.01.2025 | Defines the end date of the time period |
condition[l:campaigns] |
1 | Filters all baskets assigned to a specific campaign. Multiple values allowed. |
condition[datemode] |
processing payout incoming |
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) |
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:
| Field Name | Description |
| id | Unique ID of the basket item |
| orderid | Internal ID of the associated transaction |
| timestamp | Timestamp of the transaction |
| ordertoken | Order number of the transaction |
| trigger_id | ID of the trigger assigned to the transaction |
| is_basket | Indicates if it is a basket item (true / false) |
| basket_item_id | Unique ID of the basket item |
| category | Category provided by the shop |
| productid | Product ID in the shop |
| productname | Name of the product in the shop |
| amount | Number of products purchased |
| price | Unit price of the product |
| original_price | Original unit price before changes |
| status | Status of the basket item |
| total | Total price (Quantity × Price) |
| commission | Commission the publisher receives for the basket item |
| currency_rate | Conversion rate for foreign currencies |
| currency | Currency of the transaction |
| is_attributed | Indicates whether attribution applies (true / false) |
| attribution | Type of attribution per basket item |
| attributed_price | Attributed price per basket item |
| attributed_total | Attributed price × Quantity |
| trigger_value | Commission amount per basket item |
| original_turnover | Tracked revenue |
| price_brutto | Gross price of the basket item |