Reservations

get
Get Reservations

https://app.bookboost.io/api/v2/apps/{appId}/reservations/
This endpoint allows you to get reservations.
Request
Response
Request
Query Parameters
filter
optional
string
options: arrivals departures staying new past future
Response
200: OK
Cake successfully retrieved.
[
{
"id": int,
"status": string,
"arrival_date_time": string|null,
"departure_date_time": string|nul;,
"number_of_adults": int,
"number_of_children": int,
"start": datetime+timezone,
"end": datetime+timezone,
"cancelled": datetime+timezone|null,
"created_at_in_pms": datetime+timezone|null,
"booking_reference": string|null,
"property_id": integer,
"spaces": array of spaces,
"rate_plans": array of rateplanss,
"pms": null,
"users": [
{
"id": integer,
"first_name": string,
"last_name": string,
"phones": array of phonenumbers,
"emails": array of emails,
"conversation_id": int|null,
"scheduled_messages": array of schedules,
"clients": array of clients
}
]
}
]

post
Store Reservation

https://app.bookboost.io/api/v2/apps/{appId}/reservations
Request
Response
Request
Body Parameters
booking_reference
optional
string
The internal reference of the booking
guest_ids
optional
array
Ids of the users which are linked to the reservation
end
required
string
End of the reservation in UTC timezone in ISO 8601 format
start
required
string
Start of the reservation in UTC timezone in ISO 8601 format
market_segment
optional
string
market_category
optional
string
channel_segment
optional
string
channel_category
optional
string
property_id
optional
integer
The ID of the property. A property is usually linked to a PMS, and usually there is one property per app
number_of_children
optional
integer
Number of Children
number_of_adults
optional
integer
Number of Adults
status
required
string
different states ENQUIRED REQUESTED OPTIONAL EXPECTED NO_SHOW CANCELLED CHECKED_IN CHECKED_OUT TRANSFERRED OTHER
Response
200: OK
{
"id": int,
"status": string,
"arrival_date_time": string|null,
"departure_date_time": string|nul;,
"number_of_adults": int,
"number_of_children": int,
"start": datetime+timezone,
"end": datetime+timezone,
"cancelled": datetime+timezone|null,
"created_at_in_pms": datetime+timezone|null,
"booking_reference": string|null,
"property_id": integer,
"spaces": array of spaces,
"rate_plans": array of rateplanss,
"pms": null,
"users": [
{
"id": integer,
"first_name": string,
"last_name": string,
"phones": array of phonenumbers,
"emails": array of emails,
"conversation_id": int|null,
"scheduled_messages": array of schedules,
"clients": array of clients
}
]
}

put
Update Reservation

https://app.bookboost.io/api/v2/apps/{appId}/reservations/{reservationId}
Same request body as the POST request, just provide the reservationId in the url to perform an update.
Request
Response
Request
Response
200: OK
{
"id": int,
"status": string,
"arrival_date_time": string|null,
"departure_date_time": string|nul;,
"number_of_adults": int,
"number_of_children": int,
"start": datetime+timezone,
"end": datetime+timezone,
"cancelled": datetime+timezone|null,
"created_at_in_pms": datetime+timezone|null,
"booking_reference": string|null,
"property_id": integer,
"spaces": array of spaces,
"rate_plans": array of rateplanss,
"pms": null,
"users": [
{
"id": integer,
"first_name": string,
"last_name": string,
"phones": array of phonenumbers,
"emails": array of emails,
"conversation_id": int|null,
"scheduled_messages": array of schedules,
"clients": array of clients
}
]
}

Removing Reservations

You cannot remove reservations but you can cancel the reservation by updating it with status = 'CANCELLED'