Collect a will-call pickup

Any signed in user. Marks a will-call entry picked up and records the signature flag. The entry moves to picked_up with the collection time, and an unknown id answers with null.

PUT/api/v1/dispensing/will-call/{willCallId}/pickup

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Path parameters

willCallIdstringrequired

The will-call entry id.

Request body

requiredapplication/json

signature_capturedboolean

Responses

200

The collected entry, or null when the id matches nothing

Any of:

object

idstringrequired

branch_idstringrequired

prescription_idstring | nullrequired

sale_idstring | nullrequired

patient_namestringrequired

patient_phonestringrequired

statusstringrequired

signature_capturedintegerrequired

min -9007199254740991 · max 9007199254740991

picked_up_atstring | nullrequired

created_bystringrequired

created_atstringrequired

null

null

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

willCallIdpath*The will-call entry id.

Bodyapplication/json

signature_capturedboolean

Request

curl -X PUT 'http://localhost:8000/api/v1/dispensing/will-call/string/pickup' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "signature_captured": true
}'

const response = await fetch("http://localhost:8000/api/v1/dispensing/will-call/string/pickup", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"signature_captured\": true\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/dispensing/will-call/string/pickup",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"signature_captured\": true\n}",
)

Response

{
  "id": "string",
  "branch_id": "string",
  "prescription_id": "string",
  "sale_id": "string",
  "patient_name": "string",
  "patient_phone": "string",
  "status": "string",
  "signature_captured": -9007199254740991,
  "picked_up_at": "string",
  "created_by": "string",
  "created_at": "string"
}

{
  "detail": "string"
}