2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-28 19:46:46 +00:00
InvenTree/docs/docs/api/download.md
Oliver 2ffd2354eb
Documentation integration (#4653)
* Add documentation under docs/ directory

* Add CI workflow for mkdocs configuration checking

* Add documentation issue template

* update pip-tools?

* Update .gitignore files

* Fix .gitignore rules

* Improve release notes page

* remove references to old repo
2023-04-22 22:40:29 +10:00

676 B

title
title
Data Download

Data Download

Some API endpoints provide a download function, whereby the data presented at the API endpoint can be downloaded as a tabulated file.

To export API data to a file, add the &export=<format> modifier to the query. The following file formats are supported:

File Format Modifier
csv &format=csv
tsv &format=tsv
xls &format=xls
xlsx &format=xlsx

Query Filters

Any other query filters used in the API request are also observed when downloading the data. For example, to download a list of all stock items in a given location:

<host>/api/stock/?format=csv&location=10