EN - Basket API

The Basket API is used to retrieve basket data. For this purpose, the following parameter must be appended to the API call:

API	Parameter

API	Parameter
Basket	get-orders_baskets

Example: https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders_baskets.csv

For the Basket API, there are additional parameters that can be queried. Below is a list of all parameters:

Basket-API Filter

Parameter	Value	Description	Example

Parameter	Value	Description	Example
condition[period][from]	start date	Definition of the start date	condition[period][from]=19.12.1909
condition[period][to]	end date	Definition of the end date	condition[period][to]=19.12.1909
condition[l:campaigns]	Numeric value corresponding to the campaign	All baskets items stored under the corresponding campaign of the program. Multiple entries possible	condition[l:campaigns]=1
condition[datemode]	processing payout incoming	Baskets Items that have been validated within the specified timeframe Baskets that have been paid out within the specified timeframe Baskets that have been recorded within the specified timeframe (transaction date)	condition[datemode]=processing

The column names of the downloaded transactions include the following parameters:

id	Unique ID of the basket item
orderid	Internal ID of the associated transaction
timestamp	timestamp of the transaction
ordertoken	ordernumber of the transaction
trigger_id	Trigger ID associated with the transaction
is_basket	If it is a basket item, true is returned
basket_item_id	Unique ID of the basket item
category	shop category of the basket items
productid	article number
productname	product name
amount	The quantity of purchased products
price	price
original_price	brutto price
status	status of the basket item
total	total price for the basket-item
commission	commission for the specific basket-item
currency_rate	currency_rate
currency	currency
is_attributed	If attributed, true is returned
attribution	attribution per basket item
attributed_price	attributed price per basket item
attributed_total	attributed price per basket item multiplied by the amount
trigger_value	commission amount per basket-item
original_turnover	brutto turnover
price_brutto	brutto turnover per basket-item