> Agent-readable docs index: /llms.txt. Fetch only the needed Markdown pages first; use /docs.zip only for broad search after checking /docs-manifest.json or /docs.zip.sha256.

# 予約

予約とスケジュール関連のAPIです。

予約作成、予約変更、予約キャンセル、予約スロット照会、予約グループ、区域、スケジュール照会機能を提供します。

<details>
<summary>主要概念</summary>
<dl>
<dt>予約</dt>
<dd><strong>定義：</strong>患者が特定の時間にクリニックを訪問するために登録した日程リクエストです。<br /><strong>説明：</strong>予約作成・変更・キャンセルAPIの中心対象です。リクエスト時に患者情報、予約グループ、区域、開始／終了時刻、希望施術情報を併せて送信します。</dd>
<dt>スケジュール</dt>
<dd><strong>定義：</strong>予約をもとにクリニックの運営フローで管理される来院日程情報です。<br /><strong>説明：</strong>スケジュール照会APIでは、患者・予約・会計・施術進行情報など、実際の来院管理に必要な情報を合わせて確認できます。</dd>
<dt>予約スロット</dt>
<dd><strong>定義：</strong>予約を作成できる時間区間です。<br /><strong>説明：</strong>商品、予約グループ、既存スケジュールの条件に応じて利用可能な時間帯を照会した後、予約作成リクエストに使用します。</dd>
<dt>予約グループ</dt>
<dd><strong>定義：</strong>予約可能時間、区域、リソース、ポリシーをまとめて管理する予約単位です。<br /><strong>説明：</strong>どの予約グループで予約するかによって、照会されるスロットと予約可能な時間が異なる場合があります。</dd>
<dt>区域</dt>
<dd><strong>定義：</strong>予約やスケジュールが割り当てられるクリニック内のエリアです。<br /><strong>説明：</strong>予約作成およびスロット照会において、患者が訪問する空間やリソースが占有されるスペースを指定する際に使用します。</dd>
<dt>占有時間</dt>
<dd><strong>定義：</strong>特定の時間帯を予約可能範囲から除外したり、リソース使用時間として表示したりする情報です。<br /><strong>説明：</strong>占有時間を作成すると、その時間帯に予約を受け付けないよう制御できます。</dd>
<dt>来院段階</dt>
<dd><strong>定義：</strong>スケジュールが現在どの来院段階にあるかを示す段階です。<br /><strong>説明：</strong>予約、受付、カウンセリング、施術など、来院プロセスを基準にスケジュールを照会する際に使用します。</dd>
</dl>
</details>


## エンドポイント

