Advanced Guides
Integrations
API Reference - Orders
API Reference - Kits
API Reference - Requisitions
API Reference - Registration
Create order
Create an order for delivering kits to a client, which will be created with a status of ‘pending’.The order will be created with the user making the request as the ‘placed_by’ user.
curl --request POST \
--url https://app.spotdx.com/api/v2/orders/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"kit_types": [
"health_kit_1"
],
"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"
}
},
"metadata": {
"some_key": "some_value"
}
}'{
"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": [],
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z",
"metadata": {
"some_key": "some_value"
}
}
{
"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": [],
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z",
"metadata": {
"some_key": "some_value"
}
}
Authorizations
Token-based authentication with required prefix "Token"
Body
A list of all the kit types to place in the order.
["health_kit_1"]
Recipient's first name.
"Alice"
Recipient's last name.
"Smith"
Recipient's email.
"alice123@gmail.com"
Recipient's phone number, as a string.
"1234567890"
Recipient's address.
"123 Main St"
Recipient's city of residence.
"San Francisco"
Recipient's state of residence.
"CA"
Recipient's country of residence.
US, CA "US"
Recipient's zip code.
"94105"
Second line of recipient's address.
"Apt 1"
An optional dictionary of key-value pairs stored with the order.
{ "some_key": "some_value" }
Response
The unique identifier of the order.
"O1234567"
"2023-01-01T04:30:11.222Z"
pending, in_progress, completed, canceled Recipient's first name.
"Alice"
Recipient's last name.
"Smith"
Recipient's email.
"alice123@gmail.com"
Recipient's phone number, as a string.
"1234567890"
Recipient's address.
"123 Main St"
Recipient's city of residence.
"San Francisco"
Recipient's state of residence.
"CA"
Recipient's country of residence.
US, CA "US"
Recipient's zip code.
"94105"
Second line of recipient's address.
"Apt 1"
A list of the kit types that are included in this order.
["health_kit_1"]
The unique identifier of the kit.
"SPOT123456"
The kit's type
"health_kit_1"
The new status of the kit.
preparing, in_transit, delivered, delivery_exception, registered, canceled "preparing"
A list of all the events that have occurred for this kit.
[
{
"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"
}
]
"7563e8e2-7fbd-480c-9b8b-2070eda884bf"
"Alice"
"Smith"
"1990-01-01"
M, F "F"
"alice123@gmail.com"
"1234567890"
"SPOT654321"
The new status of the sample.
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled The new status of the sample.
awaiting_collection, collection_exception, delivery_exception, delivered, in_transit, received, resulted, partially_resulted, extra_quality_checks, canceled "2023-01-01T04:30:11.222Z"
[
{
"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"
}
]
adx100, adx100_2, adx100_4, whatman903_10, dry_transport_swab, hemaspot_hf, saliva_3 "adx100"
The panel codes of the test being performed on the sample. We'll create these with you during onboarding.
["PANEL-123"]
quantity The biomarker that was analyzed.
x >= 0[
{
"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
}
]
A URL to the PDF report.
"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf"
A URL to the TXT report.
"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"
Whether this report is an amendment to a previous report.
false
[]
An optional dictionary of key-value pairs stored with the order.
{ "some_key": "some_value" }
curl --request POST \
--url https://app.spotdx.com/api/v2/orders/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"kit_types": [
"health_kit_1"
],
"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"
}
},
"metadata": {
"some_key": "some_value"
}
}'{
"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": [],
"created": "2023-01-01T04:30:11.222Z",
"updated": "2023-01-01T04:30:11.222Z",
"metadata": {
"some_key": "some_value"
}
}