Vital home pagelight logo
  1. Get Testkits
GET

/v2/testkit/orders/{order_id}

x-vital-api-key*

​
Parameters

order_idRequired
string

Your Order ID.

​
Response

patient_detailsRequired

Patient Details

patient_addressRequired

Patient Address

testkitRequired
object

TestkitClientFacing

testkit_idRequired
string

Testkit id

updated_onRequired
string

When your order status was last updated

created_onRequired
string

When your order was created

team_idRequired
string

Your team id.

user_idRequired
string

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

user_key
string

User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.

id
string

The Vital Order ID

status

Order status: ordered, transit_customer, out_for_delivery, with_customer, transit_lab, delivered_to_lab, processing_lab, completed, failure_to_deliver_to_customer, failure_to_deliver_to_lab, cancelled, do_not_process, unknown

inbound_tracking_number
string

Tracking number for delivery to lab

outbound_tracking_number
string

Tracking number for delivery to customer

inbound_tracking_url
string

Tracking url for delivery to lab

outbound_tracking_url
string

Tracking url for delivery to customer

outbound_courier
string

Courier used for delivery to customer

inbound_courier
string

Courier used for delivery to lab

sample_id
string

Sample ID

notes
string

Notes associated with the order