GET /position

Get Positions

GET

/position

Search inventory positions.

Returns all positions matching the given search filters. Positions are nodes
in the warehouse location graph (stored in the Position collection); results
exclude logically deleted positions unless search matches their code.

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

search

Wildcard search against position code.

Example"WAREHOUSE-A*"

position_keys

Filter to positions with these specific keys.

Example"12345""67890"

has_product_key

Return only positions that currently contain at least one unit of these products.

Example"product/67890"

has_product_code

Return only positions containing products whose code matches any of the given values.

Example"PROD-001"

is_in_position

Filter to positions that are children of this position key in the hierarchy.

Example"IN"

contains_position

Filter to positions that contain this child position key.

Example"12345"

fixed_only

If True, return only fixed (non-mobile) positions.

Examplefalse

Default

false

limit

Maximum number of results to return.

Example200

Default

200

offset

Number of results to skip for pagination.

Example0

Default

0

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"_id": "string",

  

  

"_key": "string",

  

  

"_rev": "string",

  

  

"code": "WAREHOUSE-A",

  

  

"owned": true,

  

  

"available": true,

  

  

"disposable": false,

  

  

"fixed": true,

  

  

"deleted": false,

  

  

"created": "2026-05-15T10:00:00Z",

  

  

"allow_consumption": true,

  

  

"extra": "string"

  

}

]

Samples

Powered by VitePress OpenAPI