Vacation Rental

Bookings

Reservation Details of a Room

This API provides basic booking information for a room. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/channelbookings/vacation_rental.php

Note: You need set Authcode in Header.

Header

Content-Type: application/json; AUTH_CODE: XXXXXXXXXXXXXXXXX

Parameter

NameData TypeDescription Example
request_type *VARCHAR(150)Use Keyword “get_reservation”
hotel_id *INT(11)Property IDXXXX
reservation_id *INT(20)To get the details of the reserved room 25

Request 

{   
"request_type": "get_reservation",
    "body": {
            "hotel_id": "XXXX",
            "reservation_id": "25"
    }
}

Response

NameData TypeDescription Example
statusStringFailure or success of the request
Values: Success, Error		Success
data.hotel_idIntegerID of Hotelxxxx
data.hotel_nameStringName of HotelHotel
data.room_idIntegerID of Room1234500000000002
data.room_nameStringName of RoomSuper Deluxe
data.reservation_idIntegerReservation IDRES124
data.guest_nameStringName of the GuestIon Morgal
data.check_inDateCheck-in DateRES123
data.check_outDateCheck-out Date2020-03-30 11:00:00
data.total_amountLongTotal Booking amount2950
data.currencyStringCurrencyINR
data.channelStringChannel name & channel hotel code from where a booking has been come in below formatname_channelHotelCode
data.payment_typeStringPayment Type Values : PayAtHotel, AgencyCollectPay At Hotel
errorCode–Error code in case of failure105
errorMessage–Error Message in case of failureInvalid Reservation ID

Success

{ "status": "success",
 "data": [
  {
   "hotel_id": "xxxx",
   "hotel_name": "Hotel",
   "room_id": "1234500000000000004",
   "room_name": "Delux",
   "room_code": "101",
   "reservation_id": "25",
   "booking_status": "Confirmed Reservation",
   "guest_name": "Mr. Ion Morgal",
   "check_in": "2020-03-29 12:00:00",
   "check_out": "2020-03-30 11:00:00",
   "remark": "",
   "total_amount": 2950,
   "currency": "INR",
   "channel": "",
   "payment_type": "Pay At Hotel"
  }
 ]
}

Error Codes

Error CodeError Name
101Invalid Hotel Id
102Invalid Authentication
103Blank Request
104Invalid Request Format
105Missing Required Parameter
106Invalid Reservation ID
107Invalid Date Format
108Invalid Date Range
109Currently Data can be requested for max 15 days
110Invalid Room Id
111IP Address is not Authorised
112Invalid Request Method
113Hotel Code is not Active
114Invalid Room Code or not associated with supplied room ID
115Internal Problem

Bookings

Todays CheckIn-Checkout

This API provides supplied room information for  today’s arrival-departure like reservation no, room no and arrival-departure date-time . The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/channelbookings/vacation_rental.php

Note: You need set Authcode in Header.

Header

Content-Type: application/json; AUTH_CODE: xxxxxxxxxxxxx

Parameter

NameData TypeDescription Example
request_type *VARCHAR(150)Use Keyword “get_calendar”
hotel_id *INT(11)Unique Hotel codeXXXX
report_type *VARCHAR(150)3 types of values can be passed with this parameter,
checkin – To get today’s Arrivals
checkout – To get today’s departure
both – To get today’s arrivals & departures
both

Request 

{    "request_type": "get_calendar",
    "body": {
            "hotel_id": "xxxx",
            "report_type":"both"
    }
}

Response

NameData TypeDescription Example
statusStringFailure or success of the request
Values: Success, Error		Success
data.*IntegerHere * means property IDxxxx
data.*.arrivals and/or data.*.departuresStringarrivals or departures parameter will be available according to the value of report_type sent in requestarrivals
data.*.arrivals.reservation_idIntegerReservation ID938
data.*.arrivals.room_codeStringRoom no. of particular roomL3
data.*.arrivals.arrival_date_timeDateArrival-departure date & time in the below format.
YYYY-MM-DD HH:MM:SS		2020-03-29 12:00:00
error_code–Error code in case of failure101
error_message–Error Message in case of failureInvalid Authentication Data

Success

{ 
"status": "success",
 "data": {
  "12345": {
   "arrivals": [
    {
     "reservation_id": "32",
     "room_code": "125",
     "arrival_date_time": "2020-05-09 12:00:00"
    }
   ]
  }
 }
}

Error Codes

Error CodeError Name
101Invalid Hotel Id
102Invalid Authentication
103Blank Request
104Invalid Request Format
105Missing Required Parameter
106Invalid Reservation ID
107Invalid Date Format
108Invalid Date Range
109Currently Data can be requested for max 15 days
110Invalid Room Id
111IP Address is not Authorised
112Invalid Request Method
113Hotel Code is not Active
114Invalid Room Code or not associated with supplied room ID
115Internal Problem

Bookings

Retrieve Physical Rooms

This API provides physical room information for your property. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/channelbookings/vacation_rental.php

Note: You need set Authcode in Header.

Header

Content-Type: application/json; AUTH_CODE: xxxxxxxxxxxxx

