Sign in

v1

latestOpenAPI 3.0.32026-07-2672165314.6 KB
Reservations

Calculates a quote for a specific property and stay period.

Calculates the price and details for a potential booking based on the provided parameters (dates, property, room types, etc.). Returns a list of quotes for different rate plans.

get/v1/quote/{propertyId}

Path parameters

propertyIdinteger required

The unique identifier of the property.

Query parameters

arrivalstring date-time

The arrival date of the stay.

departurestring date-time

The departure date of the stay.

idinteger

The unique identifier for the room type.

peopleinteger

Deprecated. Use GuestBreakdown.Adults instead.

A list of room types and the number of guests for each.

idinteger
unitsinteger nullable

Optional list of add-ons to include in the quote.

promotionCodestring

Optional promotion code to apply to the quote.

Response

OK

currencystring nullable

The currency code (e.g., USD, EUR) used for all monetary values in this quote.

rentnumber double

The total rental cost for the specified period and room types, excluding fees and taxes.

discountnumber double

The total discount amount applied to the rental cost.

taxesnumber double

The total amount of taxes applied to the reservation.

security_depositnumber double

The amount required as a security deposit.

reservation_depositnumber double

The initial deposit amount required to secure the reservation.

totalnumber double

The final total amount payable for the booking, including rent, fees, taxes, and add-ons.