How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MedAdvisor Refill Order API

The RefillOrder API from MedAdvisor — 14 operation(s) for refillorder.

MedAdvisor Refill Order API is one of 14 APIs that MedAdvisor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include RefillOrder. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 15 operations across 14 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://pharmacy-unified.api.medadvisor.com.au.

15 operations 14 paths 14 schemas 2 DELETE3 GET9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://pharmacy-unified.api.medadvisor.com.au
Authentication
API Key
Resource Areas
1

Authentication & Security 1

MedAdvisor Refill Order API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 2 DELETE, 3 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

RefillOrder 15
GET
/api/v1/RefillOrder/PendingOrder/{orderId}
Get full pending order with line items and resolved statuses (Epic 2 — Story 2.1). Returns HTTP 404 when the order does not exist or does not belong to this pharmacy.
RefillOrder_GetPendingOrder 1 param → 200
DELETE
/api/v1/RefillOrder/PendingOrder/{orderId}
Delete a pending order (Epic 2 — Story 2.5a, FR29). Returns 404 when the order does not exist or does not belong to this pharmacy.
RefillOrder_Delete 1 param → 204
GET
/api/v1/RefillOrder/CompletedOrder/{orderId}
Get a completed order with read-only details and PIA payment status (Epic 6 — Story 6.1). Returns HTTP 404 when the order does not exist or does not belong to this pharmacy.
RefillOrder_GetCompletedOrder 1 param → 200
GET
/api/v1/RefillOrder/EScriptToken/{orderId}/{tokenId}
Get full eScript token detail for a line item (Epic 3 — Story 3.2, FR15). Returns 404 when the order does not belong to this pharmacy or the token is not found.
RefillOrder_GetEScriptToken 2 params → 200
PUT
/api/v1/RefillOrder/Delivery/{orderId}
Update delivery address fields, shipping method, or delivery status (Story 4.1 — FR18–FR20). Returns 404 when the order does not exist, does not belong to this pharmacy, or is not a delivery order.
RefillOrder_UpdateDelivery 1 param body → 204
POST
/api/v1/RefillOrder/AddNote
Add or update a pharmacy note on an order (Epic 5 — Story 5.1, FR24). Returns 404 when the order does not belong to this pharmacy.
RefillOrder_AddNote body → 204
POST
/api/v1/RefillOrder/Complete
Finalise (complete) a pending order (Story 2.5b — FR27). Returns 404 when the order does not exist or does not belong to this pharmacy. Returns 400 when the order has no line items to tally.
RefillOrder_Complete body → 204
POST
/api/v1/RefillOrder/ProcessPIA
Process a Pay-in-Advance charge (Epic 4 — Story 4.3).
RefillOrder_ProcessPIA body → 204
POST
/api/v1/RefillOrder/SendEScript
Send an eScript token to the dispensing system (Epic 3 — Story 3.3, FR16). Always returns HTTP 200; the response body Code field indicates SUCCESS, FALLBACKTOPLUSONE (Angular must call PlusOne JS bri…
RefillOrder_SendEScript body → 200
POST
/api/v1/RefillOrder/LineItem/{orderId}
Add a custom line item to a pending order (Story 3.5 — FR13). Returns the full updated order so the caller can refresh its list in one round-trip. Returns 400 when the name is missing; 404 when the o…
RefillOrder_AddLineItem 1 param body → 200
POST
/api/v1/RefillOrder/UpdateLineItemStatus
Update the status of a line item (Epic 3 — Story 3.1, FR6–FR9). Returns 404 when the order or component does not belong to this pharmacy. Returns 400 when action = OnOrder but followUpDate is absent.
RefillOrder_UpdateLineItemStatus body → 204
POST
/api/v1/RefillOrder/CompletedOrder/{orderId}/Refund
Refund the PIA charge for a completed order (Epic 6 — Story 6.4, CRO-5). Returns 404 when the order does not exist or does not belong to this pharmacy. Returns 400 with an error message when the refu…
RefillOrder_RefundOrder 1 param → 204
POST
/api/v1/RefillOrder/CompletedOrder/{orderId}/Reminder
Send a reminder message to a patient for a completed order (Epic 6 — Story 6.2, CRO-2). Returns 404 when the order does not exist or does not belong to this pharmacy. Returns 400 when the message bod…
RefillOrder_SendReminder 1 param body → 204
POST
/api/v1/RefillOrder/CompletedOrder/{orderId}/ReturnToStock
Return all items for a completed order to stock (Epic 6 — Story 6.3, CRO-3). Returns 404 when the order does not exist or does not belong to this pharmacy.
RefillOrder_ReturnToStock 1 param → 204
DELETE
/api/v1/RefillOrder/LineItem/{orderId}/{lineItemId}
Delete a custom line item from a pending order (Story 3.5 — FR14). Returns 404 when the order, item, or pharmacy context is not found, or the item is not a custom item (only custom items may be delet…
RefillOrder_DeleteLineItem 2 params → 204

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are MedAdvisor.PharmacyUnifiedAPI.v1.Models.PendingOrderModel (34 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.PendingOrderLineItemModel (26 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.EScriptTokenDetailModel (17 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.UpdateDeliveryRequest (5 properties). Each schema is shown below with its type and property counts.

MedAdvisor.PharmacyUnifiedAPI.v1.Models.UpdateLineItemStatusRequest
object
Request body for POST /RefillOrder/UpdateLineItemStatus (RAP-6 — Story 3.1). Carries the orderId + componentId so the service can verify component ownership be…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PendingOrderLineItemModel
object
A single line item within a pending order, with its status pre-resolved server-side. Used by the Angular Pending Order dialog (RAP-6 — Epic 2, Story 2.1).
26 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.PendingOrderModel
object
Order payload returned by GET /api/v1/RefillOrder/PendingOrder/{orderId} and GET /api/v1/RefillOrder/CompletedOrder/{orderId}. Used by the Angular Pending Orde…
34 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AddLineItemRequest
object
Request body for POST /RefillOrder/LineItem/{orderId} (RAP-6 — Story 3.5, FR13).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.LineItemPriceEntry
object
Per-component price entered by the pharmacist at PIA order completion.
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendReminderRequest
object
Request body for POST /api/v1/RefillOrder/CompletedOrder/{orderId}/Reminder (Epic 6 — Story 6.2).
1 property
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendEScriptRequest
object
Request body for POST /RefillOrder/SendEScript (RAP-6 — Story 3.3, FR16).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.AddNoteRequest
object
Request body for POST /RefillOrder/AddNote (Epic 5 — Story 5.1, FR24).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.UpdateDeliveryRequest
object
Request body for PUT /RefillOrder/Delivery/{orderId} (Story 4.1 — FR18, FR19, FR20). All fields are optional — only non-null values are applied.
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.SendEScriptResponse
object
Response from POST /RefillOrder/SendEScript (RAP-6 — Story 3.3, FR16). Always returned as HTTP 200 so Angular can distinguish the three outcomes without interc…
3 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.CompleteOrderRequest
object
Request body for POST /RefillOrder/Complete (RAP-6 — Story 2.5b FR27, Story 4.3 FR22).
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.DeliveryAgentOptionModel
object
A shipping agent option shown in the delivery section dropdown (Story 4.1 — FR19).
2 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EScriptTokenSummaryModel
object
Summary of a single eScript token embedded in the pending order line item response (FR4). Provides enough information to display the token list without a separ…
5 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.EScriptTokenDetailModel
object
Full eScript token detail returned by GET /RefillOrder/EScriptToken/{orderId}/{tokenId} (FR15). Maps from EScriptDto in MedAdvisor.Framework.Interface.
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medadvisor-refillorder-api-openapi.yml Raw ↑

Other APIs MedAdvisor publishes across the network.

MedAdvisor 3rd-Party Integration API
MedAdvisor Account API
MedAdvisor Booking API
MedAdvisor Booking Service API
MedAdvisor Calendar Setting API
MedAdvisor Clinic API
MedAdvisor Communication API
MedAdvisor Config API
MedAdvisor Head Office API
MedAdvisor Inbox API
MedAdvisor Logging API
MedAdvisor Pharmacist API
Where this information came from

This is an independent, third-party profile of MedAdvisor Refill Order API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.