GET /inventory

Get Inventory

GET

/inventory

Search current inventory across the position graph.

Traverses the is_in_position graph starting from root_position_key (or
the entire warehouse if omitted) and returns all Inventory edge records
matching the product, serial, and position filters. Includes resolved product
and position codes in each result.

Emits: (direct query — no event class)
Required scope: inventory:inventory:read

Authorizations

OAuth2PasswordBearer

password Flow

Token URL"/api/auth"

Scopes:

• "admin"User can access and edit users and system settings
• "library"User can access and edit products
• "production"User can access and edit production plans
• "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

root_position_key

Traverse the position graph starting from this position key; omit to search the entire warehouse.

Example"IN"

product_key

Filter to inventory slots containing this product.

Example"67890"

product_search

Wildcard search on product code.

Example"PROD-*"

serials_only

If True, return only serialized inventory slots.

Examplefalse

Default

false

serial_search

Wildcard search on serial code.

Example"SN-LR-*"

serial_keys

Filter to inventory slots containing any of these serial keys.

Example"SN-LR-001234"

position_search

Wildcard search on position code.

Example"LOCATION-A*"

position_key

Filter to this specific position.

Example"12345"

owned

Filter by ownership flag; None returns all.

Exampletrue

limit

Maximum number of results.

Example200

Default

200

offset

Pagination offset.

Example0

Default

0

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"_key": "inv-edge-001",

  

  

"product_code": "PROD-001",

  

  

"product_description": "Steel bracket M6",

  

  

"position_code": "LOCATION-A1-01",

  

  

"path": [

  

  

  

{

  

  

  

  

"position_key": "12345",

  

  

  

  

"position_code": "WAREHOUSE-A"

  

  

  

}

  

  

],

  

  

"serial_code": "SN-LR-001234",

  

  

"serial_key": "SN-LR-001234",

  

  

"product_key": "67890",

  

  

"position_key": "12345",

  

  

"quantity": 42.5,

  

  

"owned": true,

  

  

"value": 1062.5,

  

  

"reference": "WO-2026-001",

  

  

"extra": "string"

  

}

]

Samples

Powered by VitePress OpenAPI