Files
InvenTree/docs/docs/api/schema.md
T
74d9ab6d11 Transfer Order (#11281)
* initial skel commit for transfer orders

* initial transfer order backend model

* add some serializers, rename PLACED to ISSUED for TransferOrders

* adding from admin console works

* simple table list almost working, but we need to add order line items....

* add other cols to table

* add Transfer Order from table view

* moving towards a detail view

* wip: adding detail view

* add take from and destination serializer details

* add other detail grid items

* edit/duplicate transfer order

* more action buttons

* first crack at adding line items

* add to line item

* add filters

* starting work on row actions

* more action buttons for line items

* fix copy lines in duplicate

* basic allocation works

* allocations table actions

* allocate serials

* allocated serial row expansion

* add transferred qty to serializers

* move items on complete, show in tracking

* change panel to transferred stock upon complete

* allow incomplete line items

* disable edit allocations when completed

* add ref pattern and to settings

* add admin to line item inline

* add calendar and parametric view

* basic transfer order report

* add transfer order ruleset

* starting allocation buisness logic throughout for TOs

* disable accept incomplete logic, which was incorrect, until I fix

* fix incomplete allocation option

* add transferred col to default report

* add transfer order to calendar ics view

* chain condition for readability

* add transfer order allocations table to stockitem view

* don't account TO allocations in availability

* add transfer orders table for a part

* 'consume' option by doing take_stock

* squash migrations

* starting to test transfer order

* more transfer order tests

* add transfer order consume test

* wip, more tests

* more transfer order tests

* had to refresh_from_db

* switch "to" to "transfer-order" in url paths

* only select non-virtual parts from transfer order

* add transfer order docs

* deconflict migrations

* fix frontend build error

* fix validation on transfer order reference pattern

* add oath2 scope for transfer order

* fix state test to include transfer order state

* add barcode_model_type_code for transfer order

* bump api version

* check view role for transfer order, remove debug/commented out lines

* add serialized allocation test

* Fix migrations

* Frontend fixes

* Implement required 'company' attribute

* transfer order report context

* attempt to fix tests

* delete transfer order allocations on cancel

* add a few playwright tests, more incoming

* more playwright

* add source and destination locations to table

* deconflict migrations

* Fix build issue

* attempt to fix flaky transfer order test

* duplicate transfer order before running tests

* Adjust playwright tests

* Fix migration dependency order

---------

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>
Co-authored-by: Matthias Mair <code@mjmair.com>
2026-05-22 17:08:40 +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: 459

!!! 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