List received batches

Any signed in user. Returns a page of received batches with medicine and supplier names. Search covers batch number, medicine, and supplier; hides written-off batches unless asked.

GET/api/v1/purchases

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Query parameters

supplier_idstring

Restrict to one supplier.

branch_idstring

Restrict to one branch.

medicine_idstring

Restrict to one medicine.

searchstring

Match the batch number, medicine name, or supplier name.

statusstring

active, expired, written_off, or all. Empty hides written-off batches.

from_datestring

Earliest receipt date, as YYYY-MM-DD.

to_datestring

Latest receipt date, as YYYY-MM-DD, inclusive of that whole day.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

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

Responses

200

A page of received batches

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

supplier_idstring | nullrequired

batch_numberstringrequired

expiry_datestringrequired

manufacturing_datestring | nullrequired

qty_receivedintegerrequired

min -9007199254740991 · max 9007199254740991

qty_remainingintegerrequired

min -9007199254740991 · max 9007199254740991

unit_coststringrequired

statusstringrequired

sfda_statusstringrequired

created_atstringrequired

medicine_namestring | nullrequired

medicine_selling_pricenumber | null

supplier_namestring | null

is_deletedboolean

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

supplier_idqueryRestrict to one supplier.branch_idqueryRestrict to one branch.medicine_idqueryRestrict to one medicine.searchqueryMatch the batch number, medicine name, or supplier name.statusqueryactive, expired, written_off, or all. Empty hides written-off batches.from_datequeryEarliest receipt date, as YYYY-MM-DD.to_datequeryLatest receipt date, as YYYY-MM-DD, inclusive of that whole day.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 20.

Request

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

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

import requests

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

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "medicine_id": "string",
      "branch_id": "string",
      "supplier_id": "string",
      "batch_number": "string",
      "expiry_date": "string",
      "manufacturing_date": "string",
      "qty_received": -9007199254740991,
      "qty_remaining": -9007199254740991,
      "unit_cost": "string",
      "status": "string",
      "sfda_status": "string",
      "created_at": "string",
      "medicine_name": "string",
      "medicine_selling_price": 0,
      "supplier_name": "string",
      "is_deleted": true
    }
  ]
}

{
  "detail": "string"
}