Attach Shipments to Appointment

POST

api

appointments

{id}

shipments

curl --request POST \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/shipments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "shipment_ids": ["P2604154821"]
  }'

[
  {
    "id": "P2604154821",
    "status": "pending",
    "logistics_provider": "go",
    "tracking_number": null,
    "origin": null,
    "destination": null,
    "pickup": null,
    "notes": null,
    "status_updates": [],
    "appointments": [
      {
        "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
        "added_at": "2026-04-15T08:30:00Z"
      }
    ],
    "created_at": "2026-04-15T07:00:00Z",
    "updated_at": "2026-04-15T08:30:00Z"
  }
]

Attach one or more shipments to this appointment. Idempotent — shipments already linked are silently skipped. Mirror of Attach Appointments to Shipment. The mutation rule (per shipment) is: the link can be created when EITHER

the appointment is past blood-draw (blood_drawn), or
the shipment was created less than 24 hours ago.

Outside that window the call is rejected with 409 Conflict.

Request

Path parameters

string

required

Appointment UUID.

Body parameters

string[]

required

Array of shipment reference IDs to attach. Must contain at least one item.

Response

On success, the API returns 200 OK with the full shipment list for the appointment, ordered newest-first by creation. Each entry has the same shape as Get Shipment.

Error responses

Status	Description
`400`	Validation error — e.g., empty `shipment_ids` or malformed reference.
`403`	Forbidden — missing scope, appointment outside access context, or shipment outside access context.
`404`	Appointment not found, or one or more shipments not found.
`409`	Mutation rule failed — appointment not past blood-draw and at least one shipment is older than 24 hours. Response lists the IDs.
`500`	Internal server error.

curl --request POST \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/shipments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "shipment_ids": ["P2604154821"]
  }'

[
  {
    "id": "P2604154821",
    "status": "pending",
    "logistics_provider": "go",
    "tracking_number": null,
    "origin": null,
    "destination": null,
    "pickup": null,
    "notes": null,
    "status_updates": [],
    "appointments": [
      {
        "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
        "added_at": "2026-04-15T08:30:00Z"
      }
    ],
    "created_at": "2026-04-15T07:00:00Z",
    "updated_at": "2026-04-15T08:30:00Z"
  }
]

List Appointment Shipments

Detach Shipments from Appointment

curl --request POST \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a/shipments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "shipment_ids": ["P2604154821"]
  }'

[
  {
    "id": "P2604154821",
    "status": "pending",
    "logistics_provider": "go",
    "tracking_number": null,
    "origin": null,
    "destination": null,
    "pickup": null,
    "notes": null,
    "status_updates": [],
    "appointments": [
      {
        "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
        "added_at": "2026-04-15T08:30:00Z"
      }
    ],
    "created_at": "2026-04-15T07:00:00Z",
    "updated_at": "2026-04-15T08:30:00Z"
  }
]

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Attach Shipments to Appointment

Request

Path parameters

Body parameters

Response

Error responses

​Request

​Path parameters

​Body parameters

​Response

​Error responses

Request

Path parameters

Body parameters

Response

Error responses