Checking availability for your own connected clinic
inventory.availability:read. Takes up to 100 item identifiers in one request.
matched: false (with no band at all) means the identifier you sent didn’t resolve to anything in this clinic’s
catalogue — that is a different fact from out, and the two must never be confused: “we don’t know what this code
is” is not the same claim as “they have none.”
as_of is the timestamp of the item’s last recorded stock movement, or the moment of the read if it has never
moved — always state-what-was-true-when, never a live-looking number with no age attached to it.
This endpoint’s
band is always one of the three values above for a clinic you’re directly connected to — it
never returns unknown. Reading a single clinic you already hold a connection to assumes that clinic’s own
figures are current; the “we genuinely don’t know” case below is specific to searching across many pharmacies at
once.The one place a band is unknown — network search
Searching across the pharmacy network (rather than one clinic you’re connected to) can return a fourth value:
unknown means the pharmacy’s own point-of-sale hasn’t synced recently enough for its figures to be trusted — the
platform would rather say “we don’t know” than show a stale number as if it were live. It is not a fifth kind of
“out of stock” and must never be rendered that way; show it as its own state (a question mark, a “may be out of
date” label — never collapsed into out or in_stock).
See also
- Inventory — the full item and stock resource
- Permissions —
inventory.availability:readand what else it can see