mirror of
https://github.com/inventree/InvenTree.git
synced 2026-11-18 06:04:44 +00:00
* update descriptions * add subsections * another section * keep nultin seperate * rename * make readme easier to copy * add a seperate overview section like machines * update generated schema page * add missing key * make initial paragraph more objective * add model doc stump * fix typos * fix caps * adjust readme for easier copy paste * update generate step * remove additional doc item
2.1 KiB
2.1 KiB
title
| title |
|---|
| InvenTree API Schema |
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: 579
!!! 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 |
| Data Importing | Data Importing |
| 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 |
| Part and Stock Pricing | Part and Stock Pricing |
| Report Generation | Report Generation |
| Settings Management | Settings Management |
| Stock and Stock Locations | Stock and Stock Locations |
| User Management | User Management |
| General | General API endpoints |