---
title: "Schedule an appointment for an order"
method: POST
path: "/v1/orders/{orderId}/schedule-appointment"
tags: ["Orders"]
---

# Schedule an appointment for an order

`POST /v1/orders/{orderId}/schedule-appointment`

## Request

- Base URL: `https://api.bluehive.com`
- URL: `https://api.bluehive.com/v1/orders/{orderId}/schedule-appointment`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bluehive-health/apis/bluehive-api/docs/v1/orders/:orderId/schedule-appointment/post.ts> (a function with typed inputs; its response is checked against the schema)

Schedule an appointment or walk-in for an existing order. Sends HL7 SIU^S12 message for appointment booking.

## Path parameters

- `orderId` string, required

## Request body

- object
  - `appointment` union, required
    - object
      - `type` 'appointment', required
      - `dateTime` string, date-time, required: Required for appointment type
      - `date` string, required: Required for appointment type
      - `time` string, required: Required for appointment type
      - `notes` string: Optional for walkin type
    - object
      - `type` 'walkin', required
      - `dateTime` string, date-time: Required for appointment type
      - `date` string: Required for appointment type
      - `time` string: Required for appointment type
      - `notes` string: Optional for walkin type
  - `orderAccessCode` string: Order access code for authorization
  - `providerId` string: Provider ID for authorization

## Response `200`

Default Response

- object
  - `success` boolean, required
  - `message` string, required

## Other responses

- `400`: Default Response
- `401`: Default Response
- `404`: Default Response
- `500`: Default Response

## Changes

- **2026-10-16** `a8bcbdf02e33`: 1 info
  - the request property `orderAccessCode` became optional
- **2026-03-24** `04faad8d5fe3`: 1 breaking
  - the request property `orderAccessCode` became required
- **2025-10-05** `28d439490b5e`: 1 info
  - the endpoint scheme security `ApiKeyAuth` was added to the API
- **2025-10-05** `3c4bce10c1fe`: 1 info
  - the endpoint scheme security `ApiKeyAuth` was removed from the API
- **2025-10-05** `28d439490b5e`: 1 info
  - the endpoint scheme security `ApiKeyAuth` was added to the API

[Operation history](https://skmtc.dev/bluehive-health/apis/bluehive-api/changes/v1/orders/:orderId/schedule-appointment/post.md)

---

[API](https://skmtc.dev/bluehive-health/apis/bluehive-api.md) - [All operations](https://skmtc.dev/bluehive-health/apis/bluehive-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluehive-health/apis/bluehive-api/revisions/a8bcbdf02e33?raw)