Create order

{
  "order_id": "O1234567",
  "status": "pending",
  "recipient": {
    "first_name": "Alice",
    "last_name": "Smith",
    "email": "[email protected]",
    "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

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Body

kit_types

string[]

required

A list of all the kit types to place in the order.

Example:

["health_kit_1"]

recipient

object

required

Show child attributes

recipient.first_name

string

required

Recipient's first name.

Example:

"Alice"

recipient.last_name

string

required

Recipient's last name.

Example:

"Smith"

recipient.email

string

required

Recipient's email.

Example:

"[email protected]"

recipient.phone

string

required

Recipient's phone number, as a string.

Example:

"1234567890"

recipient.address

object

required

Show child attributes

recipient.address.street1

string

required

Recipient's address.

Example:

"123 Main St"

recipient.address.city

string

required

Recipient's city of residence.

Example:

"San Francisco"

recipient.address.state

string

required

Recipient's state of residence.

Example:

"CA"

recipient.address.country

enum<string>

required

Recipient's country of residence.

Available options:

US,

CA

Example:

"US"

recipient.address.zip

string

required

Recipient's zip code.

Example:

"94105"

recipient.address.street2

string | null

Second line of recipient's address.

Example:

"Apt 1"

metadata

object

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

Example:

{ "some_key": "some_value" }

Response

order_id

string

The unique identifier of the order.

Example:

"O1234567"

created

string<date-time>

Example:

"2023-01-01T04:30:11.222Z"

status

enum<string>

Available options:

pending,

in_progress,

completed,

canceled

recipient

object

Show child attributes

recipient.first_name

string

required

Recipient's first name.

Example:

"Alice"

recipient.last_name

string

required

Recipient's last name.

Example:

"Smith"

recipient.email

string

required

Recipient's email.

Example:

"[email protected]"

recipient.phone

string

required

Recipient's phone number, as a string.

Example:

"1234567890"

recipient.address

object

required

Show child attributes

recipient.address.street1

string

required

Recipient's address.

Example:

"123 Main St"

recipient.address.city

string

required

Recipient's city of residence.

Example:

"San Francisco"

recipient.address.state

string

required

Recipient's state of residence.

Example:

"CA"

recipient.address.country

enum<string>

required

Recipient's country of residence.

Available options:

US,

CA

Example:

"US"

recipient.address.zip

string

required

Recipient's zip code.

Example:

"94105"

recipient.address.street2

string | null

Second line of recipient's address.

Example:

"Apt 1"

kit_types

string[]

A list of the kit types that are included in this order.

Example:

["health_kit_1"]

kits

object[]

Show child attributes

kits.kit_id

string

The unique identifier of the kit.

Example:

"SPOT123456"

kits.type

string

The kit's type

Example:

"health_kit_1"

kits.status

enum<string>

The new status of the kit.

Available options:

preparing,

in_transit,

delivered,

delivery_exception,

registered,

canceled

Example:

"preparing"

kits.events

object[]

A list of all the events that have occurred for this kit.

Show child attributes

kits.events.status

enum<string>

The new status of the kit.

Available options:

preparing,

in_transit,

delivered,

delivery_exception,

registered,

canceled

Example:

"preparing"

kits.events.created

string<date-time>

The date and time the event occurred.

Example:

"2023-01-01T04:30:11.222Z"

Example:

[
  {
    "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"
  }
]

kits.shipment_to_customer

object

Show child attributes

kits.shipment_to_customer.tracking_number

string | null

Example:

"9400123456789999876500"

kits.shipment_to_customer.carrier

enum<string> | null

Available options:

fedex,

ups,

usps

Example:

"usps"

kits.shipment_to_customer.created

string<date-time>

Example:

"2023-01-01T04:30:11.222Z"

kits.registered_to

object

Show child attributes

kits.registered_to.patient_id

string<uuid>

Example:

"7563e8e2-7fbd-480c-9b8b-2070eda884bf"

kits.registered_to.first_name

string

Example:

"Alice"

kits.registered_to.last_name

string

Example:

"Smith"

kits.registered_to.date_of_birth

string<date>

Example:

"1990-01-01"

kits.registered_to.sex

enum<string>

Available options:

M,

F

Example:

"F"

kits.registered_to.email

string

Example:

"[email protected]"

kits.registered_to.phone

string

Example:

"1234567890"

kits.sample

object

Show child attributes

kits.sample.sample_id

string

Example:

"SPOT654321"

kits.sample.status

enum<string>

The new status of the sample.

Available options:

awaiting_collection,

collection_exception,

delivery_exception,

delivered,

in_transit,

received,

resulted,

partially_resulted,

extra_quality_checks,

canceled

kits.sample.events

object[]

Show child attributes

kits.sample.events.status

enum<string>

The new status of the sample.

Available options:

awaiting_collection,

collection_exception,

delivery_exception,

delivered,

in_transit,

received,

resulted,

partially_resulted,

extra_quality_checks,

canceled

kits.sample.events.created

string<date-time>

Example:

"2023-01-01T04:30:11.222Z"

Example:

[
  {
    "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"
  }
]

kits.sample.type

enum<string>

Available options:

adx100,

adx100_2,

adx100_4,

whatman903_10,

dry_transport_swab,

hemaspot_hf,

saliva_3

Example:

"adx100"

kits.sample.shipments

object[]

Show child attributes

kits.sample.shipments.tracking_number

string | null

Example:

"9400123456789999876500"

kits.sample.shipments.carrier

enum<string> | null

Available options:

fedex,

ups,

usps

Example:

"usps"

kits.sample.shipments.created

string<date-time>

Example:

"2023-01-01T04:30:11.222Z"

kits.sample.panels

string[]

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

Example:

["PANEL-123"]

kits.sample.reports

(object | null)[]

Show child attributes

kits.sample.reports.report_id

string

kits.sample.reports.results

object[]

Option 1
Option 2
Option 3

Show child attributes

kits.sample.reports.results.result_type

enum<string>

Available options:

quantity

kits.sample.reports.results.name

string

The biomarker that was analyzed.

kits.sample.reports.results.time_collected

string<date-time>

kits.sample.reports.results.result

kits.sample.reports.results.unit_of_measure

string | null

kits.sample.reports.results.range_minimum

string

kits.sample.reports.results.range_maximum

number

Required range: x >= 0

kits.sample.reports.results.comments

string | null

Example:

[
  {
    "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
  }
]

kits.sample.reports.pdf

string<url> | null

A URL to the PDF report.

Example:

"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf"

kits.sample.reports.txt

string<url> | null

A URL to the TXT report.

Example:

"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"

kits.sample.reports.date_collected

string<date-time>

kits.sample.reports.date_received

string<date-time>

kits.sample.reports.date_resulted

string<date-time>

kits.sample.reports.is_amendment

boolean

Whether this report is an amendment to a previous report.

Example:

false

Example:

[]

metadata

object

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

Example:

{ "some_key": "some_value" }

Welcome

Basic Guides

Advanced Guides

Integrations

API Reference - Orders

API Reference - Kits

API Reference - Requisitions

API Reference - Registration

Create order

Authorizations

Body

Response