List the will-call queue

Any signed in user. Returns will-call pickups for the branch by status, newest first. The branch comes from the session, and the status defaults to ready, not the picked up ones.

GET/api/v1/dispensing/will-call

Authorization

AuthorizationBearer token (JWT) · headerrequired

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

Query parameters

statusstring

One of ready, picked_up, returned_to_stock, or cancelled. Defaults to ready.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 20.

Responses

200

A page of will-call pickups

itemsobject[]required

Show properties

Array 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

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

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

statusqueryOne of ready, picked_up, returned_to_stock, or cancelled. Defaults to ready.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 20.

Request

curl -X GET 'http://localhost:8000/api/v1/dispensing/will-call' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/dispensing/will-call", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/dispensing/will-call",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "items": [
    {
      "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"
    }
  ],
  "page": -9007199254740991,
  "page_size": -9007199254740991
}

{
  "detail": "string"
}