Replace the metadata for an order with a new set of values

post/api/v2/orders/{public_id}/

Request

  • Base URL: https://app.spotdx.com
  • URL: https://app.spotdx.com/api/v2/orders/{public_id}/
  • Auth: API key in header Authorization

Path parameters

public_idstring required

The ID of the order to retrieve.

Request body

metadataobject

The metadata to replace the existing metadata with.

Example request

{
  "metadata": {
    "some_key": "some_value"
  }
}

Response

order_idstring

The unique identifier of the order.

status'pending' | 'in_progress' | 'completed' | 'canceled'
kit_typesstring[]

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

createdstring date-time

The date and time the order was created.

updatedstring date-time

The date and time the order was last updated.

metadataobject nullable

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

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.