Prescriptions
Get Order Details
📦 Order Details — Field Reference
This endpoint returns all prescription-level details associated with an order, using the provided orderId.
Each record in the response array represents one prescription entry tied to the order.
🛡️ Security
Headers
| Field | Type | Description | Required |
|---|---|---|---|
| x-api-key | String | API Key for authentication | Y |
| clinicId | String | Clinic ID in header overrides route parameter | Y |
🔍 Query Parameters
| Field | Type | Description | Required |
|---|---|---|---|
| apiKey | String | Partner API key | Y |
| clinicId | String | Clinic identifier | Y |
🔗 Path Parameters
| Field | Type | Description | Required |
|---|---|---|---|
| orderId | String | Order identifier (UUID) | Y |
📄 Field Details
The endpoint returns an array of objects containing the following fields:
| Field | Type | Description |
|---|---|---|
| clinicId | String | Clinic linked to the prescription |
| status | String | Prescription workflow status (e.g., ‘new’, ‘shipped’) |
| notes | String | Any recorded internal notes |
| trackingInfo | String / null | Shipping tracking number, if available |
| createdAt | String (ISO) | Timestamp when record was created |
| updatedAt | String (ISO) | Last updated timestamp |
| receivedAt | String (ISO) | Timestamp when order was received |
| prescriptionId | String | Unique prescription identifier |
| rxId | String / null | Pharmacy Rx number, if present |
| refillsRemaining | Number | Remaining refill count |
| fillDate | String / null | Date prescription was last filled |
| quantityFilled | Number | Quantity dispensed |
Successful Response (200)
An array of entries is returned — one entry per prescription.
Error Responses
| Status | Meaning |
|---|---|
| 401 | Invalid API key or missing authentication |
| 404 | Order not found |
GET
Get Order Details
Path Parameters
Response
Order details returned successfully.
Example:
"cc825b7e-2b99-4c0a-a612-75b3dd77e645"
Example:
"3b47a23f-9080-4a2e-a4fa-654d9aa76e80"
Example:
"SHIPPED"
Example:
"TEST NOTE-1"
Example:
"F3055359305"
Example:
"2025-09-25T19:58:54.293Z"
Example:
"2025-09-25T19:59:00.486Z"
Example:
"2025-09-25T19:58:54.313Z"
Example:
"7a31d457-0052-4746-a3d7-f45d7182cb68"
Example:
"RX098934"
Example:
2
Example:
"2025-09-28T19:58:54.313Z"
Example:
30
Example:
[
{
"clinicId": "3b47a23f-9080-4a2e-a4fa-654d9aa76e80",
"status": "new",
"notes": "PATIENT REPORTS NO SIDE EFFECTS WITH PREVIOUS PRESCRIPTION",
"trackingInfo": null,
"createdAt": "2025-12-12T21:18:38.548Z",
"updatedAt": "2025-12-12T21:18:38.589Z",
"receivedAt": "2025-12-12T21:18:38.589Z",
"prescriptionId": "e96bd788-dca5-48a2-8860-ef615266fa7d",
"rxId": null,
"refillsRemaining": 2,
"fillDate": null,
"quantityFilled": 0
},
{
"clinicId": "3b47a23f-9080-4a2e-a4fa-654d9aa76e80",
"status": "new",
"notes": "PATIENT REPORTS NO SIDE EFFECTS WITH PREVIOUS PRESCRIPTION",
"trackingInfo": null,
"createdAt": "2025-12-12T21:18:38.548Z",
"updatedAt": "2025-12-12T21:18:38.589Z",
"receivedAt": "2025-12-12T21:18:38.589Z",
"prescriptionId": "cg5bd788-dca5-48a2-8860-ef615266fa7e",
"rxId": null,
"refillsRemaining": 2,
"fillDate": null,
"quantityFilled": 0
}
]Previous
Get Refill Prescription StatusGet a Refill Prescription Status with ID, after a refill is requested.
This endpoint is used to check the status of a refill request for a given prescription ID.
It returns the current status of the refill, such as whether it is pending, approved, denied, or completed.
Next
Get Order Details