Parameter

NameData TypeDescription Example
request_type *VARCHAR(150)Use Keyword “get_rooms”
hotel_id *INT(11)Unique Hotel codeXXXX

Request 

{   
"request_type": "get_rooms",
    "body": {
        "hotel_id": "xxxx"
    }
}

Response

NameData TypeDescription Example
statusStringFailure or success of the request
Values: Success, Error		Success
data.rooms.room_idIntegerRoom Id1234500000000000001
data.rooms.room_nameStringName of roomStudio Room
data.rooms.room_codeStringRoom codes 106
error_code–Error code in case of failure105
error_message–Error Message in case of failureInvalid Reservation ID

Success

{ "status": "success",
 "data": {
  "rooms": [
   {
    "room_id": "1234500000000000001",
    "room_name": "Studio",
    "rooms": "106",
    "room_code": "106 : Active"
   },
   {
    "room_id": "1234500000000000002",
    "room_name": "Double Bedroom Suite",
    "rooms": "107,111,112,113",
    "room_code": "107 : Active,111 : Active,112 : Active,113 : Active"
   },
   ]
 }
}

Error Codes

Error CodeError Name
101Invalid Hotel Id
102Invalid Authentication
103Blank Request
104Invalid Request Format
105Missing Required Parameter
106Invalid Reservation ID
107Invalid Date Format
108Invalid Date Range
109Currently Data can be requested for max 15 days
110Invalid Room Id
111IP Address is not Authorised
112Invalid Request Method
113Hotel Code is not Active
114Invalid Room Code or not associated with supplied room ID
115Internal Problem

Bookings

Reserved Rooms Calendar

This API helps you to populate a stayview calendar with needful information for specific date ranges on your selected rooms. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/channelbookings/vacation_rental.php

Note: You need set Authcode in Header.

Header

Content-Type: application/json; AUTH_CODE: XXXXXXXXXXXXXXXXX

Parameter

NameData TypeDescription Example
request_type *VARCHAR(150)Use Keyword “get_calendar”
hotel_id *INT(11)Unique Hotel codeXXXX
room_id *INT(20)List of room Ids(If a date range is same for all Room IDs then all Ids will be listed in a single block else separate block will be there for a different date range) 1234500000000001, 1234500000000002
room_code *INT(20)List of room codes“102”, “104”,”108″
from_date *DateStart date of calendar information is to be requested
Format: YYYY-MM-DD		2020-06-15
to_date *DateEnd date of calendar information is to be requested
Format: YYYY-MM-DD		2020-07-15

Request 

{    "request_type": "get_calendar",
    "body": {

        "hotel_id": "xxxx",
        "rooms": [{
                "room_id": ["1234500000000000002", "1234500000000000003"],
           "room_code": ["107", "111", "112", "113"],
                "from_date": "2020-04-15",
                "to_date": "2020-05-15"
            },
            {
                "room_id": ["1234500000000000007"],
                "room_code": ["125","126"],
                "from_date": "2020-04-15",
                "to_date": "2020-05-15"
            }
        ]
    }
}

Response

NameData TypeDescription Example
statusStringFailure or success of the request
Values: Success, Error		Success
data.*IntegerHere * means Room type ID1234500000000001
data.*.room_nameStringName of RoomSuper Deluxe
data.*.room_name.dateDateCalendar DateFormat: YYYY-MM-DD2020-03-01
data.*.room_name.statusStringStatus of the roomValues : Reserved: If book is BookedBlocked: If sell is stopped for particular reasonReserved
data.*.room_name.reservation_info–If Room status is blocked then the Value of this Parameter will be blank else if room is booked, then reservation details will be supplied. –
data.*.room_name.reservation_info.reservation_idStringReservation Id
data.*.room_name.reservation_info.channelStringChannel name & channel hotel code from where a booking has been come in below formatname_channelHotelCode
data.*.room_name.reservation_info.guest_nameStringName of guestGuest Name
data.*.room_name.reservation_info.check_inDateDate of Check-in2020-04-01 12:00:00
data.*.room_name.reservation_info.check_outDateDate of Check-Our2020-05-03 12:00:00
error_code–Error code in case of failure101
error_message–Error Message in case of failureInvalid Authentication Data

Success

{ "status": "success",
 "data": {
  "1234500000000000002": {
   "room_info": "No Booking/Blocks are available for supplied Date Range"
  },
  "1234500000000000003": {
   "room_info": "No Booking/Blocks are available for supplied Date Range"
  },
  "1234500000000000007": {
   "room_name": "Stander",
   "room_info": [
    {
     "room_code": "125",
     "date": "2020-05-09",
     "status": "Reserved",
     "reservation_info": {
      "folios": {
       "33": {
        "Room Charges": "450.0000",
        "Service Tax": "100.0000",
        "All in Package [Qty -2.0000]": "300.0000"
       }
      },
      "reservation_id": "32",
      "guest_name": "Mam. Daya",
      "channel": "",
      "remark": "",
      "check_in": "2020-05-09 12:00:00",
      "check_out": "2020-05-10 11:00:00",
      "booking_status": "Confirmed Reservation",
      "total_amount": 850,
      "currency": "INR",
      "payment_type": "Pay At Hotel"
     }
    }
   ]
  }
 }
}

