Create Reservation

Overview

The createReservation operation will allow the partner / channel to write a reservation into the IBE.

Request

Element		Type	Description
billCheckSum		String	(Mandatory) The result from the previously-run generateBill operation. If any of the important room information in the createReservation differs from that which was used in the generateBill operation, the request will be rejected. A bill checksum is valid for a period of 30 minutes from when it's generated.
siteID		Integer	(Mandatory) The internal siteID of the property in the IBE.
reservationInformation		Object	(Mandatory) A list of information that relates to the reservation booker (not necessarily the guests).
	rateID	Integer	(Mandatory) The internal rateID of the IBE rate being booked.
	channelID	Integer	If not provided, the default website channel is assumed. Your account manager can provide more information on channel configuration if required.
	ipAddress	String	(Mandatory) The IPv4 address of the booker.
	checkinDate	String	(Mandatory) An ISO 8601 format date indicating the check-in date of the booking.
	checkoutDate	String	(Mandatory) An ISO 8601 format date indicating the check-out date of the booking.
	nameTitle	String	Booker title. If specified, must be a string between 2-9 characters long.
	nameFirst	String	(Mandatory) Booker first name. Must be a string between 1-63 characters long.
	nameLast	String	(Mandatory) Booker last name. Must be a string between 1-63 characters long.
	addressLine1	String	If specified, must be a string between 1-127 characters long.
	addressLine2	String	If specified, must be a string between 1-127 characters long.
	addressTown	String	If specified, must be a string between 1-127 characters long
	addressZIP	String	If specified, must be a string between 1-31 characters long.
	addressCounty	String	If specified, must be a string between 1-31 characters long.
	addressCountry	String	If specified, must be an ISO 3166-1 2-letter country code.
	email	String	(Mandatory) Must be the email address of the person making the booking.
	phoneNumber	String	If specified, must be a string between 3-31 characters long.
roomInformation		Object	(Mandatory) A list of rooms that are being booked on the specified rate. Key information (e.g. roomID, number of each occupant type) must match (in the same order) the rooms that was used in the corresponding generateBill operation.
	roomID	Integer	(Mandatory) The internal roomID of the room in the IBE.
	nameTitle	String	Guest title. If specified, must be a string between 2-9 characters long.
	nameFirst	String	(Mandatory) Guest first name. Must be a string between 1-63 characters long.
	nameLast	String	(Mandatory) Guest last name. Must be a string between 1-63 characters long.
	adults	Integer	(Mandatory) The number of adults in the room.
	child1	Integer	The number of children in the child1 age category in the room. If not specified, a value of 0 is assumed.
	child2	Integer	The number of children in the child2 age category in the room. If not specified, a value of 0 is assumed.
	child3	Integer	The number of children in the child3 age category in the room. If not specified, a value of 0 is assumed.
	child4	Integer	The number of children in the child4 age category in the room. If not specified, a value of 0 is assumed.
	infants	Integer	The number of infants in the infant age category in the room. If not specified, a value of 0 is assumed.

Sample

{
    "userAuth": {
        "username": "martinmAPI",
        "password": "p76Tvmtsme"
    },
    "operation": "createReservation",
  "billChecksum": "1WRKZWO-wwazE0I6QaxDQheN_lBlo_G5CcpT4UUeR03sQX7BwEFMwdBkQ0MtrsARoa5LTVGwpTpmlOZ_n2ABTuSImLNC-pchDXg6QANRzUQntLi_pRHso-d2eCVZip-uXxNuzJ679PQJERHE-7plnwwQ1fcJ7NQK7aupYtKT9A0Jzl_yQUHk3dcVj8hVzSDRKTDYA9m_p45Ww6nhZZ5tOUralGZ3HBl_edyz5URmE1H-jmm5ygxBSY3Z5vOg_YiJBCCNi9Pw_AupkLLrirppJdTxagofbODHOEWnABwdxZ1lCG3rME7uSBzE5Cx6Q5v-pDwcCuvb_XJtuO4J1r6hCDOxPMH4yUxAI4J_60817b9S06wtufBwSWFZ76aiCGo_Ko8VcrX6kCUyYLoRfIfmohzaA2fIUo0OjsIt8Cm5sKxR3tAmlWS6N8YmvBJpRho_4jzB4sRmCNEqM6mQCzW7s1sUjWMujEI2bvqTNWyLLKOMnGHhbrBdpSYuf9Ag6Tg3CQQipsg9ZWq5a-1a3Wjd2opBkbQ9HmoX7g8P2I_huXLzd88AJxd81d-fvsf5tFt3wZRa_fB6j_6_sMTbbvYGx0bt0X5jdcke1vTeNNZKx8QqHSkXY_kPWi2wFMVC1lNCwZZ2APIgk672zuAYGLmVaI01OdgU3lujrKLZpOkk741ygQCrz8oaXnYjf6psjGREEurh5z5-i9g0aSP9iLT-wQpOvbMr8Cs8qrK505mbVDWq_EupwrGskoLpBfIQ8Zo44pFj1Vk_C0UD1QassAGItqlLUKfExa7fnDoYQEiph-iAF2xrOgswZGRgXzdrme_K",
    "siteID": 1853,
    "reservationInformation": {
        "rateID": 4208974,
        "channelID": 19,
        "ipAddress": "127.0.0.1",
        "checkinDate": "2024-12-12",
        "checkoutDate": "2024-12-13",
        "nameTitle": "Mr",
        "nameFirst": "Joe",
        "nameLast": "Bloggs",
        "addressLine1": "Avvio House",
        "addressLine2": "Lonsdale Road",
        "addressTown": "Limerick",
        "addressZIP": "V94 AW2X",
        "addressCounty": "Limerick",
        "addressCountry": "IE",
        "email": "martin.mahony@avvio.com",
        "phoneNumber": "353 61 335680"
    },
    "roomInformation": [
        {
            "roomID": 4194373,
            "nameTitle": "Mr",
            "nameFirst": "Joe",
            "nameLast": "Bloggs",
            "adults": 1
        },
        {
            "roomID": 4194374,
            "nameTitle": "Ms",
            "nameFirst": "Jane",
            "nameLast": "Bloggs",
            "adults": 1,
            "child1": 1
        }
    ]
}

Response

Element	Type	Description
status	String	The result of the createReservation request.
siteID	Integer	The internal siteID of the property in the IBE.
primaryName	String	The name of the property.
transactionReference	String	The internal reference for this transaction in the IBE.

Sample

{
  "status": "ok",
  "siteID": 1853,
  "primaryName": "TestHotel Mahony",
  "transactionReference": "E1ALEF5"
}