Property resource definition
Property Name | Type | Description |
---|---|---|
_id | String | Unique property ID from Guesty |
title | String | Listing title as configured in Guesty |
nickname | String | Listing nickname as configured in Guesty |
type | String | ListingTypes - SINGLE - Top unit MTL - Multi unit (contain one or more allotment per unit) |
accomodates | Integer | Maximum occupancy of the listing |
accountId | String | The Guesty account ID that relate to the property |
accountTaxes | Taxes object | |
address | address object | Property address details. |
amenities | String | List of all the property amenities Enum |
bathrooms | Integer | Number of bathrooms in the property |
bedrooms | Integer | Number of bedrooms in the property |
beds | Integer | Number of beds in the property |
bedType | string | |
calendarRules | Calendar Rules object | |
defaultCheckInTime | String | The default check-in time for this property |
defaultCheckOutTime | String | The default check-out time for this property |
pictures | Pictures object | |
prices | Prices object | |
propertyType | String | Define the property type enum |
RoomType | String | [Private room, Entire home/apt, Shared room] |
publicDescription | Public Description object | |
tags | [String] | Array of listing Guesty custom tags |
taxes | Taxes object | |
timezone | String | |
terms | Terms object |
accountTaxes resource definition
Name | Type | Description |
---|---|---|
_id | String | |
amount | Number | |
appliedOnFees | [String] | |
name | String | |
quantifier | String | |
type | String | |
units | String |
calendarRules resource definition
Name | Type | Description |
---|---|---|
defaultAvailability | Enum | AVAILABLE/BLOCKED |
seasonalMinNights | [seasonMinNights] | |
---from | String | |
---to | String | |
rentalPeriods | [rentalPeriods] | |
---from | String | |
---to | String | |
advanceNotice | [advanceNotice] | |
---defaultSettings | Object | |
------hours | Number | |
------allowRequestToBook | Boolean | |
bookingWindow | [bookingWindow] | |
---defaultSettings | Object | |
------days | Number |
Get calendar resource definition
Name | Type | Description |
---|---|---|
date | String (date) | Format: yyyy-mm-dd |
minNights | Number | minimum nights value for the listing |
isBaseMinNights | Boolean | Whether this is the listing's minimum nights, or was specifically set for this day |
status | String (Enum) | available, unavailable, reserved, booked |
cta | Boolean | Closed To Arrival - Whether reservations are prevented from being booked starting on this day |
ctd | Boolean | Closed To Departure - Whether reservations are allowed to be booked ending on this day |
propertyAddress resource definition
Name | Type | Description |
---|---|---|
city | String | City in which the property is located |
country | String | the country where the property is located. |
full | String | Full address |
lat | Number | Latitude of the property location |
lng | Number | Longitude of the property location |
state | String | Optional. State/Province. |
street | String | Street in which the property is located |
neighborhood | String | Neighborhood in which the property is located as defined on Guesty |
pictures resource definition
Name | Type | Description |
---|---|---|
original | String | URL to origin size image |
large | String | |
regular | String | |
thumbnail | String | URL to picture thumbnail |
_id | String |
prices resource definition
Name | Type | Description |
---|---|---|
basePrice | Integer | Regular listing price without custom override applied |
currency | String | currencies |
monthlyPriceFactor | Number | Listing price with monthly override applied |
weeklyPriceFactor | Number | Listing price with weekly override applied |
extraPersonFee | Number | |
cleaningFee | Number | |
petFee | Number |
publicDescription resource definition
Name | Type | Description |
---|---|---|
Guest controls | guestControls object | |
space | String | Property description as provided by the user in Guesty |
access | String | Property description as provided by the user in Guesty |
neighborhood | String | Property description as provided by the user in Guesty |
transit | String | Property description as provided by the user in Guesty |
notes | String | Property description as provided by the user in Guesty |
interactionWithGuests | String | Property description as provided by the user in Guesty |
summary | String | Property description as provided by the user in Guesty |
houseRules | String | Property description as provided by the user in Guesty |
GuestControls resource definition
Name | Type | Description |
---|---|---|
allowsChildren | boolean | |
allowsInfants | boolean | |
allowsPets | boolean | |
allowsSmoking | boolean | |
allowsEvents | boolean |
taxes resource definition
Name | Type | Description |
---|---|---|
_id | String | |
amount | Number | |
appliedOnFees | [String] | |
name | String | |
quantifier | String | |
type | String | |
units | String |
terms resource definition
Name | Type | Description |
---|---|---|
minNight | integer | The minimum reservation nights if reservation check in is on this day |
maxNights | integer | The maximum reservation nights if reservation check in is on this day |
cancellation | string |
Create Reservation Response Definition
Name | Type | Description |
---|---|---|
_id | String | Id of the created object which is either a Reservation or Inquiry |
status | String | Status of the booking. confirmed: Successfully created a Reservation. inquiry: Successfully created a Inquiry. declined: Failed to create a Inquiry or Reservation. |
confirmationCode | String | Confirmation code for the reservation. This is null for an inquiry or declined status. |
errors | String | Error string describing why the request was declined |