Get Reservation References

1 Overview
2 Request
- 2.1 Sample
3 Response
- 3.1 Sample

Overview

The getReservationReference operation will return a list of transaction reference numbers matching the requested criteria.

Request

Element	Type	Description
siteIDList	Array	(Mandatory) A list of property IDs for which transaction references should be returned. This must be a subset of properties that are enabled for your API. At least 1 siteID is required.
startDate	String	An ISO 8601 format date string indicating the start date for which rate results should be returned. If not set, start date will be initialized to 7 days ago.
endDate	String	An ISO 8601 format date string indicating the end date for which rate results should be returned. If not set, end date will be initialized to current date.

Sample

{
    "userAuth": {
        "username": "username",
        "password": "password"
    },
    "operation": "getReservationReferences",
    "siteIDList": [
        1853
    ],
    "startDate": "2021-01-01",
    "endDate": "2021-01-31"
}

Response

Element			Type	Description
siteList			Array	The siteList array will contain an entry for each site as requested in the siteIDList section of the request
	siteID		Integer	The internal siteID of the property in the IBE.
	primaryName		String	Property name.
	transactions		Array	An array of transaction details matching the search criteria
		reference	String	The internal reference for this transaction in the IBE.
		dtCreated	String	The date this transaction was originally created in the IBE.
		dtLastChanged	String	The last date this transaction was modified in the IBE.
status			String	The status of the request.

Sample

{
  "siteList": [
    {
      "siteID": 1853,
      "primaryName": "TestHotel Mahony",
      "transactions": [
        {
          "reference": "VK9JZKE",
          "dtCreated": "2024-01-11 09:44:42",
          "dtLastChanged": "2024-01-11 09:44:42"
        },
        {
          "reference": "CAVS4M6",
          "dtCreated": "2024-01-11 09:58:49",
          "dtLastChanged": "2024-01-11 09:58:49"
        }
      ]
    }
  ],
  "status": "ok"
}