Skip to content

GET /position-hierarchy

Get Position Hierarchy

GET
/position-hierarchy

Return the full position tree rooted at a given position.

Traverses the is_in_position edge collection recursively (up to 15 levels)
and assembles a nested hierarchy of positions sorted alphabetically by code at
each level. Pass position_key=IN to retrieve the entire warehouse tree.

Emits: (direct query — no event class)
Required scope: inventory:position: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

position_key

Responses

Successful Response

application/json
JSON
[
]

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.