Spot

https://docs.spotdx.com/
Admin
Spot provides a fully branded, end-to-end solution for health and wellness companies to offer...
Tokens:28,014
Snippets:75
Trust Score:6.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Order Response

Source: https://docs.spotdx.com/reference/list-orders

Provides an example of the JSON response when listing orders. This structure includes details such as order ID, status, recipient information, and timestamps for creation and updates.

```json
[
  {
    "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"
      }
    },
    "created": "2023-01-01T04:30:11.222Z",
    "updated": "2023-01-01T04:30:11.222Z"
  }
]
```

--------------------------------

### Get Spotdx Kit by ID

Source: https://docs.spotdx.com/reference/get-order

This section explains how to fetch details for a specific kit using its unique identifier through the Spotdx API. It outlines the request format for retrieving individual kit information.

```HTTP
GET /kits/{kit_id}
```

--------------------------------

### Create Spotdx Order

Source: https://docs.spotdx.com/reference/get-order

This section details how to create a new order using the Spotdx API. It outlines the necessary request format and parameters for successful order creation.

```HTTP
POST /orders

Request Body:
{
  "order_details": {
    "customer_id": "cust_123",
    "sample_type": "blood",
    "kit_id": "kit_abc"
  }
}
```

--------------------------------

### Get Spotdx Requisition

Source: https://docs.spotdx.com/reference/get-order

This section explains how to fetch details for a specific requisition using its identifier via the Spotdx API. It covers the request method and the expected response structure.

```HTTP
GET /requisitions/{requisition_id}
```

--------------------------------

### List Orders using cURL

Source: https://docs.spotdx.com/reference/list-orders

Demonstrates how to retrieve a list of orders using a cURL command. It includes the necessary GET request to the /api/v2/orders/ endpoint and shows an example of the expected JSON response structure.

```curl
curl --request GET \
  --url https://app.spotdx.com/api/v2/orders/ \
  --header 'Authorization: <api-key>'
```

--------------------------------

### Create Spotdx Requisition

Source: https://docs.spotdx.com/reference/get-order

This section describes the process of creating a new requisition within the Spotdx system via the API. It includes information on the required payload for requisition submission.

```HTTP
POST /requisitions
```

--------------------------------

### List Spotdx Kits

Source: https://docs.spotdx.com/reference/get-order

This section details how to retrieve a list of available kits from the Spotdx platform using the API. It may include parameters for filtering kits by type or status.

```HTTP
GET /kits
```

--------------------------------

### Get Requisition API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint retrieves the details of a specific requisition using its unique identifier. It provides information about the requisition's status and associated sample.

```HTTP
GET /requisitions/{id}
```

--------------------------------

### SpotDX Order Creation Response

Source: https://docs.spotdx.com/reference/create-order

Example response for creating a SpotDX order. Includes the generated order ID, status, recipient details, kit types, creation and update timestamps, and any associated metadata.

```json
{
  "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"
  }
}
```

--------------------------------

### Get Kit by ID API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint retrieves the details of a specific kit using its unique identifier. It includes information about the kit's lifecycle and current status.

```HTTP
GET /kits/{id}
```

--------------------------------

### Get Kit by ID (cURL)

Source: https://docs.spotdx.com/reference/get-kit

Retrieves a specific kit using its public ID via a GET request. Requires an API key for authorization. The response includes detailed information about the kit, its status, events, shipment details, and associated patient and sample data.

```cURL
curl --request GET \
  --url https://app.spotdx.com/api/v2/kits/{public_id}/ \
  --header 'Authorization: <api-key>'
```

--------------------------------

### List Spotdx Orders

Source: https://docs.spotdx.com/reference/get-order

This section describes how to fetch a list of all orders within the Spotdx system using the API. It covers the request parameters that can be used for filtering or pagination.

```HTTP
GET /orders
```

--------------------------------

### Get Kit by ID API

Source: https://docs.spotdx.com/docs/concepts

