Vital home page
light logo
  1. Legacy
  2. Create Order
GET
/v2/testkit/orders
x-vital-api-key*

​
Parameters

start_dateRequired
Date from in YYYY-MM-DD
end_dateRequired
Date to in YYYY-MM-DD
user_id
string
Filter by user ID.
patient_name
string
Filter by patient name.
pageDefault: 1
integer
Page
sizeDefault: 50
integer
Size

​
Response

sizeRequired
integer
Size
pageRequired
integer
Page
totalRequired
integer
Total
ordersRequired
array
turnaround_time_lower
integer
Turnaround time lower in days
turnaround_time_upper
integer
Turnaround time upper in days
price
number
Price of testkit in dollars
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