Get a prescription

Any signed in user. Returns one prescription with its medicine lines. The lookup is scoped to the caller’s branch, so another branch’s prescription answers 404.

GET/api/v1/prescriptions/{prescriptionId}

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

prescriptionIdstringrequired

The prescription id.

Responses

200

The prescription

idstringrequired

branch_idstringrequired

rx_numberstringrequired

patient_namestringrequired

patient_id_numberstringrequired

prescriber_namestringrequired

prescriber_licensestringrequired

statusstringrequired

sale_idstring | nullrequired

dispensed_bystring | nullrequired

dispensed_by_namestring | nullrequired

notesstringrequired

created_bystringrequired

created_atstringrequired

updated_atstringrequired

dispensed_atstring | nullrequired

itemsobject[]required

Show properties

Array of object

idstringrequired

prescription_idstringrequired

medicine_idstringrequired

quantityintegerrequired

min -9007199254740991 · max 9007199254740991

dosage_instructionsstringrequired

medicine_namestringrequired

selling_pricestringrequired

vat_categorystringrequired

requires_prescriptionintegerrequired

min -9007199254740991 · max 9007199254740991

401

Not authenticated

detailstringrequired

404

Prescription 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

prescriptionIdpath*The prescription id.

Request

curl -X GET 'http://localhost:8000/api/v1/prescriptions/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

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

Response

{
  "id": "string",
  "branch_id": "string",
  "rx_number": "string",
  "patient_name": "string",
  "patient_id_number": "string",
  "prescriber_name": "string",
  "prescriber_license": "string",
  "status": "string",
  "sale_id": "string",
  "dispensed_by": "string",
  "dispensed_by_name": "string",
  "notes": "string",
  "created_by": "string",
  "created_at": "string",
  "updated_at": "string",
  "dispensed_at": "string",
  "items": [
    {
      "id": "string",
      "prescription_id": "string",
      "medicine_id": "string",
      "quantity": -9007199254740991,
      "dosage_instructions": "string",
      "medicine_name": "string",
      "selling_price": "string",
      "vat_category": "string",
      "requires_prescription": -9007199254740991
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}