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.
Token-based authentication with required prefix "Token"
A list of all the kit types to place in the order.
Recipient's first name.
Recipient's last name.
Recipient's email.
Recipient's phone number, as a string.
Recipient's address.
Second line of recipient's address.
Recipient's city of residence.
Recipient's state of residence.
Recipient's country of residence.
Recipient's zip code.
An optional dictionary of key-value pairs stored with the order.
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"
}
}
Authorizations
Token-based authentication with required prefix "Token"
Body
A list of all the kit types to place in the order.
Recipient's first name.
Recipient's last name.
Recipient's email.
Recipient's phone number, as a string.
Recipient's address.
Second line of recipient's address.
Recipient's city of residence.
Recipient's state of residence.
Recipient's country of residence.
US, CA Recipient's zip code.
An optional dictionary of key-value pairs stored with the order.
Response
The unique identifier of the order.
pending, in_progress, completed, canceled Recipient's first name.
Recipient's last name.
Recipient's email.
Recipient's phone number, as a string.
Recipient's address.
Second line of recipient's address.
Recipient's city of residence.
Recipient's state of residence.
Recipient's country of residence.
US, CA Recipient's zip code.
A list of the kit types that are included in this order.
The unique identifier of the kit.
The kit's type
The new status of the kit.
preparing, in_transit, delivered, delivery_exception, registered, canceled A list of all the events that have occurred for this kit.
The new status of the kit.
preparing, in_transit, delivered, delivery_exception, registered, canceled The date and time the event occurred.
fedex, ups, usps M, F 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 adx100, adx100_2, adx100_4, whatman903_10, dry_transport_swab, hemaspot_hf, saliva_3 fedex, ups, usps The panel codes of the test being performed on the sample. We'll create these with you during onboarding.
quantity The biomarker that was analyzed.
A URL to the PDF report.
A URL to the TXT report.
Whether this report is an amendment to a previous report.
An optional dictionary of key-value pairs stored with the order.
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"
}
}