Pharmacy stock check

Which pharmacies have enough of a drug.

POST/v1/actions

typepharmacy_stock_check

Input

drugobjectRequired
What to look for.
drug_namestringRequired
Up to 255 characters.
strengthstringRequired
Up to 64 characters.
formstring
Up to 64 characters.
quantityintegerRequired
How much the patient needs. 1 to 10,000.
pharmaciesarray of objectsRequired
Called in this order. 1 to 10 items.
namestringRequired
Such as CVS Pharmacy. Up to 255 characters.
addressobjectRequired
The exact store.
line1stringRequired
Street address. Up to 255 characters.
line2string
Suite or unit. Up to 255 characters.
citystringRequired
Up to 120 characters.
statestringRequired
Such as CA. Two-letter state code.
postal_codestringRequired
Five-digit ZIP code. 5 digits.
npistring
The pharmacy NPI. 10 digits.
phonestring
A hint. Vene checks the number before it dials. E.164 phone number.
include_cash_priceboolean
Also ask the cash price.

Returns

The action, with this result once it ends.

summarystring
What happened, in a sentence or two. Up to 2,000 characters.
failure_reasonenum, nullable
Why it failed. Null unless failed.
Possible values
- patient_authorization_requiredThe place needs the patient herself to authorize it.
- place_would_not_helpThe place would not discuss it with Vene.
- place_unreachableClosed, never answered, or no working number.
- declined_by_youYou declined something the action needed.
- fee_over_maxThe fee was over max_fee. The result names it.
- internal_errorA Vene fault.
next_stepstring, nullable
What you could do next. Up to 1,000 characters.
pharmaciesarray of objects
One per pharmacy, in input order.
pharmacyobject
namestring
Such as CVS Pharmacy. Up to 255 characters.
addressobject
The exact store.
line1string
Street address. Up to 255 characters.
line2string
Suite or unit. Up to 255 characters.
citystring
Up to 120 characters.
statestring
Such as CA. Two-letter state code.
postal_codestring
Five-digit ZIP code. 5 digits.
npistring
The pharmacy NPI. 10 digits.
phonestring
A hint. Vene checks the number before it dials. E.164 phone number.
stockenum, nullable
How much it has.
Possible values
full_quantityHas at least the quantity asked for.
partial_quantityHas some, less than the quantity asked for.
out_of_stockHas none.
quantity_availableinteger, nullable
Units on hand.
can_have_bydate, nullable
When it could have enough.
cash_priceobject, nullable
For the quantity asked, when you asked.
amount_centsinteger
Whole cents.
currencyenum
Always USD.
Possible values
USDUS dollars.

Questions

inputtextnumberbooleandatechoice

How to answer them

Calls

ask_pharmacy_stock

Errors

400invalid_request
The body or query failed validation.
401unauthorized
The API key is missing, unknown, or revoked.
403forbidden
The key lacks the scope.
409idempotency_conflict
The key was used with a different body.
429rate_limited
Over a limit. Wait for Retry-After.
500internal_error
A Vene fault.

curl -X POST https://api.venehealth.com/v1/actions \
  -H "Authorization: Bearer <api_key>" \
  -H "Idempotency-Key: <idempotency_key>" \
  -H "Content-Type: application/json" \
  --data @- <<'JSON'
{
  "type": "pharmacy_stock_check",
  "input": {
    "drug": {
      "drug_name": "amoxicillin",
      "strength": "400 mg/5 mL",
      "form": "oral suspension",
      "quantity": 100
    },
    "pharmacies": [
      {
        "name": "Rite Aid",
        "address": {
          "line1": "5000 College Ave",
          "city": "Oakland",
          "state": "CA",
          "postal_code": "94618"
        }
      },
      {
        "name": "CVS Pharmacy",
        "address": {
          "line1": "6310 College Ave",
          "city": "Oakland",
          "state": "CA",
          "postal_code": "94618"
        }
      }
    ],
    "include_cash_price": true
  }
}
JSON

