Orders

Create a new order

post

Create a new blood, DNA, or device test order

Body

Request body for creating a new diagnostic test order

client_order_reference_idstring · min: 1 · max: 100Required

Your unique order identifier that you generate (for idempotency and tracking)

Example: ORDER-2024-001
collection_typestringRequired
Responses
post
/orders

Get order by order ID

get

Returns complete order details including items, recipient, and status

Authorizations
AuthorizationstringRequired
Path parameters
orderIDinteger · min: 1Required

Order ID

Responses
chevron-right
200

Successfully retrieved order

application/json

Full order information including items, recipient, address, and financials

client_idstringOptionalExample: terra_client_abc123
client_order_reference_idstringOptionalExample: ORDER-2024-001
collection_typestringOptionalExample: AT_HOME
order_idstringOptionalExample: 123456789
order_statusstringOptionalExample: shipped
supplier_idstringOptionalExample: 1
get
/orders/{orderID}

Last updated

Was this helpful?