Skip to main content

Orders

Query the fulfillment status of orders by their associated prescription UIDs.

Get Order Status

Retrieve order and fulfillment status for one or more prescriptions.
string
required
Unique identifier for the shop
string
required
Comma-separated list of prescription UIDs (max 50)
Required permission: order:read

Example Request

Response

Unknown prescription UIDs, and prescriptions that are not scoped to your organisation, are omitted from data (HTTP 200 with an empty list if none match). A prescription that belongs to your organisation but has no order yet is included, with order_status and usually fulfillment_status set to null.

Response Fields

order_status values

Returned as stored. Possible values:

fulfillment_status values

Returned as stored. Possible values:

Error Responses