Reservation

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

Fields

Field	Type	Description
id	string	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 and time of arrival in ISO 8601 format.
departureDate	string	Date and time of departure in ISO 8601 format.
nights	number	Number of nights the guest is staying.
propertyId	string	Unique identifier for the property.
numberOfGuests	number	Total number of guests staying.
primaryGuest	object Guest	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	CalryReservationSource	Source of the reservation.
totalPrice	number	Total price of the reservation.
currency	string	Currency of the total price.
status	CalryReservationStatus	Status of the reservation.
arrivalEstimatedTime	string	Estimated time of arrival in ISO 8601 format.
departureEstimatedTime	string	Estimated time of departure in ISO 8601 format.
codes	object ReservationCodes	Reservation codes.
notes	string	Additional notes about the reservation.
verification	object Verification	Verification status of the guest.
finances	object Finances	Financial details of the reservation.
customFields	array CustomField	Custom fields for the reservation.

Sub Fields

Guest

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	array of strings	Email addresses of the guest.
mobileNumbers	array of numbers	Mobile numbers of the guest.
preferredLanguage	object Language	Preferred language of the guest.
nationality	string	nationality of the guest.
address	object Address	Addresses of the guest.
pictures	array of strings	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 BasePrice	Base price details of the reservation.
fee	object Fee	Fee details of the reservation.
tax	object Tax	Tax details of the reservation.
discount	object Discount	Discount details of the reservation.
loyaltyPoints	object LoyaltyPoints	Loyalty points details of the reservation.

CustomField

Field	Type	Description
id	string	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
id	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
createdAt	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅
updatedAt	✅	✅	✅	✅	-	-	✅	-	✅	-	✅	-	✅	✅
cancelledAt	✅	✅	-	✅	-	-	-	-	✅	-	✅	✅	-	✅
confirmedAt	-	✅	-	✅	-	-	-	-	-	-	✅	✅	-	✅
arrivalDate	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
departureDate	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
nights	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
propertyId	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
roomId	-	-	-	✅	-	-	-	-	✅	-	-	-	-	-
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
Get Reservation	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Get All Reservations	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	✅	✅	✅	✅
Get Reservations by Property	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Create Reservation	✅	✅	🔜	✅	🔜	🔜	🔜	🔜	✅	🔜	🔜	🔜	🔜	🔜
Update Reservation	✅	✅	🔜	✅	🔜	🔜	🔜	🔜	✅	🔜	🔜	🔜	🔜	🔜

---

Sample Response

{
    "data":
   {
        "id": 23609077,
        "createdAt": "2024-01-23T22:30:18.000Z",
        "updatedAt": "2024-01-23T22:30:18.000Z",
        "cancelledAt": "",
        "arrivalDate": "2024-03-10T00:00:00.000Z",
        "departureDate": "2024-03-12T00:00:00.000Z",
        "nights": 2,
        "propertyId": 212815,
        "numberOfGuests": 3,
        "primaryGuest": {
            "name": "Alice Johnson",
            "emails": [
                "alicej@example.com"
            ],
            "nameLast": "Johnson",
            "pictures": [
                null
            ],
            "addresses": {
                "city": "Laketown",
                "line1": "456 Oak Lane Suite 12",
                "country": "Wonderland",
                "postal_code": "67890"
            },
            "nameFirst": "Alice",
            "mobileNumbers": [
                "+9876543210"
            ],
            "preferredLanguage": {
                "code": null,
                "name": ""
            }
        },
        "numberOfAdults": 2,
        "numberOfChildren": 1,
        "numberOfInfants": 0,
        "numberOfPets": 1,
        "source": "direct",
        "totalPrice": 950,
        "currency": "USD",
        "status": "new",
        "arrivalEstimatedTime": "09:30:00.000Z",
        "departureEstimatedTime": "06:30:00.000Z",
        "notes": "Need a crib for the child.",
        "verification": {
            "isEmailVerified": false,
            "isPhoneVerified": false,
            "isIdentityVerified": false,
            "isGovernmentIdVerified": false
        },
        "finances": {
            "fee": {
                "totalFee": 0,
                "breakdown": []
            },
            "tax": {
                "totalTax": 0,
                "breakdown": []
            },
            "currency": "USD",
            "discount": {
                "breakdown": [],
                "totalDiscount": 0
            },
            "basePrice": {
                "breakdown": [
                    {
                        "name": "Base rate",
                        "type": "BASE_PRICE",
                        "total": 950,
                        "units": 1,
                        "description": "Base rate",
                        "isMandatory": true
                    },
                    {
                        "name": "Total price from channel",
                        "type": "BASE_PRICE",
                        "total": 950,
                        "units": 1,
                        "description": "Total price from channel",
                        "isMandatory": false
                    }
                ],
                "totalBasePrice": 1900
            },
            "totalPrice": 950,
            "paymentStatus": "Unknown",
            "remainingBalance": null
        }
    }
}