Update a medicine

Admin, inventory manager, or branch manager. Patches editable fields and returns the row. Fields outside the editable set are ignored, and a payload with nothing editable is refused.

PUT/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 being updated.

Request body

requiredapplication/json

namestring

min length 1

generic_namestring

default: ""

barcodestring

default: ""

categorystring

default: ""

formstring

default: ""

strengthstring

default: ""

unitstring

default: ""

selling_pricestring

default: "0.000"

low_stock_thresholdinteger

min -9007199254740991 · max 9007199254740991 · default: 10

requires_prescriptionboolean

default: false

is_controlledboolean

default: false

vat_categorystring

default: "zero_rated"

requires_cold_chainboolean

default: false

sfda_registration_nostring

default: ""

max_public_pricestring

default: "0.000"

Responses

200

Medicine updated

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

400

The body is invalid, or no updatable field is supplied

detailstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin, inventory manager, or branch manager

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 being updated.

Bodyapplication/json

namestringgeneric_namestringbarcodestringcategorystringformstringstrengthstringunitstringselling_pricestringlow_stock_thresholdintegerrequires_prescriptionbooleanis_controlledbooleanvat_categorystringrequires_cold_chainbooleansfda_registration_nostringmax_public_pricestring

Request

curl -X PUT 'http://localhost:8000/api/v1/medicines/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "generic_name": "",
  "barcode": "",
  "category": "",
  "form": "",
  "strength": "",
  "unit": "",
  "selling_price": "0.000",
  "low_stock_threshold": 10,
  "requires_prescription": false,
  "is_controlled": false,
  "vat_category": "zero_rated",
  "requires_cold_chain": false,
  "sfda_registration_no": "",
  "max_public_price": "0.000"
}'

const response = await fetch("http://localhost:8000/api/v1/medicines/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"generic_name\": \"\",\n  \"barcode\": \"\",\n  \"category\": \"\",\n  \"form\": \"\",\n  \"strength\": \"\",\n  \"unit\": \"\",\n  \"selling_price\": \"0.000\",\n  \"low_stock_threshold\": 10,\n  \"requires_prescription\": false,\n  \"is_controlled\": false,\n  \"vat_category\": \"zero_rated\",\n  \"requires_cold_chain\": false,\n  \"sfda_registration_no\": \"\",\n  \"max_public_price\": \"0.000\"\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/medicines/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"generic_name\": \"\",\n  \"barcode\": \"\",\n  \"category\": \"\",\n  \"form\": \"\",\n  \"strength\": \"\",\n  \"unit\": \"\",\n  \"selling_price\": \"0.000\",\n  \"low_stock_threshold\": 10,\n  \"requires_prescription\": false,\n  \"is_controlled\": false,\n  \"vat_category\": \"zero_rated\",\n  \"requires_cold_chain\": false,\n  \"sfda_registration_no\": \"\",\n  \"max_public_price\": \"0.000\"\n}",
)

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

{
  "detail": "string"
}

{
  "detail": "string"
}