List expiring batches

Any signed in user. Returns active in-stock batches within the days window, soonest first. Recalled and quarantined batches are excluded, days defaults to 90, and limit caps rows.

GET/api/v1/purchases/expiring

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Query parameters

branch_idstring

Restrict to one branch. Empty covers every branch.

daysinteger

Look ahead window in days, clamped to 1 through 3650. Defaults to 90.

limitinteger

Maximum rows returned, clamped to 1 through 100. Defaults to 6.

Responses

200

The batches nearest expiry

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

limitintegerrequired

min -9007199254740991 · max 9007199254740991

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

branch_idqueryRestrict to one branch. Empty covers every branch.daysqueryLook ahead window in days, clamped to 1 through 3650. Defaults to 90.limitqueryMaximum rows returned, clamped to 1 through 100. Defaults to 6.

Request

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

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

import requests

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

Response

{
  "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
    }
  ],
  "limit": -9007199254740991
}

{
  "detail": "string"
}