Fetches details of a specific kit using its unique identifier. Useful for examining the properties and status of a particular kit.

```HTTP
GET
/kits/{kitId}
```

--------------------------------

### Get Order by ID API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint retrieves the details of a specific order using its unique identifier. It provides information about the order's status and associated kits.

```HTTP
GET /orders/{id}
```

--------------------------------

### SpotDX Order Response Example

Source: https://docs.spotdx.com/reference/update-order-metadata

This JSON object represents a successful response for a SpotDX order. It includes comprehensive details about the order, recipient, kit status, sample information, and test results.

```JSON
{
  "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": [
    {
      "kit_id": "SPOT123456",
      "type": "health_kit_1",
      "status": "preparing",
      "events": [
        {
          "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"
        }
      ],
      "shipment_to_customer": {
        "tracking_number": "9400123456789999876500",
        "carrier": "usps",
        "created": "2023-01-01T04:30:11.222Z"
      },
      "registered_to": {
        "patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
        "first_name": "Alice",
        "last_name": "Smith",
        "date_of_birth": "1990-01-01",
        "sex": "F",
        "email": "alice123@gmail.com",
        "phone": "1234567890"
      },
      "sample": {
        "sample_id": "SPOT654321",
        "status": "awaiting_collection",
        "events": [
          {
            "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"
          }
        ],
        "type": "adx100",
        "shipments": [
          {
            "tracking_number": "9400123456789999876500",
            "carrier": "usps",
            "created": "2023-01-01T04:30:11.222Z"
          }
        ],
        "panels": [
          "PANEL-123"
        ],
        "reports": [
          {
            "report_id": "<string>",
            "results": [
              {
                "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
              }
            ],
            "pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
            "txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt",
            "date_collected": "2023-11-07T05:31:56Z",
            "date_received": "2023-11-07T05:31:56Z",
            "date_resulted": "2023-11-07T05:31:56Z",
            "is_amendment": false
          }
        ]
      }
    }
  ],
  "created": "2023-01-01T04:30:11.222Z",
  "updated": "2023-01-01T04:30:11.222Z",
  "metadata": null
}
```

--------------------------------

### List Spotdx Requisitions

Source: https://docs.spotdx.com/reference/get-order

This section details how to retrieve a list of requisitions using the Spotdx API. It may support filtering or sorting parameters to manage the returned requisition data.

```HTTP
GET /requisitions
```

--------------------------------

### Authenticate Spot API Request

Source: https://docs.spotdx.com/docs/authentication

This snippet demonstrates the correct format for including your API key in the Authorization header for Spot API requests. The API key should be prefixed with 'Token '.

```json
{
  "Authorization": "Token API_KEY_HERE"
}
```

--------------------------------

### SpotDx Order Response JSON

Source: https://docs.spotdx.com/reference/get-order

This is a sample JSON response for a successful order retrieval. It includes comprehensive details about the order, recipient, kit information, sample status, and results.

```json
{
  "order_id": "O1234567",
  "status": "completed",
  "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": [
    {
      "kit_id": "SPOT123456",
      "type": "health_kit_1",
      "status": "preparing",
      "events": [
        {
          "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"
        }
      ],
      "shipment_to_customer": {
        "tracking_number": "9400123456789999876500",
        "carrier": "usps",
        "created": "2023-01-01T04:30:11.222Z"
      },
      "registered_to": {
        "patient_id": "7563e8e2-7fbd-480c-9b8b-2070eda884bf",
        "first_name": "Alice",
        "last_name": "Smith",
        "date_of_birth": "1990-01-01",
        "sex": "F",
        "email": "alice123@gmail.com",
        "phone": "1234567890"
      },
      "sample": {
        "sample_id": "SPOT654321",
        "status": "resulted",
        "events": [
          {
            "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"
          }
        ],
        "type": "adx100",
        "shipments": [
          {
            "tracking_number": "9400123456789999876500",
            "carrier": "usps",
            "created": "2023-01-01T04:30:11.222Z"
          }
        ],
        "panels": [
          "PANEL-123"
        ],
        "reports": [
          {
            "report_id": "<string>",
            "results": [
              {
                "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
              }
            ],
            "pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
            "txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt",
            "date_collected": "2023-11-07T05:31:56Z",
            "date_received": "2023-11-07T05:31:56Z",
            "date_resulted": "2023-11-07T05:31:56Z",
            "is_amendment": true
          }
        ]
      }
    }
  ],
  "created": "2023-01-01T04:30:11.222Z",
  "updated": "2023-01-01T04:30:11.222Z",
  "metadata": {}
}
```

