Page Comparison

...

The getReservationDetails operation will return detailed information for the reservations matching the requested criteria.

Request

Element	Type	Description
siteIDList	Array	Mandatory A list of property IDs for which reservation details should be returned. This must be a subset of properties that are enabled for your API. At least 1 siteID is required
transactionReferenceList	Array	The transaction reference array will contain an entry for each transaction as requested in the siteIDList section of the request

...

Code Block

language	json

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getReservationDetails",
    "siteIDList": [
        1853
    ],
    "transactionReferenceList": [
        "3948484",
        "6YP6UCL"
    ]
}

Response

Element					Type	Description
siteList					Array	The siteList array will contain an entry for each site with transaction results.
	siteID				String	The internal siteID of the property in the IBE.
	primaryName				String	Property name.
	transactions				Array	Array of transaction results.
		reference			String	The internal transaction reference of the reservation in the IBE.
		dtCreated			String	The datetime the transaction was created.
		dtLastChanged			String	The last datetime the transaction was modified.
		status				The status of the reservation.
		newsletterSignup			String	Indicates if the booker signed up to receive newsletters.
		currency			String	The currency used to pay for the reservation.
		total			String	Total cost of the transaction.
		subTotal			String	Transaction cost before taxes and fees.
		taxesAndFees			String	The cost of any taxes and/or fees applicable to the transaction.
		moneyTaken			String	The amount paid by the customer to secure the booking.
		rate			Object	Details of the rate booked.
			rateID		String	The internal rateID of the rate booked.
			code		String	The internal code of the rate booked.
			name		String	The name of the rate booked.
		booker			Object	Details of the booker.
			name		Object	Details of the name of the booker.
				title	String	Booker title.
				first	String	Booker first name.
				last	String	Booker last name.
			email		String	Booker email address.
			selectedLanguage		String	The language the booker used during the transaction.
			address		Object	Details of the booker address.
				line1	String	Line 1 of the booker address.
				line2	String	Line 2 of the booker address.
				townCity	String	Town of the booker address.
				postCode	String	Post code of the booker address.
				countyState	String	County / State of the booker address.
				countryCode	String	Country code of the booker address.
			phones		Array	A list of phone numbers provided by the booker.
				index	String	The index of the phone number in the list of phone numbers.
				type	String	Phone number type.
				country	String	Phone number country.
				area	String	Phone number area code.
				number	String	Phone number.
		rooms			Array	A list of rooms associated with the booking.
			index		String	The index of the room in the list of rooms.
			status		String	Status of the room reservation.
			roomID		String	The internal roomID of the room.
			code		String	The internal code of the room.
			name		String	The name of the room.
			guestName		Object	Details of the guest name.
				title	String	Guest title.
				first	String	Guest first name.
				last	String	Guest last name.
			guestEmail			Guest email address.
			adults			The number of adults booked in the room.
			children			The number of children booked in the room.
			infants			The number of infants booked in the room.
			checkinDate			The checkin date for the room reservation.
			checkoutDate			The checkout date for the room reservation.
			nights			The number of nights the room is booked for.
			currency			The currency used while booking the room.
			reservationTotal			Total cost of the room reservation, including taxes/fees.
			taxesAndFeesTotal			Taxes and fees paid during the room reservation.
			accommodationTotal			Cost of the room with extras excluded.
			comments			Comments made on the room reservation.
			upsells		Array	Array of upsells pruchsed.
				name	String	The name of the upsell.
				description	String	The upsell description.
				quantity	Integer	The number of this upsell purchased.
				itemPrice	String	Price of each individual upsell.
				total	String	Total amount paid paid based on quantity and itemPrice.
status					String	Response status.

...

Versions Compared

Old Version 1

New Version Current

Key

Request

Response