Skip to main content
POST
/
api
/
v2
/
orders
/
cURL
curl --request POST \
  --url https://app.spotdx.com/api/v2/orders/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "kit_types": [
    "health_kit_1"
  ],
  "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"
    }
  },
  "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": [],
  "created": "2023-01-01T04:30:11.222Z",
  "updated": "2023-01-01T04:30:11.222Z",
  "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": [],
  "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
​
metadata
object | null

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
​
kit_types
string[]

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

Example:
["health_kit_1"]
​
kits
object[]
Example:
[]
​
metadata
object | null

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

Example:
{ "some_key": "some_value" }
⌘I