List stock movements

Any signed in user. Returns a page of stock movements across every branch, newest first. Filters cover medicine, branch, and type; search matches name, reason, or reference id.

GET/api/v1/purchases/movements/all

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

medicine_idstring

Restrict to one medicine.

branch_idstring

Restrict to one branch.

movement_typestring

IN, OUT, ADJUST, RETURN, or WRITE_OFF. Empty covers every type.

searchstring

Match the medicine name, the movement reason, or the reference id.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 50.

Responses

200

A page of stock movements

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

medicine_idstringrequired

branch_idstringrequired

batch_idstring | nullrequired

qty_deltaintegerrequired

min -9007199254740991 · max 9007199254740991

movement_typestringrequired

reference_typestring | nullrequired

reasonstringrequired

created_bystringrequired

created_atstringrequired

medicine_namestring | nullrequired

branch_namestring | nullrequired

user_namestring | nullrequired

401

Not authenticated

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

medicine_idqueryRestrict to one medicine.branch_idqueryRestrict to one branch.movement_typequeryIN, OUT, ADJUST, RETURN, or WRITE_OFF. Empty covers every type.searchqueryMatch the medicine name, the movement reason, or the reference id.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 50.

Request

curl -X GET 'http://localhost:8000/api/v1/purchases/movements/all' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/purchases/movements/all", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/purchases/movements/all",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "medicine_id": "string",
      "branch_id": "string",
      "batch_id": "string",
      "qty_delta": -9007199254740991,
      "movement_type": "string",
      "reference_type": "string",
      "reason": "string",
      "created_by": "string",
      "created_at": "string",
      "medicine_name": "string",
      "branch_name": "string",
      "user_name": "string"
    }
  ]
}

{
  "detail": "string"
}