Reservation

Reservation, Stay, Booking - acation rental softwares use different terminology for similar concepts. At Calry, we flatten this to reservations. It represent the guest staying in one room type or property over concurrent nights.

Fields

Field	Type	Description
id	string/number	Unique identifier for the reservation.
createdAt	string	When the reservation was created in ISO 8601 format.
updatedAt	string	When the reservation was updated last in ISO 8601 format.
cancelledAt	string	When the reservation was cancelled in ISO 8601 format.
arrivalDate	string	Date of arrival in YYYY-MM-DD format.
departureDate	string	Date of departure in YYYY-MM-DD format.
nights	number	Number of nights the guest is staying.
propertyId	string/number	Unique identifier for the property.
roomTypeIds	string[]	Unique identifier for the room type associated with the reservation.
unitIds	string[]	Unique identifier for the units associated with the reservation.
numberOfGuests	number	Total number of guests staying.
primaryGuest	object	Details of the primary guest.
numberOfAdults	number	Number of adults staying.
numberOfChildren	number	Number of children staying.
numberOfInfants	number	Number of infants staying.
numberOfPets	number	Number of pets staying.
source	string	Source of the reservation.
totalPrice	number	Total price of the reservation.
currency	string	Currency of the total price.
status	string	Status of the reservation.
arrivalEstimatedTime	string	Estimated time of arrival in HH:MM:SS format. Local time is passed as it is from the PMS without transformation.
departureEstimatedTime	string	Estimated time of departure in HH:MM:SS format. Local time is passed as it is from the PMS without transformation.
codes	object	Reservation codes.
notes	string	Additional notes about the reservation.
verification	object	Verification status of the guest.
finances	object	Financial details of the reservation.
customFields	array	Custom fields for the reservation.

Sub Fields

primaryGuest

Field	Type	Description
name	string	Full name of the guest.
namePrefix	string	Prefix for the name.
nameFirst	string	First name of the guest.
nameLast	string	Last name of the guest.
emails	string[]	Email addresses of the guest.
mobileNumbers	string[]	Mobile numbers of the guest.
preferredLanguage	object	Preferred language of the guest.
nationality	string	nationality of the guest.
address	object	Addresses of the guest.
pictures	string[]	Pictures of the guest.

ReservationCodes

Field	Type	Description
accessCode	string[]	Access codes for the reservation.
confirmationCode	string	Confirmation code for the reservation.

Verification

Field	Type	Description
isIdentityVerified	boolean	Indicates if the identity of the guest is verified.
isEmailVerified	boolean	Indicates if the email of the guest is verified.
isGovernmentIdVerified	boolean	Indicates if the government ID of the guest is verified.
isPhoneVerified	boolean	Indicates if the phone number of the guest is verified.

Finances

Field	Type	Description
totalPrice	number	Total price of the reservation.
currency	string	Currency of the total price.
totalPaid	number	Total amount paid for the reservation.
remainingBalance	number	Remaining balance to be paid for the reservation.
paymentStatus	string	Status of the payment.
basePrice	object	Base price details of the reservation.
fee	object	Fee details of the reservation.
tax	object	Tax details of the reservation.
discount	object	Discount details of the reservation.
loyaltyPoints	object	Loyalty points details of the reservation.

CustomField

Field	Type	Description
id	string/number	Identifier of the custom field.
name	string	Name of the custom field.
type	string	Type of the custom field.
value	string	Value of the custom field.
defaultValue	string	Default value of the custom field.

ENUMS

CalryReservationStatus

  INQUIRY = 'INQUIRY',
  PENDING = 'PENDING',
  CONFIRMED = 'CONFIRMED',
  MODIFIED = 'MODIFIED',
  CANCELLED = 'CANCELLED',
  EXPIRED = 'EXPIRED',
  NO_SHOW = 'NO_SHOW',
  STAYING = 'STAYING',
  POST_STAY = 'POST_STAY',
  UNKNOWN = 'UNKNOWN',
  BLOCKED = 'BLOCKED'

