Orders
Get Orders
GET many orders with filters.
GET
/
v3
/
orders
Authorizations
x-vital-api-key
string
headerrequiredVital Team API Key
Query Parameters
search_input
string | null
Search by order id, user id, patient name, shipping dob, or shipping recipient name.
start_date
string | null
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
end_date
string | null
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
updated_start_date
string | null
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
updated_end_date
string | null
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
order_key
enum<string> | null
Available options:
created_at
, patient_name
, last_status
order_direction
enum<string> | null
Available options:
asc
, desc
user_id
string | null
Filter by user ID.
patient_name
string | null
Filter by patient name.
shipping_recipient_name
string | null
Filter by shipping recipient name.
order_ids
string[] | null
Filter by order ids.
page
integer
default: 1size
integer
default: 50Response
200 - application/json
orders
object[]
requiredtotal
integer | null
page
integer | null
size
integer | null