2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-07-04 12:40:57 +00:00
Files
InvenTree/docs/docs/api/schema.md
Tuan (Tristan) Le 786b52d016 Report merge (#9532)
* Report merge

* Remove auto-generated file

* Remove pre-commit file

* Revert "Remove pre-commit file"

This reverts commit 00d80bae2a.

* Update API version

* Reduced duplicated logic

* reset pre-commit config

* Added migration files

* Added unit test

* Removed redundant migration

* Updated migration file

* Added a default report template with merge enabled

* Unit test to ensure a single page is generated

* Added docs to support merge feature

* Clean up

* Clean up

* Fixed unresolved link

* Updated API version

* Fixed test report path issue

* Add plugin context for each instance

* merge in master

* Fixed formating

* Added more detailed user guide

* Updated docs

* Added assert to ensure test html output exists

* Updated docs

* Fixed report test path

---------

Co-authored-by: Matthias Mair <code@mjmair.com>
2025-06-20 14:06:28 +10:00

1.9 KiB

title
title
InvenTree API Schema

The InvenTree API is implemented using the Django REST framework. The API schema as documented below is generated using the drf-spectactular extension.

API Version

This documentation is for API version: 352

!!! tip "API Schema History" We track API schema changes, and provide a snapshot of each API schema version in the API schema repository.

API Schema File

The API schema file is available for download, and can be used for generating client libraries, or for testing API endpoints.

API Schema Documentation

API schema documentation is split into the following categories:

Category Description
Authorization and Authentication Authorization and Authentication
Background Task Management Background Task Management
Barcode Scanning Barcode Scanning
Bill of Materials Bill of Materials
Build Order Management Build Order Management
Company Management Company Management
Label Printing Label Printing
External Machine Management External Machine Management
External Order Management External Order Management
Parts and Part Categories Parts and Part Categories
Plugin Functionality Plugin Functionality
Report Generation Report Generation
Settings Management Settings Management
Stock and Stock Locations Stock and Stock Locations
User Management User Management
General General API endpoints