v3

latestOpenAPI 3.0.02026-07-3179137151.7 KB

Bookings

Create a new booking.

post/v2/bookings

Request body

arrivalstring date-time

Arrival date in property time zone in yyyy-MM-dd format, e.g. 2024-10-31.

check_instring nullable

Check-in time in property time zone in 24 hour HH:mm format, e.g. 16:00. Not supported for blocks.

check_in_endstring nullable

Check-in end time in property time zone in 24 hour HH:mm format, e.g. 21:00 (optional). Not supported for blocks.

check_outstring nullable

Check-out time in property time zone in 24 hour HH:mm format, e.g. 09:00. Not supported for blocks.

cleaning_datestring date-time nullable

Scheduled cleaning date and time in property time zone.

departurestring date-time

Departure date in property time zone in yyyy-MM-dd format, e.g. 2024-10-31.

guest_idinteger nullable

The contact related to this booking. Required for bookings, not allowed for blocked-off times.

is_blockboolean

If this booking is a simple blocked-off time booking (true), or a full guest booking (false).

notesstring nullable

Internal notes for this booking.

property_idinteger

The Id of the property for this booking.

titlestring nullable

Title or label for this booking. Typically used for blocked-off times.

Response

A model representing the booking created.

idinteger

The ID of this record.

tagsstring[]

A collection of tag names.

adultsinteger

arrivalstring date-time

Arrival date in property time zone.

booked_utcstring date-time nullable

canceled_utcstring date-time nullable

cancellation_policy_descriptionstring

cancellation_policy_idinteger nullable

check_instring

Check-in time in property time zone in 24 hour HH:mm format, e.g. 16:00.

check_in_endstring

Check-in end time in property time zone in 24 hour HH:mm format, e.g. 21:00 (optional).

check_outstring

Check-out time in property time zone in 24 hour HH:mm format, e.g. 09:00.

childreninteger

cleaning_datestring date-time nullable

Scheduled cleaning date and time in property time zone.

created_utcstring date-time

The date this booking was created in the system.

currency_codestring

departurestring date-time

Departure date in property time zone.

form_keystring

Public form key for reference in guest form URL's.

guest_idinteger nullable

infantsinteger

is_blockboolean

If this booking is a simple blocked-off time booking (true), or a full guest booking (false).

listing_sitestring

notesstring

owner_idinteger nullable

pending_until_utcstring date-time nullable

petsinteger

platform_email_addressstring

A proxy email address provided by the OTA specifically for this booking.

platform_reservation_numberstring

The OTA reservation number, if applicable.

property_idinteger

quote_idinteger nullable

status'active' | 'canceled' | 'pending'

thread_idsinteger[]

titlestring

total_amountnumber nullable

total_host_feesnumber nullable

total_owednumber nullable

total_paidnumber nullable

total_refundednumber nullable

type'booking' | 'block' | 'quote_hold' | 'linked_availability' | 'owner'

updated_utcstring date-time nullable

The date this booking was last updated in the system.