const response = await fetch('https://api.venehealth.com/v1/actions', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <api_key>',
    'Idempotency-Key': '<idempotency_key>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "type": "pharmacy_stock_check",
    "input": {
      "drug": {
        "drug_name": "amoxicillin",
        "strength": "400 mg/5 mL",
        "form": "oral suspension",
        "quantity": 100
      },
      "pharmacies": [
        {
          "name": "Rite Aid",
          "address": {
            "line1": "5000 College Ave",
            "city": "Oakland",
            "state": "CA",
            "postal_code": "94618"
          }
        },
        {
          "name": "CVS Pharmacy",
          "address": {
            "line1": "6310 College Ave",
            "city": "Oakland",
            "state": "CA",
            "postal_code": "94618"
          }
        }
      ],
      "include_cash_price": true
    }
  }),
})
const result = await response.json()

Response 201

{
  "id": "<action_id>",
  "type": "pharmacy_stock_check",
  "status": "succeeded",
  "input": {
    "drug": {
      "drug_name": "amoxicillin",
      "strength": "400 mg/5 mL",
      "form": "oral suspension",
      "quantity": 100
    },
    "pharmacies": [
      {
        "name": "Rite Aid",
        "address": {
          "line1": "5000 College Ave",
          "city": "Oakland",
          "state": "CA",
          "postal_code": "94618"
        }
      },
      {
        "name": "CVS Pharmacy",
        "address": {
          "line1": "6310 College Ave",
          "city": "Oakland",
          "state": "CA",
          "postal_code": "94618"
        }
      }
    ],
    "include_cash_price": true
  },
  "questions": [],
  "result": {
    "summary": "Rite Aid is out of stock until Thursday. CVS on College Ave has 100 mL ready now for $14.99.",
    "failure_reason": null,
    "next_step": null,
    "pharmacies": [
      {
        "pharmacy": {
          "name": "Rite Aid",
          "address": {
            "line1": "5000 College Ave",
            "city": "Oakland",
            "state": "CA",
            "postal_code": "94618"
          }
        },
        "stock": "out_of_stock",
        "quantity_available": 0,
        "can_have_by": "2026-11-05",
        "cash_price": null
      },
      {
        "pharmacy": {
          "name": "CVS Pharmacy",
          "address": {
            "line1": "6310 College Ave",
            "city": "Oakland",
            "state": "CA",
            "postal_code": "94618"
          }
        },
        "stock": "full_quantity",
        "quantity_available": 150,
        "can_have_by": null,
        "cash_price": {
          "amount_cents": 1499,
          "currency": "USD"
        }
      }
    ]
  },
  "trail": [
    {
      "id": "<call_id>",
      "call_type": "ask_pharmacy_stock",
      "place": {
        "name": "Rite Aid",
        "address": {
          "line1": "5000 College Ave",
          "city": "Oakland",
          "state": "CA",
          "postal_code": "94618"
        },
        "phone": "+15105550123"
      },
      "started_at": "2026-11-02T17:02:00.000Z",
      "ended_at": "2026-11-02T17:05:30.000Z",
      "ended_reason": "completed"
    },
    {
      "id": "<call_id_2>",
      "call_type": "ask_pharmacy_stock",
      "place": {
        "name": "CVS Pharmacy",
        "address": {
          "line1": "6310 College Ave",
          "city": "Oakland",
          "state": "CA",
          "postal_code": "94618"
        },
        "phone": "+15105550139"
      },
      "started_at": "2026-11-02T17:06:00.000Z",
      "ended_at": "2026-11-02T17:09:30.000Z",
      "ended_reason": "completed"
    }
  ],
  "created_at": "2026-11-02T17:01:30.000Z",
  "updated_at": "2026-11-02T17:12:10.000Z",
  "ended_at": "2026-11-02T17:12:10.000Z"
}