CalryReservationSource

    DIRECT = "DIRECT",
    WEBSITE = "WEBSITE",
    AGODA = "AGODA",
    AIRBNB = "AIRBNB",
    ATRAVEODE = "ATRAVEODE",
    BEDANDBREAKFAST = "BEDANDBREAKFAST",
    BOOKEASYCOMAU = "BOOKEASYCOMAU",
    BOOKING = "BOOKING",
    BOOKING_COM = "BOOKING_COM",
    BOOKITCONZ = "BOOKITCONZ",
    DESPEGAR = "DESGPEGAR",
    EDREAMSODIGEO = "EDREAMSODIGEO",
    EXPEDIA = "EXPEDIA",
    FERATEL = "FERATEL",
    FLIPKEY = "FLIPKEY",
    GOIBIBO = "GOIBIBO",
    GOOGLECAL = "GOOGLECAL",
    GOOGLEADS = "GOOGLEADS",
    GUESTLINKCOUK = "GUESTLINKCOUK",
    HOLIDAYLETTINGSCOUK = "HOLIDAYLETTINGSCOUK",
    HOMEAWAY = "HOMEAWAY",
    HOMETOGO = "HOMETOGO",
    HOSTELINTERNATIONAL = "HOSTELINTERNATIONAL",
    HOSTELSCLUB = "HOSTELSCLUB",
    HOSTELWORLD = "HOSTELWORLD",
    HOTELBEDS = "HOTELBEDS",
    HOUSETRIPCOM = "HOUSETRIPCOM",
    HRS = "HRS",
    ICALIMPORT = "ICALIMPORT",
    JOMRES = "JOMRES",
    LASTMINUTE = "LASTMINUTE",
    NZAA = "NZAA",
    OSTROVOKRU = "OSTROVOKRU",
    RESERVA = "RESERVA",
    REZINTELNET = "REZINTELNET",
    TABLETHOTELS = "TABLETHOTELS",
    TIKET = "TIKET",
    TOMASTRAVEL = "TOMASTRAVEL",
    TRAUMFERIENWOHNUNGEN = "TRAUMFERIENWOHNUNGEN",
    TRAVELOKA = "TRAVELOKA",
    TRAVIA = "TRAVIA",
    TRIP = "TRIP",
    TRIPADVISOR = "TRIPADVISOR",
    TRIPADVISORRENTALS = "TRIPADVISORRENTALS",
    TRIVAGOCOM = "TRIVAGOCOM",
    VACATIONSTAY = "VACATIONSTAY",
    VISITSCOTLANDCOM = "VISITSCOTLANDCOM",
    VRBO = "VRBO",
    WEBROOMSCONZ = "WEBROOMSCONZ",
    UNKNOWN = "UNKNOWN"

---

Supported fields in each source system:

Field	Hostaway	Hostify	Smoobu	Lodgify	Uplisting	Guesty	Hostfully	OwnerRez	Beds24	Hospitable	FantasticStay	Hostex	Elina	BookingSync	Direct	Your Rentals	Mr Alfred	Resly	RentalWise	Cloudbeds	Zeevou
id	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
createdAt	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	-	✅	✅	✅	✅	✅	✅
updatedAt	✅	✅	✅	✅	-	-	✅	-	✅	-	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅
cancelledAt	✅	✅	-	✅	-	-	-	-	✅	-	✅	✅	-	✅	-	-	✅	✅	✅	-	-
confirmedAt	-	✅	-	✅	-	-	-	-	-	-	✅	✅	-	✅	✅	✅	-	✅	✅	-	-
arrivalDate	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
departureDate	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
nights	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
propertyId	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
roomTypeIds	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
unitIds	-	-	-	-	-	-	-	-	✅	-	-	-	🔜	✅	✅	-	-	-	✅	✅	✅
numberOfGuests	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
primaryGuest	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
numberOfAdults	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	-	✅	✅	✅	✅
numberOfChildren	✅	✅	✅	-	-	✅	✅	✅	✅	✅	✅	✅	-	✅	-	✅	-	✅	✅	✅	✅
numberOfInfants	✅	✅	-	-	-	✅	✅	✅	-	✅	✅	✅	-	-	-	✅	-	-	✅	-	-
numberOfPets	✅	✅	-	-	-	🔜	✅	✅	-	✅	✅	✅	-	-	-	✅	-	-	✅	-	-
source	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
totalPrice	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
currency	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	-	-	✅	✅	-	✅
status	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
arrivalEstimatedTime	✅	✅	✅	✅	✅	✅	✅	✅	-	-	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅
departureEstimatedTime	✅	✅	✅	✅	✅	✅	✅	✅	-	-	✅	✅	✅	✅	✅	✅	✅	✅	-	-	✅
codes	✅	✅	-	🔶	-	✅	-	✅	-	-	✅	✅	🔶	✅	✅	🔶	✅	✅	🔶	🔶	✅
notes	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	-
verification	✅	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	-	🔶
finances	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔶	✅	✅	✅	🔶	🔶	✅	🔶	✅
customFields	✅	✅	✅	-	-	✅	✅	✅	✅	-	✅	-	✅	-	-	-	-	-	-	✅	🔜

✅ Supported and mapped
🔶 Partially mapped, not exact match
🔜 Launching soon
— Not supported in source system

---

Supported Methods in each source system

Methods	Hostaway	Hostify	Smoobu	Lodgify	Uplisting	Guesty	Hostfully	OwnerRez	Beds24	Hospitable	FantasticStay	Hostex	Elina	BookingSync	Direct	Your Rentals	Mr Alfred	Resly	RentalWise	Cloudbeds	Zeevou
Get Reservation	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Get All Reservations	✅	✅	✅	✅	-	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Get Reservations by Property	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	-	✅	✅	✅
Create Reservation	✅	✅	🔜	✅	✅	✅	✅	🔜	✅	🔜	🔜	🔜	🔜	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
Update Reservation	✅	✅	🔜	✅	✅	✅	✅	🔜	✅	🔜	🔜	🔜	🔜	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
Create Reservation [Booking Engine API]	🔜	🔜	🔜	✅	🔜	🔜	✅	🔜	🔜	🔜	🔜	🔜	🔜	✅	🔜	🔜	🔜	🔜	🔜

Note: This table is applicable only if you're using our Realtime APIs (Base APIs). If the Cached Database add-on is enabled in your workspace, all GET endpoints will be accessible across all PMS systems.

---