Error Codes

Error CodeError Name
101Invalid Hotel Id
102Invalid Authentication
103Blank Request
104Invalid Request Format
105Missing Required Parameter
106Invalid Reservation ID
107Invalid Date Format
108Invalid Date Range
109Currently Data can be requested for max 15 days
110Invalid Room Id
111IP Address is not Authorised
112Invalid Request Method
113Hotel Code is not Active
114Invalid Room Code or not associated with supplied room ID
115Internal Problem

Bookings

Room Sales Data

This API provides you sales information for rooms for a specific period. The API can return data in JSON formats. The web service responds to HTTP POST requests.

End Point URL

https://live.ipms247.com/channelbookings/vacation_rental.php

Note: You need set Authcode in Header.

Header

Content-Type: application/json; AUTH_CODE: XXXXXXXXXXXXXXXXX

Parameter

NameData TypeDescription Example
request_type *VARCHAR(150)Use Keyword “get_sales_report”
hotel_id *INT(11)Unique Hotel codeXXXX
room_id *INT(20)List of room Ids (If a date range is same for all Room IDs then all Ids will be listed in a single block else separate block will be there for a different date range) 1234500000000001, 1234500000000002
from_date *DateStart date of calendar information is to be requested
Format: YYYY-MM-DD		2020-06-25
to_date *DateEnd date of calendar information is to be requested
Format: YYYY-MM-DD		2020-07-10

Request 

{   
"request_type": "get_sales_report",
    "body": {
        "hotel_id": "xxxx",
        "rooms": [{
            "room_id": ["1234500000000000001", "1234500000000000002"],
            "from_date": "2020-04-25",
            "to_date": "2020-05-08"
        }]
    }
}

Response

NameData TypeDescription Example
statusStringFailure or success of the request
Values: Success, Error		Success
data.hotel_idIntegerID of Hotelxxxx
data.hotel_nameStringName of HotelHotel Name
data.Report.*StringHere * means Room type ID1234500000000001
data.Report.*.room_nameStringName of RoomSuper Deluxe
data.Report.*.#StringHere # means Room CodeL01
data.Report.*.#.room_nightsIntegerTotal available rooms for the month.
7
data.Report.*.#.room_soldIntegerNo. of room sold only. (not included complimentary)5
data.Report.*.#.complementaryStringComplimentary–
data.Report.*.#.occupancyIntegerOccupancy of room4
data.Report.*.#.adrStringAverage Daily rate950
data.Report.*.#.paxStringNo. of pax in Room4
data.Report.*.#.room_chargesLongRoom Charges85
data.Report.*.#.extra_chargesLongExtra Charged4
data.Report.*.#.channelStringChannel name & channel hotel codename_channelHotelCode (Which are mapped with this room type)Booking.com_11111
error_code–Error code in case of failure105
error_message–Error Message in case of failureInvalid Reservation ID

Success

{  "status": "success",
  "data": {
    "hotel_id": "xxxx",
    "hotel_name": "Hotel Name",
    "report": [
      {
        "1234500000000000001": {
          "106": {
            "room_nights": 14,
            "room_sold": 0,
            "complementary": 0,
            "occupancy": 0,
            "adr": 0,
            "pax": 0,
            "room_charges": 0,
            "extra_charges": 0,
            "channel": ""
          },
          "room_name": "Studio"
        }
      },
      {
        "1234500000000000002": {
          "107": {
            "room_nights": 14,
            "room_sold": 0,
            "complementary": 0,
            "occupancy": 0,
            "adr": 0,
            "pax": 0,
            "room_charges": 0,
            "extra_charges": 0,
            "channel": ""
          },
          "111": {
            "room_nights": 14,
            "room_sold": 0,
            "complementary": 0,
            "occupancy": 0,
            "adr": 0,
            "pax": 0,
            "room_charges": 0,
            "extra_charges": 0,
            "channel": ""
          },
          "112": {
            "room_nights": 14,
            "room_sold": 0,
            "complementary": 0,
            "occupancy": 0,
            "adr": 0,
            "pax": 0,
            "room_charges": 0,
            "extra_charges": 0,
            "channel": ""
          },
          "113": {
            "room_nights": 14,
            "room_sold": 0,
            "complementary": 0,
            "occupancy": 0,
            "adr": 0,
            "pax": 0,
            "room_charges": 0,
            "extra_charges": 0,
            "channel": ""
          },
          "room_name": "Double Bedroom Suite"
        }
      }
    ]
  }
}

Error Codes

Error CodeError Name
101Invalid Hotel Id
102Invalid Authentication
103Blank Request
104Invalid Request Format
105Missing Required Parameter
106Invalid Reservation ID
107Invalid Date Format
108Invalid Date Range
109Currently Data can be requested for max 15 days
110Invalid Room Id
111IP Address is not Authorised
112Invalid Request Method
113Hotel Code is not Active
114Invalid Room Code or not associated with supplied room ID
115Internal Problem

Click here to Register