Property resource definition

Property NameTypeDescription
_idStringUnique property ID from Guesty
titleStringListing title as configured in Guesty
nicknameStringListing nickname as configured in Guesty
typeStringListingTypes -
SINGLE - Top unit
MTL - Multi unit (contain one or more allotment per unit)
accomodatesIntegerMaximum occupancy of the listing
accountIdStringThe Guesty account ID that relate to the property
accountTaxesTaxes object
addressaddress objectProperty address details.
amenitiesStringList of all the property amenities
Enum
bathroomsIntegerNumber of bathrooms in the property
bedroomsIntegerNumber of bedrooms in the property
bedsIntegerNumber of beds in the property
bedTypestring
calendarRulesCalendar Rules object
defaultCheckInTimeStringThe default check-in time for this property
defaultCheckOutTimeStringThe default check-out time for this property
picturesPictures object
pricesPrices object
propertyTypeStringDefine the property type enum
RoomTypeString[Private room, Entire home/apt, Shared room]
publicDescriptionPublic Description object
tags[String]Array of listing Guesty custom tags
taxesTaxes object
timezoneString
termsTerms object

accountTaxes resource definition

NameTypeDescription
_idString
amountNumber
appliedOnFees[String]
nameString
quantifierString
typeString
unitsString

calendarRules resource definition

NameTypeDescription
defaultAvailabilityEnumAVAILABLE/BLOCKED
seasonalMinNights[seasonMinNights]
---fromString
---toString
rentalPeriods[rentalPeriods]
---fromString
---toString
advanceNotice[advanceNotice]
---defaultSettingsObject
------hoursNumber
------allowRequestToBookBoolean
bookingWindow[bookingWindow]
---defaultSettingsObject
------daysNumber

Get calendar resource definition

NameTypeDescription
dateString (date)Format: yyyy-mm-dd
minNightsNumberminimum nights value for the listing
isBaseMinNightsBooleanWhether this is the listing's minimum nights, or was specifically set for this day
statusString (Enum)available, unavailable, reserved, booked
ctaBooleanClosed To Arrival - Whether reservations are prevented from being booked starting on this day
ctdBooleanClosed To Departure - Whether reservations are allowed to be booked ending on this day

propertyAddress resource definition

NameTypeDescription
cityStringCity in which the property is located
countryStringthe country where the property is located.
fullStringFull address
latNumberLatitude of the property location
lngNumberLongitude of the property location
stateStringOptional. State/Province.
streetStringStreet in which the property is located
neighborhoodStringNeighborhood in which the property is located as defined on Guesty

pictures resource definition

NameTypeDescription
originalStringURL to origin size image
largeString
regularString
thumbnailStringURL to picture thumbnail
_idString

prices resource definition

NameTypeDescription
basePriceIntegerRegular listing price without custom override applied
currencyStringcurrencies
monthlyPriceFactorNumberListing price with monthly override applied
weeklyPriceFactorNumberListing price with weekly override applied
extraPersonFeeNumber
cleaningFeeNumber
petFeeNumber

publicDescription resource definition

NameTypeDescription
Guest controlsguestControls object
spaceStringProperty description as provided by the user in Guesty
accessStringProperty description as provided by the user in Guesty
neighborhoodStringProperty description as provided by the user in Guesty
transitStringProperty description as provided by the user in Guesty
notesStringProperty description as provided by the user in Guesty
interactionWithGuestsStringProperty description as provided by the user in Guesty
summaryStringProperty description as provided by the user in Guesty
houseRulesStringProperty description as provided by the user in Guesty

GuestControls resource definition

NameTypeDescription
allowsChildrenboolean
allowsInfantsboolean
allowsPetsboolean
allowsSmokingboolean
allowsEventsboolean

taxes resource definition

NameTypeDescription
_idString
amountNumber
appliedOnFees[String]
nameString
quantifierString
typeString
unitsString

terms resource definition

NameTypeDescription
minNightintegerThe minimum reservation nights if reservation check in is on this day
maxNightsintegerThe maximum reservation nights if reservation check in is on this day
cancellationstring

Create Reservation Response Definition

NameTypeDescription
_idStringId of the created object which is either a Reservation or Inquiry
statusStringStatus of the booking.

confirmed: Successfully created a Reservation.
inquiry: Successfully created a Inquiry.
declined: Failed to create a Inquiry or Reservation.
confirmationCodeStringConfirmation code for the reservation. This is null for an inquiry or declined status.
errorsStringError string describing why the request was declined