Update order metadata
Replace the metadata for an order with a new set of values
Token-based authentication with required prefix "Token"
The ID of the order to retrieve.
The metadata to replace the existing metadata with.
curl --request POST \
--url https://app.spotdx.com/api/v2/orders/{public_id}/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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": [
{
"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
Token-based authentication with required prefix "Token"
Path Parameters
The ID of the order to retrieve.
Body
The metadata to replace the existing metadata with.
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.
The date and time the order was created.
The date and time the order was last updated.
An optional dictionary of key-value pairs stored with the order.
curl --request POST \
--url https://app.spotdx.com/api/v2/orders/{public_id}/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"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": [
{
"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": {}
}