API Reference - Orders
Get order by ID
API Reference - Orders
Get order by ID
Retrieve a singular order matching the provided ID.
GET
/
api
/
v2
/
orders
/
{public_id}
/
Authorization
string
*
Authorization
Required
string
Token-based authentication with required prefix "Token"
public_id
string
*
public_id
Required
string
The ID of the order to retrieve.
curl --request GET \
--url https://app.spotdx.com/api/v2/orders/{public_id}/ \
--header 'Authorization: <api-key>'{
"order_id": "O1234567",
"status": "pending",
"recipient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"kit_types": [
"health_kit_1"
],
"kits": [
{
"kit_id": "SPOT123456",
"type": "health_kit_1",
"status": "preparing",
"events": [
{
"status": "preparing",
"created": "2023-01-01T04:30:11.222Z"
},
{
"status": "in_transit",
"created": "2023-01-05T04:30:11.222Z"
},
{
"status": "delivered",
"created": "2023-01-06T04:30:11.222Z"
},
{
"status": "registered",
"created": "2023-01-07T04:30:11.222Z"
}
],
"shipment_to_customer": {
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
},
"registered_to": {
"patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
"first_name": "Alice",
"last_name": "Smith",
"date_of_birth": "1990-01-01",
"sex": "F",
"email": "alice123@gmail.com",
"phone": "1234567890"
},
"sample": {
"sample_id": "SPOT654321",
"status": "awaiting_collection",
"events": [
{
"status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z"
},
{
"status": "in_transit",
"created": "2023-01-10T04:30:11.222Z"
},
{
"status": "delivered",
"created": "2023-01-11T04:30:11.222Z"
},
{
"status": "received",
"created": "2023-01-12T04:30:11.222Z"
},
{
"status": "resulted",
"created": "2023-01-13T04:30:11.222Z"
}
],
"type": "adx100",
"shipments": [
{
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
}
],
"panels": [
"PANEL-123"
],
"reports": [
{
"report_id": "<string>",
"results": [
{
"result_type": "quantity",
"name": "HDL Cholesterol",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": 123,
"unit_of_measure": "mg/dL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "quantity",
"name": "Vitamin B12",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "<10",
"unit_of_measure": "pg/mL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "reactivity",
"name": "Chlamydia",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "negative",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
},
{
"result_type": "genotype",
"name": "rs1234567",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "TT",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
}
],
"pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
"txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt",
"date_collected": "2023-11-07T05:31:56Z",
"date_received": "2023-11-07T05:31:56Z",
"date_resulted": "2023-11-07T05:31:56Z",
"is_amendment": true
}
]
}
}
],
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z",
"metadata": {}
}Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Path Parameters
public_id
string
requiredThe ID of the order to retrieve.
Response
200 - application/json
order_id
string
The unique identifier of the order.
status
enum<string>
Available options:
pending, in_progress, completed, canceled recipient
object
recipient.first_name
string
requiredRecipient's first name.
recipient.last_name
string
requiredRecipient's last name.
recipient.email
string
requiredRecipient's email.
recipient.phone
string
requiredRecipient's phone number, as a string.
recipient.address
object
requiredrecipient.address.street1
string
requiredRecipient's address.
recipient.address.street2
string | null
Second line of recipient's address.
recipient.address.city
string
requiredRecipient's city of residence.
recipient.address.state
string
requiredRecipient's state of residence.
recipient.address.country
enum<string>
requiredRecipient's country of residence.
Available options:
US, CA recipient.address.zip
string
requiredRecipient's zip code.
kit_types
string[]
A list of the kit types that are included in this order.
kits
object[]
kits.kit_id
string
The unique identifier of the kit.
kits.type
string
The kit's type
kits.status
enum<string>
The new status of the kit.
Available options:
preparing, in_transit, delivered, delivery_exception, registered, canceled kits.events
object[]
A list of all the events that have occurred for this kit.
kits.events.status
enum<string>
The new status of the kit.
Available options:
preparing, in_transit, delivered, delivery_exception, registered, canceled kits.events.created
string
The date and time the event occurred.
kits.shipment_to_customer
object
kits.shipment_to_customer.tracking_number
string | null
kits.shipment_to_customer.carrier
enum<string> | null
Available options:
fedex, ups, usps kits.shipment_to_customer.created
string
kits.registered_to
object
kits.registered_to.patient_id
string
kits.registered_to.first_name
string
kits.registered_to.last_name
string
kits.registered_to.date_of_birth
string
kits.registered_to.sex
enum<string>
Available options:
M, F kits.registered_to.email
string
kits.registered_to.phone
string
kits.sample
object
kits.sample.sample_id
string
kits.sample.status
enum<string>
The new status of the sample.
Available options:
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled kits.sample.events
object[]
kits.sample.events.status
enum<string>
The new status of the sample.
Available options:
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled kits.sample.events.created
string
kits.sample.type
enum<string>
Available options:
adx100, adx100_2, adx100_4, whatman903_10, dry_transport_swab, hemaspot_hf, saliva_3 kits.sample.shipments
object[]
kits.sample.shipments.tracking_number
string | null
kits.sample.shipments.carrier
enum<string> | null
Available options:
fedex, ups, usps kits.sample.shipments.created
string
kits.sample.panels
string[]
The panel codes of the test being performed on the sample. We'll create these with you during onboarding.
kits.sample.reports
array
kits.sample.reports.report_id
string
kits.sample.reports.results
object[]
kits.sample.reports.results.result_type
enum<string>
Available options:
quantity kits.sample.reports.results.name
string
The biomarker that was analyzed.
kits.sample.reports.results.time_collected
string
kits.sample.reports.results.result
kits.sample.reports.results.unit_of_measure
string | null
kits.sample.reports.results.range_minimum
string
kits.sample.reports.results.range_maximum
number
kits.sample.reports.results.comments
string | null
kits.sample.reports.pdf
string | null
A URL to the PDF report.
kits.sample.reports.txt
string | null
A URL to the TXT report.
kits.sample.reports.date_collected
string
kits.sample.reports.date_received
string
kits.sample.reports.date_resulted
string
kits.sample.reports.is_amendment
boolean
Whether this report is an amendment to a previous report.
created
string
The date and time the order was created.
updated
string
The date and time the order was last updated.
metadata
object | null
An optional dictionary of key-value pairs stored with the order.
curl --request GET \
--url https://app.spotdx.com/api/v2/orders/{public_id}/ \
--header 'Authorization: <api-key>'{
"order_id": "O1234567",
"status": "pending",
"recipient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"kit_types": [
"health_kit_1"
],
"kits": [
{
"kit_id": "SPOT123456",
"type": "health_kit_1",
"status": "preparing",
"events": [
{
"status": "preparing",
"created": "2023-01-01T04:30:11.222Z"
},
{
"status": "in_transit",
"created": "2023-01-05T04:30:11.222Z"
},
{
"status": "delivered",
"created": "2023-01-06T04:30:11.222Z"
},
{
"status": "registered",
"created": "2023-01-07T04:30:11.222Z"
}
],
"shipment_to_customer": {
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
},
"registered_to": {
"patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
"first_name": "Alice",
"last_name": "Smith",
"date_of_birth": "1990-01-01",
"sex": "F",
"email": "alice123@gmail.com",
"phone": "1234567890"
},
"sample": {
"sample_id": "SPOT654321",
"status": "awaiting_collection",
"events": [
{
"status": "awaiting_collection",
"created": "2023-01-01T04:30:11.222Z"
},
{
"status": "in_transit",
"created": "2023-01-10T04:30:11.222Z"
},
{
"status": "delivered",
"created": "2023-01-11T04:30:11.222Z"
},
{
"status": "received",
"created": "2023-01-12T04:30:11.222Z"
},
{
"status": "resulted",
"created": "2023-01-13T04:30:11.222Z"
}
],
"type": "adx100",
"shipments": [
{
"tracking_number": "9400123456789999876500",
"carrier": "usps",
"created": "2023-01-01T04:30:11.222Z"
}
],
"panels": [
"PANEL-123"
],
"reports": [
{
"report_id": "<string>",
"results": [
{
"result_type": "quantity",
"name": "HDL Cholesterol",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": 123,
"unit_of_measure": "mg/dL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "quantity",
"name": "Vitamin B12",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "<10",
"unit_of_measure": "pg/mL",
"range_minimum": 20,
"range_maximum": 200,
"comments": null
},
{
"result_type": "reactivity",
"name": "Chlamydia",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "negative",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
},
{
"result_type": "genotype",
"name": "rs1234567",
"time_collected": "2023-01-14T04:30:11.222Z",
"result": "TT",
"unit_of_measure": null,
"range_minimum": null,
"range_maximum": null,
"comments": null
}
],
"pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
"txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt",
"date_collected": "2023-11-07T05:31:56Z",
"date_received": "2023-11-07T05:31:56Z",
"date_resulted": "2023-11-07T05:31:56Z",
"is_amendment": true
}
]
}
}
],
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z",
"metadata": {}
}