--------------------------------

### Get Order by ID using cURL

Source: https://docs.spotdx.com/reference/get-order

This snippet demonstrates how to retrieve order details by its public ID using a cURL command. It requires an API key for authorization and specifies the GET request to the /api/v2/orders/{public_id}/ endpoint.

```bash
curl --request GET \
  --url https://app.spotdx.com/api/v2/orders/{public_id}/ \
  --header 'Authorization: <api-key>'
```

--------------------------------

### List Kits API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint retrieves a list of all kits managed within the Spot DX system. It provides an overview of available kits and their statuses.

```HTTP
GET /kits
```

--------------------------------

### List Kits API

Source: https://docs.spotdx.com/docs/concepts

Retrieves a list of all available kits within the Spot system. Provides an overview of the kit inventory.

```HTTP
GET
/kits
```

--------------------------------

### Create Requisition API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint allows for the creation of a new requisition, which is essential for the sample collection process. Requisitions are linked to kits.

```HTTP
POST /requisitions
```

--------------------------------

### Create Order API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint allows for the creation of a new order within the Spot DX system. Orders are the top-level objects and can contain multiple kits.

```HTTP
POST /orders
```

--------------------------------

### Get Spotdx Order by ID

Source: https://docs.spotdx.com/reference/get-order

This section explains how to retrieve specific order details using the Spotdx API by providing the order's unique identifier. It details the request method and expected response format.

```HTTP
GET /orders/{order_id}
```

--------------------------------

### Create a New Order

Source: https://docs.spotdx.com/docs/quickstart

This snippet demonstrates how to create a new order via the Spotdx API. It includes the endpoint URL and the JSON payload required, specifying kit types, recipient details, and optional metadata.

```http
POST https://app.spotdx.com/api/v2/orders/
```

```json
{
  "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"
  }
}
```

--------------------------------

### Shopify Integration Guide

Source: https://docs.spotdx.com/docs/integrations

This guide details the steps to integrate Shopify with Spot DX. It covers creating an ecommerce integration, mapping SKUs, configuring webhooks for order notifications, and setting up Shopify's checkout to require an email address.

```Shopify
1. Log in at https://app.spotdx.com/manage and select Ecommerce in the sidebar. Create a new ecommerce integration by clicking the plus button.
2. Map Shopify product SKUs to Spot kit types in the SKU mappings section.
3. Copy the webhook URL from the Spot management portal.
4. In Shopify admin, go to Settings > Notifications > Webhooks.
5. Create a new webhook, paste the Spot webhook URL, and select 'Order payment' as the event.
6. Ensure Shopify checkout requires an email address (Settings > Checkout > Customer contact method).
7. Place a test order to confirm the integration.
```

--------------------------------

### Create Requisition

Source: https://docs.spotdx.com/reference/get-kit

This section describes the process of creating a requisition for kits within the SpotDX system. It outlines the expected request parameters and the structure of the response.

```json
{
  "kit_id": "SPOT123456",
  "type": "health_kit_1",
  "status": "preparing"
}
```

--------------------------------

### List Requisitions - Spot API

Source: https://docs.spotdx.com/docs/requisitions

This snippet shows how to list all requisitions using the Spot API. This is useful for tracking the status and details of multiple requisitions.

```bash
curl -X GET "https://api.spot.com/v1/requisitions"
```

--------------------------------

