• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
BusinessAppointmentSettings

The service appointment settings, including where and how the service is provided.

Properties

Name Description
location_types
string [ ]

Types of the location allowed for bookings.

alignment_time
string

The time unit of the service duration for bookings.

min_booking_lead_time_seconds
integer (32-bit)

The minimum lead time in seconds before a service can be booked. Bookings must be created at least this far ahead of the booking's starting time.

max_booking_lead_time_seconds
integer (32-bit)

The maximum lead time in seconds before a service can be booked. Bookings must be created at most this far ahead of the booking's starting time.

any_team_member_booking_enabled
boolean

Indicates whether a customer can choose from all available time slots and have a staff member assigned automatically (true) or not (false).

multiple_service_booking_enabled
boolean

Indicates whether a customer can book multiple services in a single online booking.

max_appointments_per_day_limit_type
string

Indicates whether the daily appointment limit applies to team members or to business locations.

max_appointments_per_day_limit
integer (32-bit)

The maximum number of daily appointments per team member or per location.

cancellation_window_seconds
integer (32-bit)

The cut-off time in seconds for allowing clients to cancel or reschedule an appointment.

cancellation_fee_money
Money

The flat-fee amount charged for a no-show booking.

cancellation_policy
string

The cancellation policy adopted by the seller.

cancellation_policy_text
string

The free-form text of the seller's cancellation policy.

Max Length 65536
skip_booking_flow_staff_selection
boolean

Indicates whether customers has an assigned staff member (true) or can select s staff member of their choice (false).