Cancel a prescription

Any signed in user. Moves a pending prescription to CANCELLED. Once dispensed or cancelled a prescription is refused, so a booked sale is never reversed.

POST/api/v1/prescriptions/{prescriptionId}/cancel

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

prescriptionIdstringrequired

The prescription id to cancel.

Responses

200

Prescription cancelled

rx_idstringrequired

statusstringrequired

400

Prescription is already dispensed or cancelled

detailstringrequired

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 to cancel.

Request

curl -X POST 'http://localhost:8000/api/v1/prescriptions/string/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

import requests

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

Response

{
  "rx_id": "string",
  "status": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}