API Reference - Requisitions
Create requisition
Advanced Guides
Integrations
API Reference - Orders
API Reference - Kits
API Reference - Requisitions
API Reference - Registration
API Reference - Requisitions
Create requisition
Create a new requisition.
POST
/
api
/
v2
/
requisitions
curl --request POST \
--url https://app.spotdx.com/api/v2/requisitions/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"barcode": "19742938328",
"panels": [
"PANEL-123"
],
"account_number": "1234567890",
"lab": "CRL",
"state_collected": "OH",
"patient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"sex": "F",
"date_of_birth": "2023-12-25",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"tracking": {
"tracking_number": "9400123456789999876500",
"carrier": "usps"
},
"attributes": {
"crl_slip_id": "1234567890"
},
"metadata": {
"some_key": "some_value"
}
}'
{
"requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
"barcode": "19742938328",
"account_number": "1234567890",
"panels": ["PANEL-123"],
"state_collected": "OH",
"patient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"sex": "F",
"date_of_birth": "2023-02-01",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"tracking": {
"tracking_number": "9400123456789999876500",
"carrier": "usps"
},
"status": "approved",
"events": [
{
"event": "created",
"date": "2020-01-01T00:00:00Z"
},
{
"event": "approved",
"date": "2020-01-01T00:00:00Z"
}
],
"reports": [],
"metadata": null
}
Access to requisitioning is disabled by default. To enable it, talk to us and we’ll get you set up
After creating a new requisition, we will immediately respond with an approved or denied status code.
{
"requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
"barcode": "19742938328",
"account_number": "1234567890",
"panels": ["PANEL-123"],
"state_collected": "OH",
"patient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"sex": "F",
"date_of_birth": "2023-02-01",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"tracking": {
"tracking_number": "9400123456789999876500",
"carrier": "usps"
},
"status": "approved",
"events": [
{
"event": "created",
"date": "2020-01-01T00:00:00Z"
},
{
"event": "approved",
"date": "2020-01-01T00:00:00Z"
}
],
"reports": [],
"metadata": null
}
Authorizations
Token-based authentication with required prefix "Token"
Body
application/json
Response
200
application/json
The response is of type object
.
curl --request POST \
--url https://app.spotdx.com/api/v2/requisitions/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"barcode": "19742938328",
"panels": [
"PANEL-123"
],
"account_number": "1234567890",
"lab": "CRL",
"state_collected": "OH",
"patient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"sex": "F",
"date_of_birth": "2023-12-25",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"tracking": {
"tracking_number": "9400123456789999876500",
"carrier": "usps"
},
"attributes": {
"crl_slip_id": "1234567890"
},
"metadata": {
"some_key": "some_value"
}
}'
{
"requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
"barcode": "19742938328",
"account_number": "1234567890",
"panels": ["PANEL-123"],
"state_collected": "OH",
"patient": {
"first_name": "Alice",
"last_name": "Smith",
"email": "alice123@gmail.com",
"phone": "1234567890",
"sex": "F",
"date_of_birth": "2023-02-01",
"address": {
"street1": "123 Main St",
"street2": "Apt 1",
"city": "San Francisco",
"state": "CA",
"country": "US",
"zip": "94105"
}
},
"tracking": {
"tracking_number": "9400123456789999876500",
"carrier": "usps"
},
"status": "approved",
"events": [
{
"event": "created",
"date": "2020-01-01T00:00:00Z"
},
{
"event": "approved",
"date": "2020-01-01T00:00:00Z"
}
],
"reports": [],
"metadata": null
}