Pharmacy Orders
Manage pharmacy orders — view incoming prescription orders and update their status as you process them.
List Orders
Number of items per page (max 200)
Filter by status (e.g., open, processing, completed)
Search by order name or patient name
Required for group-wide API keys
GET /v1/external-pharmacy-api-v1/pharmacy_orders/
Response
{
"data": [
{
"uid": "po-abc123",
"status": "open",
"name": "#1001",
"external_status": "OPEN",
"pharmacy": {
"uid": "ph-xyz",
"display_name": "City Pharmacy"
},
"order": {
"uid": "ord-123",
"delivery_address": { ... },
"invoice_address": { ... }
},
"order_items": [
{
"uid": "oi-789",
"amount": 1,
"sku": {
"uid": "sku-456",
"display_name": "Medication X 100mg",
"pzn": "12345678"
}
}
]
}
],
"totalRegistries": 42,
"totalPages": 1
}
Get Order Details
GET /v1/external-pharmacy-api-v1/pharmacy_orders/{pharmacy_order_uid}
Response (additional fields)
{
"uid": "po-abc123",
"patient_data": {
"uid": "pat-123",
"display_name": "Max Mustermann",
"email": "max@example.com",
"date_of_birth": "1990-01-15"
},
"doctor_data": {
"uid": "doc-456",
"display_name": "Dr. Schmidt"
},
"prescription_file": {
"filename": "prescription_001.pdf",
"content_base64": "JVBERi0xLjQK..."
}
}
Update Order Status
PATCH /v1/external-pharmacy-api-v1/pharmacy_orders/{pharmacy_order_uid}/status
Request Body
{
"status": "processing"
}
Allowed Status Values
| Status | Description |
|---|
open | Order received, not yet started |
processing | Order is being prepared |
shipped | Order has been shipped |
cancelled | Order was cancelled |
Setting status to completed is not available through this endpoint. Order completion is handled through a dedicated process that includes stock reduction.