Room Stay

Room Stays contain information about the number of rooms, guests, room and rate codes, etc.

Parameter	Description	Type	Required
RoomStay/@EndDate	Defines the check-out date.	String	Yes
RoomStay/@StartDate	Date from which a rate starts to apply.	String	Yes
RoomStay/GuestCount/@AgeQualifyingCode	Code representing a business rule that determines the charges for a guest based upon age range. Values: Adult, Child, Senior	String	Yes
RoomStay/GuestCount/@Ages	The age of a guest.	Integer	No
RoomStay/GuestCount/@NumGuests	Number of guests.	Integer	Yes
RoomStay/@NumRooms	Specifies how many rooms are requested.	Integer	Yes
RoomStay/Products/@EndDate	End date associated with a product.	String	No
RoomStay/Products/@StartDate	Start date associated with a product.	String	No
RoomStay/Products/@Primary	If true, indicates the rate is the primary rate.	String	No
RoomStay/Products/Product/@DefaultRoomCode	Room Code to use in the booking if '@RoomCode' doesn't exist in the system. Only applies to `reservation/notif` operations.	String	No
RoomStay/Products/Product/@DefaultRateCode	Rate Code to use in the booking if '@RateCode' doesn't exist in the system. Only applies to `reservation/notif` operations.	String	No
RoomStay/Products/Product/@RateCode	Unique Control Center code for this rate type.	String	Yes
RoomStay/Products/Product/@RoomCode	Unique Control Center code for this room type.	String	Yes
RoomStay/@RedeemLoyalty	If true, indicates the room should be purchased using the loyalty-based payment method (i.e. points).	Boolean	No
RoomStay/@Refresh	Specifies the price refresh type during a modification. Values: New, Retain	String	No

Sample Request (Partial)

{
    "Chain": {...},
    "Channels": {...},
    "Hotel": {...},
    "Guests": [...],
    "RoomStay": {
        "StartDate": "2023-11-10",
        "EndDate": "2023-11-11",
        "GuestCount": [{
            "AgeQualifyingCode": "Adult",
            "NumGuests": 1
        },
        {
            "AgeQualifyingCode": "Child",
            "NumGuests": 2,
            "Ages": [4, 6]
        }
        ],
        "NumRooms": 1,
        "Products": [{
            "Primary": true,
            "Product": {
                "RateCode": "BAR",
                "RoomCode": "SUPK"
            }
        }]
    }
    "status": "Confirmed"
}

Sample Retrieve Reservation response

{
    "RoomStay": {
        "GuestCount": [
            {
                "Ages": [4, 6],
                "AgeQualifyingCode": "Child",
                "NumGuests": 2
            },
            {
                "AgeQualifyingCode": "Adult",
                "NumGuests": 1
            }
        ],
        "NumRooms": 1,
        "EndDate": "2023-11-10T00:00:00",
        "StartDate": "2023-11-12T00:00:00",
        "Group": false,
        "Suppressed": true,
        "Products": [
            {
                "Product": {
                    "RateCode": "BAR",
                    "RoomCode": "SUPK",
                    "Id": "36fb07b0-0ec4-40a8-9f82-7d6025b621a1"
                },
                "StartDate": "2023-11-10T00:00:00",
                "EndDate": "2023-11-12T00:00:00",
                "Primary": true
            }
        ]
    },
}