Service

Service

Details of a Service Drop

A Service object is used to represent the context around how a customer can book with you. This contains all of the rules and properties, such as duration, time in advance, as well as links to the staff and resources who match skill sets

FieldDescriptionAdditional Information
id{{service.id}}Example: 198549
api_ref{{service.api_ref}}
availability{{service.availability}}
booking_time_step{{service.booking_time_step}}
booking_type_public{{service.booking_type_public}}
booking_type{service.booking_type}}
booking_type_member{{service.booking_type_member}}
can_refund_automatically{{service.can_refund_automatically}}
category_id{{service.category_id}}Example: 18
child_level_service{{service.child_level_service}}Boolean.
client_queue_id{{service.client_queue_id}}
color{{service.color}}
combine_resource_and_staff{{service.combine_resource_and_staff}}Boolean
company_id{{service.company_id}}Example: 40001
deleted{{service.deleted}}
description{{service.description}}Example: Teach how to play tennis
detail_group_id{{service.detail_group_id}}Question Group Id associated to the service. Example: 18543
disable_after_date{{service.disable_after_date}}
disable_before_date{{service.disable_before_date}}
disabled{{service.disabled}}
duration{{service.duration}}Returns the service duration. Example: 60
duration_unit{{service.duration | append : 'minutes'}}Example: 60 minutes
extra{{service.extra}}Example: {"booking_question"=>"answer", "multiple_choice"=>["choice1", "choice2", "choice3"]}
global_id{{service.global_id}}Same as the Service Id if the service was created a Booking Location level (Child Company).
group_id{{service.group_id}}Example: 30944
humanized method of appointment{{service.humanized_method_of_appointment}}Example: "In-Person"
image{{service.image}}URL of the default Image
images{{service.images['name']}}Link to image URL by it's name
is_event_group{{service.is_event_group}}
mbooking_type{{service.mbooking_type}}
max_advance_period{{service.max_advance_period}}
membership_prices{{service.membership_prices}}
min_advance_period{{service.min_advance_period}}
min_cancel_period{{service.min_cancel_period}}
max_advance_applies{{service.max_advance_applies}}
max_advance{{service.max_advance}}
min_advance_applies{{service.min_advance_applies}}
min_advance{service.min_advance}}
min_cancel_applies{{service.min_cancel_applies}}
min_cancel{{service.min_cancel}}
name{{service.name}}Example: Tennis Coaching
order{{service.order}}
person_ids{{service.person_ids}}
price{{service.price}}
price_after{{service.price_after}}
price_after_date{{service.price_after_date}}
question_group_id{{service.question_group_id}}
queuing_disabled{{service.queuing_disabled}}
queue_duration{{service.queue_duration}}
read_only{{service.read_only}}
reference{{service.reference}}
resource_ids{{service.resource_ids}}
rules_group_id{{service.rules_group_id}}
service_type{{service.service_type}}
service_method{{service.method_of_appointment}}Returns the method of appointment as it's numerical value.
Examples:
IN_PERSON = 0 , PHONE = 1 ,
VIDEO = 2)
spaces{{service.spaces}}
type{{service.type}}
app {{service.app.property}}Link to a Custom Object belonging to an app
company {{service.company.property}}Link to the company object
extras {{service.extras.property}}Link to the extra values
category {{service.category.property}}Link to the category of the service