Preview Containers

GET

api

appointments

{id}

preview

curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'

{
  "containers": [
    {
      "type": "serum",
      "name": "Serum",
      "kind": "monovette",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "article_number": "01.1602.001",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "kind": "monovette",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "article_number": "04.1914.001",
      "count": 2
    },
    {
      "type": "glucose",
      "name": "Glucose",
      "kind": "monovette",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "article_number": "05.1074.001",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": {
    "retail": {
      "total_cents": 18852,
      "groups": [
        { "price_cents": 14900, "biomarker_ids": [43, 44, 51, 52] },
        {
          "price_cents": 3952,
          "biomarker_ids": [42],
          "goa_lines": [
            {
              "goa_code": "5812",
              "goa_base_cents": 982,
              "quantity": 3.5,
              "factor": 1.15,
              "amount_cents": 3952
            }
          ]
        }
      ]
    },
    "yours": {
      "total_cents": 14821,
      "groups": [
        { "price_cents": 11900, "biomarker_ids": [43, 44, 51, 52] },
        {
          "price_cents": 2921,
          "biomarker_ids": [42],
          "goa_lines": [
            {
              "goa_code": "5812",
              "goa_base_cents": 982,
              "quantity": 3.5,
              "factor": 0.85,
              "amount_cents": 2921
            }
          ]
        }
      ]
    }
  }
}

{
  "containers": [],
  "routing": null,
  "pricing": null
}

{
  "error": "Appointment not found"
}

Preview the specimen-collection containers required for an appointment based on its currently attached panels and biomarkers. This runs the logistics pipeline in preview mode — no orders are placed. Use this endpoint after adding panels or individual biomarkers to see what physical containers (blood tubes, and where applicable a dried-blood-spot card or urine cup) the practitioner needs to prepare for the sample collection.

pricing is the appointment’s whole-cart pricing — billing groups (each billed once) plus a total, at both the retail card and your API key’s own card. routing is intentionally always null.

Request

Path parameters

string

required

Unique identifier (UUID) of the appointment to preview container requirements for.

Response

On success, the API returns 200 OK with the container requirements and reserved fields for future use.

object[]

required

Array of required specimen-collection containers. Empty when no panels or biomarkers have been added to the appointment.

Show container

string

Container type identifier. One of serum, edta, citrate, lihep, glucose, homocysteine, urine, or dried_blood_spot.

string

Human-readable container name (e.g., “Serum”, “EDTA”, “Li-Heparin”).

string

Physical form of the container. One of monovette, dbs_card, or urine_cup.

string

Hex color code of the container cap for display (e.g., "#A0784B").

string

Volume capacity of the container (e.g., "7.5 ml").

string

Sarstedt catalog number (REF), when known (e.g., "01.1602.001"). Omitted for containers without a mapped article number.

integer

Number of containers of this type required.

null

Lab routing details — intentionally not exposed, always null.

object | null

Whole-cart pricing for the appointment, or null when it has no location or no attached tests, or when your key lacks the prices_view scope. Carries retail and yours, each a price breakdown (total_cents + billing groups, each billed once across the whole appointment, with the biomarker_ids each group delivers).

Error responses

Status	Description
`400`	Invalid ID format — the provided value is not a valid UUID.
`403`	Forbidden — your API key does not have access to this operation.
`404`	Appointment not found.
`500`	Internal server error.

curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'

{
  "containers": [
    {
      "type": "serum",
      "name": "Serum",
      "kind": "monovette",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "article_number": "01.1602.001",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "kind": "monovette",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "article_number": "04.1914.001",
      "count": 2
    },
    {
      "type": "glucose",
      "name": "Glucose",
      "kind": "monovette",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "article_number": "05.1074.001",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": {
    "retail": {
      "total_cents": 18852,
      "groups": [
        { "price_cents": 14900, "biomarker_ids": [43, 44, 51, 52] },
        {
          "price_cents": 3952,
          "biomarker_ids": [42],
          "goa_lines": [
            {
              "goa_code": "5812",
              "goa_base_cents": 982,
              "quantity": 3.5,
              "factor": 1.15,
              "amount_cents": 3952
            }
          ]
        }
      ]
    },
    "yours": {
      "total_cents": 14821,
      "groups": [
        { "price_cents": 11900, "biomarker_ids": [43, 44, 51, 52] },
        {
          "price_cents": 2921,
          "biomarker_ids": [42],
          "goa_lines": [
            {
              "goa_code": "5812",
              "goa_base_cents": 982,
              "quantity": 3.5,
              "factor": 0.85,
              "amount_cents": 2921
            }
          ]
        }
      ]
    }
  }
}

{
  "containers": [],
  "routing": null,
  "pricing": null
}

{
  "error": "Appointment not found"
}

Remove Individual Biomarkers

Confirm Blood Draw

curl --request GET \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/preview \
  --header 'x-api-key: YOUR_API_KEY'

{
  "containers": [
    {
      "type": "serum",
      "name": "Serum",
      "kind": "monovette",
      "cap_color": "#A0784B",
      "volume": "7.5 ml",
      "article_number": "01.1602.001",
      "count": 3
    },
    {
      "type": "edta",
      "name": "EDTA",
      "kind": "monovette",
      "cap_color": "#D13438",
      "volume": "3.4 ml",
      "article_number": "04.1914.001",
      "count": 2
    },
    {
      "type": "glucose",
      "name": "Glucose",
      "kind": "monovette",
      "cap_color": "#9E9E9E",
      "volume": "3.1 ml",
      "article_number": "05.1074.001",
      "count": 1
    }
  ],
  "routing": null,
  "pricing": {
    "retail": {
      "total_cents": 18852,
      "groups": [
        { "price_cents": 14900, "biomarker_ids": [43, 44, 51, 52] },
        {
          "price_cents": 3952,
          "biomarker_ids": [42],
          "goa_lines": [
            {
              "goa_code": "5812",
              "goa_base_cents": 982,
              "quantity": 3.5,
              "factor": 1.15,
              "amount_cents": 3952
            }
          ]
        }
      ]
    },
    "yours": {
      "total_cents": 14821,
      "groups": [
        { "price_cents": 11900, "biomarker_ids": [43, 44, 51, 52] },
        {
          "price_cents": 2921,
          "biomarker_ids": [42],
          "goa_lines": [
            {
              "goa_code": "5812",
              "goa_base_cents": 982,
              "quantity": 3.5,
              "factor": 0.85,
              "amount_cents": 2921
            }
          ]
        }
      ]
    }
  }
}

{
  "containers": [],
  "routing": null,
  "pricing": null
}

{
  "error": "Appointment not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Preview Containers

Request

Path parameters

Response

Error responses

​Request

​Path parameters

​Response

​Error responses

Request

Path parameters

Response

Error responses