- [予約キャンセル](/ja/docs/openapi/cancel-reservation.md): `POST /schedule/open/v1/commands/cancel-reservation`
- [診療ステップ変更](/ja/docs/openapi/change-flow-step.md): `POST /schedule/open/v1/commands/change-flow-step`
- [時間占有作成](/ja/docs/openapi/create-occupied-time.md): `POST /schedule/open/v1/commands/create-occupied-time`
- [予約時間スロット基準の予約日時変更](/ja/docs/openapi/reschedule-by-time-slot.md): `POST /schedule/open/v1/commands/reschedule-by-time-slot`
- [予約時間スロット基準の新規予約作成](/ja/docs/openapi/reserve-by-time-slot.md): `POST /schedule/open/v1/commands/reserve-by-time-slot`
- [予約時間スロット基準の新規予約作成（患者ID基準）](/ja/docs/openapi/reserve-by-time-slot-with-visitor-id.md): `POST /schedule/open/v1/commands/reserve-by-time-slot-with-visitor-id`
- [スケジュールカウンセリング情報修正](/ja/docs/openapi/update-schedule-consultation-info.md): `POST /schedule/open/v1/commands/update-schedule-consultation-info`
- [予約グループ紐付け商品照会](/ja/docs/openapi/get-linked-products.md): `POST /schedule/open/v1/linked-products/queries/get-linked-products`
- [会計IDでスケジュール照会](/ja/docs/openapi/find-schedule-by-purchase-id.md): `POST /schedule/open/v1/queries/find-schedule-by-purchase-id`
- [スケジュールIDで予約日時を変更可能な予約時間スロット照会](/ja/docs/openapi/get-reschedulable-time-slots.md): `POST /schedule/open/v1/queries/get-reschedulable-time-slots`
- [予約グループリスト照会](/ja/docs/openapi/get-reservation-groups.md): `POST /schedule/open/v1/queries/get-reservation-groups`
- [予約ルールリスト照会](/ja/docs/openapi/get-reservation-rule-summaries.md): `POST /schedule/open/v1/queries/get-reservation-rule-summaries`
- [予約グループで予約スロット照会](/ja/docs/openapi/get-reservation-slots-by-group.md): `POST /schedule/open/v1/queries/get-reservation-slots-by-group`
- [商品メニューで予約スロット照会](/ja/docs/openapi/get-reservation-slots-by-product.md): `POST /schedule/open/v1/queries/get-reservation-slots-by-product`
- [予約ルールで予約時間スロット照会](/ja/docs/openapi/get-reservation-time-slots.md): `POST /schedule/open/v1/queries/get-reservation-time-slots`
- [患者IDで予約ルール基準の予約時間スロット照会](/ja/docs/openapi/get-reservation-time-slots-by-visitor-id.md): `POST /schedule/open/v1/queries/get-reservation-time-slots-by-visitor-id`
- [スケジュール詳細照会](/ja/docs/openapi/get-schedule-detail.md): `POST /schedule/open/v1/queries/get-schedule-detail`
- [flowStepと予約開始日時の範囲でスケジュール照会](/ja/docs/openapi/get-schedules-by-flow-step.md): `POST /schedule/open/v1/queries/get-schedules-by-flow-step`
- [患者のスケジュールリスト照会](/ja/docs/openapi/get-schedules-by-visitor.md): `POST /schedule/open/v1/queries/get-schedules-by-visitor`
- [患者の施術履歴照会](/ja/docs/openapi/get-schedules-summarized-by-task.md): `POST /schedule/open/v1/queries/get-schedules-summarized-by-tasks`
- [新しい予約を作成](/ja/docs/openapi/reserve-v-2.md): `POST /schedule/open/v2/commands/reserve`
- [既存患者の予約作成](/ja/docs/openapi/reserve-by-visitor-id-v-2.md): `POST /schedule/open/v2/commands/reserve-by-visitor-id`
- [予約日程の修正](/ja/docs/openapi/update-reservation-v-2.md): `POST /schedule/open/v2/commands/update-reservation`
- [複数の予約グループの予約スロット照会](/ja/docs/openapi/get-reservation-slots-by-groups-v-2.md): `POST /schedule/open/v2/queries/get-reservation-slots-by-groups`
- [スケジュールに基づく予約スロット照会](/ja/docs/openapi/get-reservation-slots-by-schedule-id-v-2.md): `POST /schedule/open/v2/queries/get-reservation-slots-by-schedule-id`
- [区域照会](/ja/docs/openapi/get-zone.md): `POST /schedule/open/zone/v1/queries/get-zone`
- [区域全件照会](/ja/docs/openapi/get-zones.md): `POST /schedule/open/zone/v1/queries/get-zones`
- [新しい予約を作成](/ja/docs/openapi/reserve-command.md) 非推奨: `POST /schedule/open/v1/commands/reserve`
- [既存患者の予約作成](/ja/docs/openapi/reserve-by-visitor-id.md) 非推奨: `POST /schedule/open/v1/commands/reserve-by-visitor-id`
- [予約情報修正](/ja/docs/openapi/update-reservation.md) 非推奨: `POST /schedule/open/v1/commands/update-reservation`
- [スケジュールIDで予約スロット照会](/ja/docs/openapi/get-reservation-slots-by-schedule-id.md) 非推奨: `POST /schedule/open/v1/queries/get-reservation-slots-by-schedule-id`