Prescriptions¶
Ingest and list prescription requests for your organization.
List prescriptions¶
GET /api/v2/public/orgs/{orgId}/prescriptions?limit=50&offset=0&status=new
Authorization: Bearer {token}
Scope: prescriptions.read
Response¶
{
"data": [
{
"id": "org1-pq-CQ3TLK",
"status": "new",
"shop_id": "shop1",
"order_id": "",
"customer_email": "",
"created_at": "2026-06-06T00:22:03.574733Z"
}
],
"pagination": { "limit": 50, "offset": 0 }
}
Get prescription¶
Scope: prescriptions.read
{
"id": "org1-pq-CQ3TLK",
"status": "new",
"shop_id": "shop1",
"order_id": "",
"customer_email": "",
"created_at": "2026-06-06T00:22:03.574733Z"
}
Ingest prescription¶
POST /api/v2/public/orgs/{orgId}/prescriptions
Authorization: Bearer {token}
Content-Type: application/json
{
"shop_id": "shop1",
"customer_email": "max@example.com"
}
Scope: prescriptions.write
org_id is taken from the URL path (do not pass a conflicting query param).
Success¶
The ingest endpoint accepts the full prescription payload used by shop frontends (customer data, PDF references, questionnaire answers, and related metadata).
Status values¶
| Status | Meaning |
|---|---|
new |
Received, pending review |
pending |
In workflow |
pending_signature |
Awaiting QES/signature |
signed / approved |
Approved |
declined |
Declined |
completed |
Fulfilled |
Webhooks¶
| Event | When |
|---|---|
prescription_approved |
Prescription approved in workflow |
paperless_signature_completed |
QES signature completed |
See Webhooks.