List a medicine's stock movements

Any signed in user. Returns a page of the stock ledger for one medicine, newest first. The ledger is the only record, so an unknown medicine reports no movements, not an error.

GET/api/v1/medicines/{medicineId}/movements

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

medicineIdstringrequired

The medicine whose movements are listed.

Query parameters

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_idstring | nullrequired

reference_typestring | nullrequired

reasonstringrequired

created_bystringrequired

client_mutation_idstring | nullrequired

device_idstring | nullrequired

created_atstringrequired

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

medicineIdpath*The medicine whose movements are listed.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/medicines/string/movements' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

import requests

response = requests.get(
    "http://localhost:8000/api/v1/medicines/string/movements",
    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_id": "string",
      "reference_type": "string",
      "reason": "string",
      "created_by": "string",
      "client_mutation_id": "string",
      "device_id": "string",
      "created_at": "string",
      "user_name": "string"
    }
  ]
}

{
  "detail": "string"
}