Spot home pagelight logo
  1. API Reference - Orders
  2. Create order
POST

/api/v2/orders/

kit_types*
recipient*
first_name
last_name
email
phone
address
metadata
curl --request POST \
     --url https://app.spotdx.com/api/v2/orders/ \
     --header 'Content-Type: application/json' \
     --data '{
 "kit_types": "array",
 "recipient": {
 }
}'
{
  "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"
  }
}

​
Body

recipientRequired
object
kit_typesRequired
string[]

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

metadata
object

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