v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB

Reservations

Creates a new booking

Creates a new booking in the system. You can optionally upgrade an existing enquiry to a booking using the 'from' parameter.

post/v1/reservation/booking

Query parameters

frominteger

Optional. The identifier of an existing Enquiry to be upgraded to a Booking. This preserves the message history associated with the enquiry

Request body

source_textstring nullable

The source text for the booking

arrivalstring date-time

The arrival date in yyyy-MM-dd format

departurestring date-time

The departure date in yyyy-MM-dd format

property_idinteger

The unique identifier of the property

status'Open' | 'Booked' | 'Declined' | 'Tentative'

Represents the current status of a booking or enquiry.

payment_typestring nullable

(Obsolete. Use payment_website_id instead.) The payment type associated with the booking. Optional, default is None

payment_addressstring nullable

(Obsolete. Use payment_website_id instead.) The payment address. Only applicable if the Payment Type supports it (e.g. Paypal)

payment_website_idinteger nullable

The identifier of the website chosen as the payment gateway for this booking

bookability'InstantBooking' | 'BookingRequest' | 'EnquiryOnly'

Defines the booking policy or method available for a property.

ip_createdstring nullable

The IP address from where the booking is created. Optional. If not provided, the IP of the API caller is used

totalnumber double nullable

The total amount for the booking. Leave null to allow Lodgify to calculate the quote. If a value is provided, no calculations are performed. Requires CurrencyCode if defined.

currency_codestring nullable

The currency code for the total amount. Required if Total is provided

originstring nullable

The origin source of the booking

thread_idstring uuid nullable

Optional. Thread Id to link this booking to a messaging thread

Response

Created

integer required