Skip to content

GET /movement-list

Search Movement Lists

GET
/movement-list

Search movement lists (warehouse transfer orders).

Queries the MovementList collection with optional filters for status, type,
date range, and product inclusion. Each result includes aggregated counts of
movements per status. open_only=true restricts results to lists that still
have planned or started movements.

Emits: (direct query — no event class)
Required scope: inventory:movement-list: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
includes_product_key
includes_product_code
due_by_min
due_by_max
type
open_only
Type
boolean
Default
false
limit
Type
integer
Default
100
offset
Type
integer
Default
0

Request Body

application/json
JSON
{
  
"list_key": [
  
  
"string"
  
],
  
"status": [
  
  
"string"
  
]
}

Responses

Successful Response

application/json
JSON
[
  
{
  
  
"_id": "string",
  
  
"_key": "string",
  
  
"_rev": "string",
  
  
"code": "LIST-2026-001",
  
  
"notes": "Replenishment from supplier WH",
  
  
"due_by": "2026-05-20",
  
  
"created": "2026-05-15T10:00:00Z",
  
  
"start": "2026-05-15T10:00:00Z",
  
  
"end": "2026-05-15T12:00:00Z",
  
  
"status": "planned",
  
  
"extra": "string",
  
  
"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"
  
  
},
  
  
"type": "transfer",
  
  
"counts": {
  
  
  
"additionalProperties": 0
  
  
}
  
}
]

Samples

Powered by VitePress OpenAPI

Released under the Apache 2.0 License.