JRNI Developer Documentation

The JRNI Developer Hub

Welcome to the JRNI developer hub.

Booking (Space)

Details of the booking

A Booking (sometimes called a 'Space') a record of a client's appointment or space in a class. It links to to the 'Slot' which is the representation of the time in the Staff or Resources' calendar. It links to the client, to any details of a purchase Order.

It contains details around the clients status, if they've attended, arrived, cancelled etc.

Field

Usage / Description

id

{{booking.id}}

full_describe

{{booking.full_describe}}

resource_name

{{booking.resource_name}}

person_name

{{booking.person_name}}

service_name

{{booking.service_name}}

resource_id

{{booking.resource_id}}

member_id

{{booking.member_id}}

client_name

{{booking.client_name}}

client_email

{{booking.client_email}}

client_phone

{{booking.client_phone}}

client_mobile

{{booking.client_mobile}}

service_id

{{booking.service_id}}

datetime

{{booking.datetime}}

end_datetime

{{booking.end_datetime}}

duration

{{booking.duration}}

duration_span

{{booking.duration_span}}

listed_duration

{{booking.listed_duration}}

on_waitlist

{{booking.on_waitlist}}

company_id

{{booking.company_id}}

company_name

{{booking.company_name}}

attended

{{booking.attended}}

booking_updated

{{booking.booking_updated}}

updated_at

{{booking.updated_at}}

created_at

{{booking.created_at}}

client_id

{{booking.client_id}}

person_id

{{booking.person_id}}

people_ids

{{booking.people_ids}}

price

{{booking.price}}

paid

{{booking.paid}}

quantity

{{booking.quantity}}

is_cancelled

{{booking.is_cancelled}}

multi_status

{{booking.multi_status}}

purchase_id

{{booking.purchase_id}}

purchase_ref

{{booking.purchase_ref}}

event_chain_id

{{booking.event_chain_id}}

notes

{{booking.notes}}

channel

{{booking.channel}}

user_id

{{booking.user_id}}

status

{{booking.status}}

ticket_name

{{booking.ticket_name}}

client

{{booking.client}}

slot_id

{{booking.slot_id}}

settings

{{booking.settings}}

slot_settings

{{booking.slot_settings}}

answers_summary

{{booking.answers_summary}}

survey_answers_summary

{{booking.survey_answers_summary}}

questions

{{booking.questions}}

current_multi_status

{{booking.current_multi_status}}

private_note

{{booking.private_note}}

pre_time

{{booking.pre_time}}

post_time

{{booking.post_time}}

min_cancellation_time

{{booking.min_cancellation_time}}

cancellation_date

{{booking.cancellation_date}}

cancel_reason

{{booking.cancel_reason}}

mobile

{{booking.mobile}}

booked_by

{{booking.booked_by}}

booked_by_email

{{booking.booked_by_email}}

time_zone

{{booking.time_zone}}

cancelled_by

{{booking.cancelled_by}}

barcode

<img src='{{booking.barcode}}' class='barcode'>
Displays an encoded barcode with the reference that can be used with a barcode scanner

customer_count

{{booking.customer_count}}

serving_start_time

booking.serving_start_time
Customer marked as arrived and being seen

serving_finish_time

booking.serving_finish_time
Booking marked as completed

marked_absent_time

booking.marked_absent_time
Customer marked as no show

queue_name

{{booking.queue_name}}

queue_id

{{booking.queue_id}}

queue_url

{{booking.queue_url}}

ical_link

{{booking.ical_link}}
A Link to the booking's i-cal file

s_status

{{booking.s_status}}
String description of the booking status

answers

{{booking.answers[id]}}
A direct access to the answer to question by the id of the question

property

{{booking.
A direct access to the answer to booking question by it's slug name

questions

{% for question in booking.questions %}
Loop around the booking questions

additional_attendees

{% for attendee in booking.additional_attendees %}
Loop around any additional attendees

company

{{booking.company.property}}
Link to the Company Object

person

{{booking.person.property}}
Link to the Primary Person Object

all_people

{% for person in booking.all_people %}
Loop around all staff assigned to the booking

additional_people

{% for person in booking.additional_people %}
Loop around the additional staff assigned to the booking

resource

{{booking.resource.property}}
Link to the Primary Resource Object

all_resources

{% for resource in booking.all_resources %}
Loop around the all Resources assigned to this booking

additional_resources

{% for resource in booking.additional_resources %}
Loop around the aditional resources assigned to this booking

address

{{booking.address.property}}
Link to the Address Object

service

{{booking.service.property}}
Link to the Service Object

item

{{booking.item.property}}
Link to the Purchase Item Object

event_chain

{{booking.event_chain.property}}
Link to the Event Chain Object

client

{{booking.client.property}}
Link to the Client Object

member

{{booking.member.property}}
Link to the Client Object (same as client - this version is deprecated)

slot

{{booking.slot.property}}
Link to the Slot Object

order

{{booking.order.property}}
Link to the Order Object

conversation

{% for message in booking.conversation %}
Loop around the conversation messages

app

{{booking.app.property}}
Link to a Custom Object belonging to an app

Updated 6 months ago

Booking (Space)


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.