### Create Order API

Source: https://docs.spotdx.com/docs/concepts

Allows for the creation of a new order within the Spot system. This is a fundamental operation for initiating a request for kits.

```HTTP
POST
/orders
```

--------------------------------

### Get Requisition API

Source: https://docs.spotdx.com/docs/concepts

Fetches details of a specific requisition using its unique identifier. Provides information on the status and details of a requisition.

```HTTP
GET
/requisitions/{requisitionId}
```

--------------------------------

### Create Requisition API

Source: https://docs.spotdx.com/docs/concepts

Allows for the creation of a new requisition, likely related to sample processing or kit fulfillment. This is a key step in the sample lifecycle.

```HTTP
POST
/requisitions
```

--------------------------------

### Get Order by ID API

Source: https://docs.spotdx.com/docs/concepts

Fetches details of a specific order using its unique identifier. Essential for retrieving the status or information of a single order.

```HTTP
GET
/orders/{orderId}
```

--------------------------------

### List Requisitions API

Source: https://docs.spotdx.com/docs/concepts

Retrieves a list of all existing requisitions. Useful for tracking and managing sample-related requests.

```HTTP
GET
/requisitions
```

--------------------------------

### List Orders API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint retrieves a list of all orders in the Spot DX system. It is useful for tracking the status and details of multiple orders.

```HTTP
GET /orders
```

--------------------------------

### Create Patient API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint allows for the creation of a new patient record in the Spot DX system. Patient information is crucial for linking samples and orders.

```HTTP
POST /patients
```

--------------------------------

### Create SpotDX Order

Source: https://docs.spotdx.com/reference/create-order

Creates a new order for delivering kits to a client. The order is initialized with a 'pending' status and the requestor is set as the 'placed_by' user. Requires an API key for authorization and specifies kit types and recipient details.

```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" \
  } \
}'
```

--------------------------------

### List Requisitions API

Source: https://docs.spotdx.com/docs/sample-kit-lifecycle

This API endpoint retrieves a list of all requisitions in the Spot DX system. It is useful for tracking the status of sample collection requests.

```HTTP
GET /requisitions
```

--------------------------------

### Create Requisition - Spot API

Source: https://docs.spotdx.com/docs/requisitions

This snippet demonstrates how to create a new requisition using the Spot API. It requires providing sample barcode, patient registration data, and tracking information. The API handles logistics, compliance, and results, returning updates via webhook or allowing polling.

```json
{
  "sample_barcode": "string",
  "patient_data": {},
  "tracking_info": {}
}
```

--------------------------------

### Get Requisition by ID (cURL)

Source: https://docs.spotdx.com/reference/get-requisition

This snippet demonstrates how to retrieve requisition details using the SpotDX API. It requires an API key for authorization and specifies the requisition ID in the URL.

```bash
curl --request GET \
  --url https://app.spotdx.com/api/v2/requisitions/{id} \
  --header 'Authorization: <api-key>'
```

--------------------------------

### Order Response Structure

Source: https://docs.spotdx.com/reference/get-order

This snippet details the structure of a successful order response from the Spotdx API. It includes fields like order_id, status, recipient information, kit types, and timestamps.

```json
{
  "order_id": "O1234567",
  "status": "completed",
  "recipient": {
    "first_name": "Alice",
    "last_name": "Smith",
    "email": "alice123@gmail.com",
    "phone": "1234567890",
    "address": {}
  },
  "kit_types": [
    "health_kit_1"
  ],
  "kits": [],
  "created": "2023-01-01T04:30:11.222Z",
  "updated": "2023-01-01T04:30:11.222Z",
  "metadata": null
}
```

--------------------------------

### Update Spotdx Order Metadata

Source: https://docs.spotdx.com/reference/get-order

This section provides guidance on updating metadata associated with an existing order via the Spotdx API. It specifies the endpoint and the structure of the data to be sent for updates.

```HTTP
POST /orders/update_metadata
```
Tokens:
Raw