Read a medicine

Any signed in user. Returns one medicine with its live stock quantity and pricing. A deactivated medicine reads as missing, so a soft deleted row is refused, not returned.

GET/api/v1/medicines/{medicineId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

medicineIdstringrequired

The medicine id.

Responses

200

The medicine

idstringrequired

namestringrequired

generic_namestringrequired

barcodestringrequired

categorystringrequired

formstringrequired

strengthstringrequired

unitstringrequired

selling_pricestringrequired

max_public_pricestringrequired

stock_quantityintegerrequired

min -9007199254740991 · max 9007199254740991

low_stock_thresholdintegerrequired

min -9007199254740991 · max 9007199254740991

requires_prescriptionbooleanrequired

is_controlledbooleanrequired

vat_categorystringrequired

requires_cold_chainbooleanrequired

sfda_registration_nostringrequired

image_keystringrequired

image_urlstringrequired

is_activebooleanrequired

created_atstringrequired

updated_atstringrequired

401

Not authenticated

detailstringrequired

404

Medicine 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

medicineIdpath*The medicine id.

Request

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

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

import requests

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

Response

{
  "id": "string",
  "name": "string",
  "generic_name": "string",
  "barcode": "string",
  "category": "string",
  "form": "string",
  "strength": "string",
  "unit": "string",
  "selling_price": "string",
  "max_public_price": "string",
  "stock_quantity": -9007199254740991,
  "low_stock_threshold": -9007199254740991,
  "requires_prescription": true,
  "is_controlled": true,
  "vat_category": "string",
  "requires_cold_chain": true,
  "sfda_registration_no": "string",
  "image_key": "string",
  "image_url": "string",
  "is_active": true,
  "created_at": "string",
  "updated_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}