> 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.

# Schedule

This is the API for reservations and schedules.

It provides features for creating reservations, modifying reservations, canceling reservations, querying reservation slots, reservation groups, zones, and schedule lookups.

<details>
<summary>Key Concepts</summary>
<dl>
<dt>Reservation</dt>
<dd><strong>Definition:</strong> A scheduled request registered for a Client to visit the clinic at a specific time.<br /><strong>Description:</strong> The central subject of the reservation creation, modification, and cancellation APIs. When making a request, Client information, reservation group, zone, start/end time, and desired treatment information are submitted together.</dd>
<dt>Schedule</dt>
<dd><strong>Definition:</strong> Visit schedule information managed within the clinic's operational flow, based on reservations.<br /><strong>Description:</strong> The schedule lookup API allows you to view information required for actual visit management, such as Client details, reservations, payments, and treatment progress.</dd>
<dt>Reservation Slot</dt>
<dd><strong>Definition:</strong> A time interval during which a reservation can be created.<br /><strong>Description:</strong> Available time slots are queried based on conditions such as products, reservation groups, and existing schedules, and then used when submitting a reservation creation request.</dd>
<dt>Reservation Group</dt>
<dd><strong>Definition:</strong> A reservation unit that bundles and manages available reservation times, zones, resources, and policies.<br /><strong>Description:</strong> The slots displayed and the available reservation times may vary depending on which reservation group is used for booking.</dd>
<dt>Zone</dt>
<dd><strong>Definition:</strong> An area within the clinic to which a reservation or schedule is assigned.<br /><strong>Description:</strong> Used in reservation creation and slot queries to designate the space where a Client will visit or where a resource will be occupied.</dd>
<dt>Occupied Time</dt>
<dd><strong>Definition:</strong> Information that excludes a specific time slot from the reservable range or marks it as resource usage time.<br /><strong>Description:</strong> Creating an occupied time allows you to control the clinic so that reservations are not accepted during that period.</dd>
<dt>Visit Stage</dt>
<dd><strong>Definition:</strong> This is the stage indicating which visit stage the schedule is currently in.<br /><strong>Description:</strong> Used to query schedules based on the visit process, such as appointment, check-in, counseling, and treatment.</dd>
</dl>
</details>


## Endpoints

- [Cancel reservation](/en/docs/openapi/cancel-reservation.md): `POST /schedule/open/v1/commands/cancel-reservation`
- [Change flow step](/en/docs/openapi/change-flow-step.md): `POST /schedule/open/v1/commands/change-flow-step`
- [Create time block](/en/docs/openapi/create-occupied-time.md): `POST /schedule/open/v1/commands/create-occupied-time`
- [Reschedule by reservation time slot](/en/docs/openapi/reschedule-by-time-slot.md): `POST /schedule/open/v1/commands/reschedule-by-time-slot`
- [Create a new reservation by reservation time slot](/en/docs/openapi/reserve-by-time-slot.md): `POST /schedule/open/v1/commands/reserve-by-time-slot`
- [Create a new reservation by reservation time slot and Client ID](/en/docs/openapi/reserve-by-time-slot-with-visitor-id.md): `POST /schedule/open/v1/commands/reserve-by-time-slot-with-visitor-id`
- [Update schedule consultation information](/en/docs/openapi/update-schedule-consultation-info.md): `POST /schedule/open/v1/commands/update-schedule-consultation-info`
- [Retrieve linked products](/en/docs/openapi/get-linked-products.md): `POST /schedule/open/v1/linked-products/queries/get-linked-products`
- [Look up schedule by Payment ID](/en/docs/openapi/find-schedule-by-purchase-id.md): `POST /schedule/open/v1/queries/find-schedule-by-purchase-id`
- [Retrieve reschedulable reservation time slots by schedule ID](/en/docs/openapi/get-reschedulable-time-slots.md): `POST /schedule/open/v1/queries/get-reschedulable-time-slots`
- [List reservation groups](/en/docs/openapi/get-reservation-groups.md): `POST /schedule/open/v1/queries/get-reservation-groups`
- [Retrieve booking rule list](/en/docs/openapi/get-reservation-rule-summaries.md): `POST /schedule/open/v1/queries/get-reservation-rule-summaries`
- [Query reservation slots by reservation group](/en/docs/openapi/get-reservation-slots-by-group.md): `POST /schedule/open/v1/queries/get-reservation-slots-by-group`
- [Get reservation slots by product option](/en/docs/openapi/get-reservation-slots-by-product.md): `POST /schedule/open/v1/queries/get-reservation-slots-by-product`
- [Retrieve reservation time slots by booking rule](/en/docs/openapi/get-reservation-time-slots.md): `POST /schedule/open/v1/queries/get-reservation-time-slots`
- [Retrieve booking-rule reservation time slots by Client ID](/en/docs/openapi/get-reservation-time-slots-by-visitor-id.md): `POST /schedule/open/v1/queries/get-reservation-time-slots-by-visitor-id`
- [Get schedule detail](/en/docs/openapi/get-schedule-detail.md): `POST /schedule/open/v1/queries/get-schedule-detail`
- [Query schedules by flowStep and reservation start date/time range](/en/docs/openapi/get-schedules-by-flow-step.md): `POST /schedule/open/v1/queries/get-schedules-by-flow-step`
- [List Client schedules](/en/docs/openapi/get-schedules-by-visitor.md): `POST /schedule/open/v1/queries/get-schedules-by-visitor`
- [Retrieve Client procedure history](/en/docs/openapi/get-schedules-summarized-by-task.md): `POST /schedule/open/v1/queries/get-schedules-summarized-by-tasks`
- [Create a new reservation](/en/docs/openapi/reserve-v-2.md): `POST /schedule/open/v2/commands/reserve`
- [Create reservation for existing Client](/en/docs/openapi/reserve-by-visitor-id-v-2.md): `POST /schedule/open/v2/commands/reserve-by-visitor-id`
- [Update reservation schedule](/en/docs/openapi/update-reservation-v-2.md): `POST /schedule/open/v2/commands/update-reservation`
- [Retrieve reservation slots for multiple reservation groups](/en/docs/openapi/get-reservation-slots-by-groups-v-2.md): `POST /schedule/open/v2/queries/get-reservation-slots-by-groups`
- [Retrieve available slots by schedule](/en/docs/openapi/get-reservation-slots-by-schedule-id-v-2.md): `POST /schedule/open/v2/queries/get-reservation-slots-by-schedule-id`
- [Get zone](/en/docs/openapi/get-zone.md): `POST /schedule/open/zone/v1/queries/get-zone`
- [Get all zones](/en/docs/openapi/get-zones.md): `POST /schedule/open/zone/v1/queries/get-zones`
- [Create a new reservation](/en/docs/openapi/reserve-command.md) deprecated: `POST /schedule/open/v1/commands/reserve`
- [Create reservation for existing Client](/en/docs/openapi/reserve-by-visitor-id.md) deprecated: `POST /schedule/open/v1/commands/reserve-by-visitor-id`
- [Update reservation information](/en/docs/openapi/update-reservation.md) deprecated: `POST /schedule/open/v1/commands/update-reservation`
- [Retrieve reservation slots by schedule ID](/en/docs/openapi/get-reservation-slots-by-schedule-id.md) deprecated: `POST /schedule/open/v1/queries/get-reservation-slots-by-schedule-id`