Skip to main content
GET
Get an order

Authorizations

Authorization
string
header
required

Opaque mvy_test_ API key sent as a Bearer token. It derives exactly one workspace server-side; the path never carries a workspace selector.

Path Parameters

orderId
string
required

The opaque order id.

Response

The requested resource.

orderId
string
required
number
integer
required
type
enum<string>
required
Available options:
general,
clinical
status
enum<string>
required
Available options:
draft,
submitted,
pending_approval,
approved,
rejected,
cancelled,
allocated,
picking,
dispatched,
delivered,
exception,
received,
partially_fulfilled,
closed
requesterId
string
required
clinicId
string
required
destinationWarehouseId
string
required
lines
object[]
required
version
integer
required
preferredSourceWarehouseId
string
justification
string
patientRef
string

Redacted (absent) unless the key holds orders.patient_ref:read (never on /v1).

value
integer

Order total in minor units. Present only with orders.value:read (never on /v1).

currency
string
approvalPlan
object