Booking Steps

Collect Appointment Info

Booking steps are a collection of steps that are required for completeing appointment bookings with an organization's service providers.

There are six models under the step type: booking that each serve a distinct purpose in the appointment booking flow which follow a similar pattern to those seen in the Setster API Models docs.

How it works

All booking models listed below must be defined in the settings steps property to create an appointment booking successfully.

settings.json

{
  "name_your_step": {
    "type": "booking",
    // See Models section below.
    "model": ""
  }
}

note

All steps of type:booking are required to have a model property defined.

Flow

The user should go through each of the models as configured in the normal logic flow documented in the logic flow section.

caution

Be sure to add the cancel and reschedule flows so that clients can cancel and reschedule their appointments.

Models

Services Model

The services are offerings of a company or catalog of available appointment meeting types.

Locations Model

A location is the defined place where the appointment or the meeting will take place which may be a physical or virtual location.

Staff Model

Allows the user to select from the list of staff in the Setster API.

Availability Model

Displays a calendar of available appointment dates and times for the previously selected service.

Appointment Model

A client is automatically created when an appointment is booked.

Cancel Model

The step that allows the user to cancel an existing appointment