Spot home pagelight logo
  1. API Reference - Requisitions
  2. Create requisition
POST

/api/v2/requisitions/

barcode*
panels*
account_number*
lab*
state_collected*
patient*
first_name
last_name
email
phone
sex
date_of_birth
address
tracking
metadata
curl --request POST \
     --url https://app.spotdx.com/api/v2/requisitions/ \
     --header 'Content-Type: application/json' \
     --data '{
 "barcode": "string",
 "panels": "array",
 "account_number": "string",
 "lab": "string",
 "state_collected": "string",
 "patient": {
 }
}'
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
}

​
Body

patientRequired
object
state_collectedRequired
string

The two letter code of the state where the sample was collected.

labRequired
string

The name of the lab that will process the sample.

account_numberRequired
string

The account number submitted to the lab.

panelsRequired
string[]

The panel codes of the test being performed on the sample. We'll create these with you during onboarding.

barcodeRequired
string

The barcode of the sample mailed to the lab. We use this to identify the sample from the lab report.

tracking
object
metadata
object

An optional dictionary of key-value pairs stored with the requisition.

​
Response

requisition_id
string

The ID of the requisition.

barcode
string

The full barcode of the sample mailed to the lab. Must be globally unique.

account_number
string

The account number submitted to the lab.

lab
string

The name of the lab that will process the sample.

panels
string[]

The panel codes of the test being performed on the sample. We'll create these with you during onboarding.

state_collected
string

The two letter code of the state where the sample was collected.

patient
object
tracking
object
status
string
Available options: created, approved, denied, delivered, received, extra_quality_checks, resulted, rejected, delivery_exception
events
array
reports
array
metadata
object

An optional dictionary of key-value pairs stored with the requisition.

created
string
updated
string