Read a received batch

Any signed in user. Returns one received batch with medicine and supplier names joined. An unknown batch id is refused with 404 rather than answered with an empty document.

GET/api/v1/purchases/{batchId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

batchIdstringrequired

The batch id.

Responses

200

The received batch

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

404

Purchase not found

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

batchIdpath*The batch id.

Request

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

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

import requests

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

Response

{
  "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"
}

{
  "detail": "string"
}