Admin API

Owned by Christian Goerke
Last updated: Aug 20, 2023
1 min read

General information

Through the API, all available data within the system can be downloaded and processed. The API provides various parameters that need to be specified in order to access the relevant data.

Possible parameter to filter the data

Filtering is applied through specific parameters to get only the necessary data.

An example API call looks as follows:

https://www.domain.de/api//ACCESS-TOKEN/admin/ID/get-orders.csv?condition[period][from]=01.01.2023&condition[period][to]=01.01.2023&condition[paymentstatus]=all

To access information via the API, you need to replace the domain, access token, and ID in the link mentioned above with the correct data. If a .csv format is not desired, you will also need to replace the file format. The .csv format is recommended.

available file formats

File format

Parameter

File format

Parameter

CSV file format - comma-separated

.csv

JSON file format - JavaScript Object Notation

.json

XLS file format - standard file format Microsoft Excel

.xls

XML file format - file format Microsoft Excel

.xml

API in admin interface

The frontend provides access to the APIs as well. Once you are logged in, you can locate them by navigating to the “API” tab and selecting “Data-API”. This section contains a comprehensive list of all available APIs.