Locations Step Model

Collect Appointment Info

These are the meeting places you've added to your business profile in your Setster account, which may be physical locations or virtual (like Zoom).

settings.json

{
  "locations_step": {
    "title": "Locations",
    "dialogue_title": "Select a location",
    "type": "booking",
    "model": "locations",
    "layout": "list",
    "style": "classic"
  }
}

Default Location

Using the location ID retrieved from either the Setster Dashboard > Locations or the Setster API you can set the default_location property under the settings file.

integer

The physical or virtual location id where the appointment or the meeting will take place. Auto-selects an appointment location based on the provided location Id. Allows the user to skip the location selection step since it's pre-selected. Especially useful for accounts with only one location.

1234

settings.json

{
  "steps": {...},
  "flow": {...},
  "default_location": 1234
}

Hide Single Location

If there is only one location available you have the option to hide the step by modifying the settings in the Setster dashboard.

Schema Overview

model required	string Value: "locations"
type required	string Value: "booking"
layout	string (LocationsLayout) Value: "list"
style	string (AppState.IListItemsLayout) Enum: "classic" "modern"
dialogue_title	string The dialogue title is the instructions or question text content for a given step.
dialogue_instructions	string
disable_images	boolean Hides images from appointment related lists of options that are pulled from the Setster API automatically.
title	string The title of the step which is the first text content on the top of the step view. The title should describe the current step in a short and concise way.
can_skip	boolean When set to false the step is required to be answered before moving on to the next step. When set to true the user can skip answering the step.
class	string Adds a custom CSS class name to the step to allow for easy CSS selection and modifications at the step level.

{

• "locations_step": {

  • "title": "Locations",
  • "dialogue_title": "Select a location",
  • "type": "booking",
  • "model": "locations",
  • "layout": "list",
  • "style": "classic"

  }

}

Full Schema

Loading ....

Example

model required	string Value: "locations"
type required	string Value: "booking"
layout	string (LocationsLayout) Value: "list"
style	string (AppState.IListItemsLayout) Enum: "classic" "modern"
dialogue_title	string The dialogue title is the instructions or question text content for a given step.
dialogue_instructions	string
disable_images	boolean Hides images from appointment related lists of options that are pulled from the Setster API automatically.
title	string The title of the step which is the first text content on the top of the step view. The title should describe the current step in a short and concise way.
can_skip	boolean When set to false the step is required to be answered before moving on to the next step. When set to true the user can skip answering the step.
class	string Adds a custom CSS class name to the step to allow for easy CSS selection and modifications at the step level.

{

• "locations_step": {

  • "title": "Locations",
  • "dialogue_title": "Select a location",
  • "type": "booking",
  • "model": "locations",
  • "layout": "list",
  • "style": "classic"

  }

}

Related API Endpoint

Setster Studio handles all of the Setster API configurations in the background. For more advanced functionality see the API.

• Location Endpoint
• Location Model