Quarantine or release a batch

Any signed in user. Sets one batch’s regulatory status to quarantined, active, or recalled. A status outside those three is refused, so a batch cannot leave with an unknown state.

POST/api/v1/supplier-finance/batches/{batchId}/quarantine

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

batchIdstringrequired

The batch whose regulatory status changes.

Request body

requiredapplication/json

statusstring

Responses

200

The batch with its new status

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_costnumberrequired

statusstringrequired

sfda_statusstringrequired

is_deletedbooleanrequired

created_atstringrequired

400

Invalid quarantine status

detailstringrequired

401

Not authenticated

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 whose regulatory status changes.

Bodyapplication/json

statusstring

Request

curl -X POST 'http://localhost:8000/api/v1/supplier-finance/batches/string/quarantine' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/supplier-finance/batches/string/quarantine", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"status\": \"string\"\n}"
});

import requests

response = requests.post(
    "http://localhost:8000/api/v1/supplier-finance/batches/string/quarantine",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"status\": \"string\"\n}",
)

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": 0,
  "status": "string",
  "sfda_status": "string",
  "is_deleted": true,
  "created_at": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}