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.

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Body

application/json
barcode
string
required

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

panels
string[]
required

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

account_number
string
required

The account number submitted to the lab.

lab
string
required

The name of the lab that will process the sample.

state_collected
string
required

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

patient
object
required
tracking
object
attributes
object | null

An optional set of values that can be passed through to specific labs.

metadata
object | null

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

Response

200 - application/json
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
enum<string>
Available options:
created,
approved,
denied,
delivered,
received,
extra_quality_checks,
resulted,
rejected,
delivery_exception
events
object[]
reports
array
attributes
object | null

An optional set of values that can be passed through to specific labs.

metadata
object | null

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

created
string
updated
string
Get available kit typesList requisitions