GET /movement

Search Inventory Journal

GET

/movement

Search the inventory movement journal.

Queries the movement edge collection using the supplied filters (type,
status, date range, product, serial, position, movement list). Returns
enriched results including position codes, product codes, and movement list
codes resolved from related collections.

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

movement_type

Filter by movement type.

Example"transfer"

movement_status

Filter by movement status.

Example"completed"

include_planned

Include movements in planned status.

Exampletrue

Default

true

include_completed

Include movements in completed status.

Exampletrue

Default

true

start_from

Filter movements that started on or after this timestamp.

Example"2026-01-01T00:00:00Z"

start_to

Filter movements that started on or before this timestamp.

Example"2026-12-31T23:59:59Z"

end_from

Filter movements that ended on or after this timestamp.

Example"2026-01-01T00:00:00Z"

end_to

Filter movements that ended on or before this timestamp.

Example"2026-12-31T23:59:59Z"

product_key

Filter by product key.

Example"67890"

product_search

Wildcard search on product code.

Example"PROD-*"

serial_keys

Filter to movements involving any of these serial keys.

Example"SN-LR-001234"

serial_search

Wildcard search on serial code.

Example"SN-LR-*"

list_key

Filter to movements belonging to any of these movement list keys.

Example"mvtlist-001"

list_search

Text search on movement list code.

Example"LIST-2026"

work_order_search

Wildcard search on work order code in references.

Example"WO-2026-*"

position_from

Filter by source position key.

Example"12345"

position_to

Filter by destination position key.

Example"67890"

position_filter_operator

Logical operator for position_from / position_to filter combination (AND or OR).

Example"AND"

Default

"AND"

limit

Maximum number of results.

Example500

Default

500

offset

Pagination offset.

Example0

Default

0

search_graph

If True, traverse the position graph when filtering by position.

Exampletrue

Default

true

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"_id": "string",

  

  

"_key": "string",

  

  

"_rev": "string",

  

  

"_from": "Position/12345",

  

  

"_to": "Position/67890",

  

  

"type": "transfer",

  

  

"product_key": "67890",

  

  

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

  

  

"qt_planned": 100,

  

  

"qt_confirmed": 100,

  

  

"status": "completed",

  

  

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

  

  

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

  

  

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

  

  

"inverse_movement_key": "mvt-reversal-001",

  

  

"movement_list_key": "mvtlist-001",

  

  

"movement_list_item": 1,

  

  

"references": {

  

  

  

"work_order_key": "WO-2026-001",

  

  

  

"job_key": "job/job-2026-001",

  

  

  

"batch_key": "BATCH-A-042",

  

  

  

"origin_movement_key": "mvt-001",

  

  

  

"transfer_doc": "TRF-2026-0042",

  

  

  

"sales_doc": "DN-2026-0042",

  

  

  

"purchase_doc": "GR-2026-0042",

  

  

  

"partner_name": "Acme Supplies Ltd",

  

  

  

"partner_code": "ACME-001",

  

  

  

"inventory_count_session_key": "cnt-session-001"

  

  

},

  

  

"reason": "Annual stock adjustment",

  

  

"user_key": "user/operator-01",

  

  

"extra": "string",

  

  

"position_from_key": "12345",

  

  

"position_from_code": "WAREHOUSE-A",

  

  

"position_to_key": "67890",

  

  

"position_to_code": "LOCATION-B2-03",

  

  

"movement_list_code": "LIST-2026-001",

  

  

"product_code": "PROD-001",

  

  

"product_description": "Steel bracket M6",

  

  

"serial_code": "SN-LR-001234"

  

}

]

Samples

Powered by VitePress OpenAPI