This API will give you latest updates of bookings which are newly created, modified and canceled. The API can return data in JSON formats. The web service responds to HTTP POST requests.
We recommend periodically calling the API — every minute, so your system can remain in sync with our system thereby keeping your system up-to-date.
End Point URL
Header
Parameter
| Name | Data Type | Description | Example |
| Request_Type * | – | Use Keyword “Bookings” | |
| HotelCode * | INT(11) | Unique Hotel code | XXXX |
| AuthCode * | VARCHAR(300) | Unique Authentication code | XXXXXXXXXXXXXXXXX |
Request
{
"RES_Request": {
"Request_Type": "Bookings",
"Authentication": {
"HotelCode": "xxxx",
"AuthCode": "XXXXXXXXXXXXXXXXXXXXXXXX"
}
}
}
Response
| Name | Data Type | Description | Example |
| LocationId | INT(11) | Hotel code | xxxx |
| UniqueID | VARCHAR(255) | Unique Booking id | 10125, 86436, B4525 etc |
| BookedBy | VARCHAR(255) | Information regarding Booked by | Booking.com etc |
| Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email. | VARCHAR(255) | Here * denotes guest information like Salutation, FirstName, LastName, Gender, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email. | shown in JSON response below. |
| Source | VARCHAR(1000) | Booking generated source | Booking.com etc |
| PaymentMethod | VARCHAR(255) | Payment Mode selected by guest | Cash, Credit, CityLedger etc |
| IsChannelBooking | INT(1) | Is booking comes from channel [0 or 1] 1 : Booking from the channel. 0: Booking not from the channel. | 0 or 1 |
| BookingTran. SubBookingId | VARCHAR(255) | Sub booking Id | 138 |
| BookingTran. TransactionId | INT(20) | Booking Transaction ID | 112500000000000163 |
| BookingTran. Status | VARCHAR(1000) | Booking Status | New or Modify or Cancel. |
| BookingTran.I sConfirmed | INT(1) | Booking Confirmation Flag. [1 or 0] 1 : Confirmed 0 : Not Confirmed | 1 or 0. |
| BookingTran.CurrentStatus | VARCHAR(100) | Booking Current Status | Arrived, Checked Out, Cancel, Void, etc |
| BookingTran. VoucherNo | VARCHAR(255) | Booking Voucher No | 10203049/8512 |
| BookingTran. PackageCode | INT(20) | Package Code | 112500000000000001 |
| BookingTran. PackageName | VARCHAR(1000) | Package Name | European Plan etc |
| BookingTran. RateplanCode | INT(20) | Unique RatePlan Code | 112500000000000006 |
| BookingTran. RateplanName | STRING(1000) | RatePlan Name | Grand Sea View Junior Suite |
| BookingTran. RoomTypeCode | INT(20) | Unique RoomType Code | 112500000000000006 |
| BookingTran. RoomTypeName | STRING(1000) | RoomType Name | Garden View Studio Room |
| BookingTran. Start | DATE | Check-in date[Format : yyyy-mm-dd] | 2017-12-25 |
| BookingTran. End | DATE | Check-out date [Format : yyyy-mm-dd] | 2017-12-27 |
| BookingTran.TotalRate | DECIMAL(19,4) | Rate on room in amount | 1500.43 |
| BookingTran. | DECIMAL(19,4) | Discount on room in | 500 |
| TotalDiscount | Amount | ||
| BookingTran. TotalExtraCharge | DECIMAL(19,4) | Extra charges in amount(if any) | 300 |
| BookingTran. TotalPayment | DECIMAL(19,4) | Payment for room in amount | 2500.54 |
| BookingTran.* | – | Here * denotes guest informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Zip Code, Phone, Mobile, Fax, Email, RegistrationNo, IdentityType, IdentityNo, ExpiryDate. | |
| BookingTran. TransportationMode | VARCHAR(100) | Mode of transportation | Bus, car etc |
| BookingTran. Vehicle | VARCHAR(255) | Detail of vehicle | |
| BookingTran. PickupDate | DATE | Pickup date[Format : yyyy-mm-dd] | 2017-12-25 etc |
| BookingTran. PickupTime | TIME | Pickup time | |
| BookingTran. Source | VARCHAR(1000) | Booking generated source | Booking.com |
| BookingTran. Comment | VARCHAR(1000) | Additional Information or comment. | |
| BookingTran. AffiliateName | VARCHAR(1000) | Booking Affiliate Name | |
| BookingTran.AffiliateCode | VARCHAR(1000) | Booking Affiliate Code | |
| BookingTran.* | – | Here * denotes Credit Card Informations like CCLink, CCNo, CCType, CardHolderName, CCExpiryDate,etc | CCLink in encoded with base64_encode. |
| BookingTran.RentalInfo.EffectiveDate | DATETIME | Booking details for particular effective date | 2017-12-25 etc |
| BookingTran.RentalInfo.PackageCode | INT(20) | Package code | 112500000000000001 |
| BookingTran.RentalInfo.PackageName | VARCHAR(1000) | Package Name | European Plan |
| BookingTran.RentalInfo.R oomTypeCode | INT(20) | Unique RoomType Code | 112500000000000006 |
| BookingTran.RentalInfo.R oomTypeName | STRING(1000) | RoomType Name | Grand Sea View Junior Suite |
| BookingTran.RentalInfo.Adult | INT(11) | No. of Adults | 2,3,4 etc |
| BookingTran. RentalInfo.Child | INT(11) | No. of Childs | 2,3,4 etc |
| BookingTran. RentalInfo.Rent | DECIMAL(19,4) | Room rental amount | 1500.43 |
| BookingTran. RentalInfo.Discount | DECIMAL(19,4) | Discount on rental room in amount | 500 |
| BookingTran.Sharer.* | – | Here * denotes Sharer informations like Salutation, FirstName, LastName, Gender, DateOfBirth, SpouseDateOfBirth, WeddingAnniversary, Nationality, Address, City, State, Country, Nationality,Zip Code, Phone, Mobile, Fax, Email,RegistrationNo,IdentityTypeID, IdentityNo, ExpiryDate. | |
| Errors.ErrorCode | – | Response Error Code | 104, 404 etc |
| Errors.ErrorMessage | – | Generate Response Message | Unauthorized Request. etc |
Success
1.Single Booking
{
"Reservations": {
"Reservation": [
{
"BookingTran": [
{
"SubBookingId": "12341254",
"TransactionId": "123400000000001902",
"Createdatetime": "2019-09-04 11:40:30",
"Modifydatetime": "2019-09-04 11:40:30",
"Status": "New",
"IsConfirmed": "1",
"CurrentStatus": "Arrived",
"VoucherNo": "single1276/1",
"PackageCode": "123400000000000001",
"PackageName": "European Plan",
"RateplanCode": "123400000000000001",
"RateplanName": "Sea View Deluxe Room",
"RoomTypeCode": "123400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Start": "2019-09-26",
"End": "2019-09-28",
"ArrivalTime": "12:00:00",
"DepartureTime": "11:00:00",
"CurrencyCode": "USD",
"TotalAmountAfterTax": "976.00",
"TotalAmountBeforeTax": "800.00",
"TotalTax": "176.00",
"TotalDiscount": "0.00",
"TotalExtraCharge": "0.00",
"TotalPayment": "0.00",
"TACommision": "0.00",
"Salutation": "Ms.",
"FirstName": "April",
"LastName": "Myers",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": "Decorah",
"State": "Decorah",
"Country": "IA",
"Nationality": "Malta",
"Zipcode": "52101",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "AprilAMyers@jourrapide.com",
"RegistrationNo" : "",
"IdentityType": "Pan card",
"IdentityNo": "12345667765",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "car",
"PickupDate": "",
"PickupTime": "",
"Source": "BookingEye",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "AA",
"TaxName": "VAT @ 12%",
"TaxAmount": "96.0000"
},
{
"TaxCode": "LT",
"TaxName": "Luxury @ 10%",
"TaxAmount": "80.0000"
}
],
"RentalInfo": [
{
"EffectiveDate": "2019-09-26",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "550.00",
"Rent": "671.00",
"Discount": "0.00"
},
{
"EffectiveDate": "2019-09-27",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "250.00",
"Rent": "305.00",
"Discount": "0.00"
}
],
"Sharer": [
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"RegistrationNo" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
},
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "Two",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"Registration No" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
}
]
}
],
"LocationId": "1124",
"UniqueID": "11241254",
"BookedBy": "BookingEye",
"Salutation": "Ms.",
"FirstName": "Hae ",
"LastName": " Giles ",
"Gender": "Female",
"Address": " Garfield Road ",
"City": "Peoria",
"State": " Peoria ",
"Country": "IL",
"Zipcode": "61614",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "HaeWGiles@jourrapide.com",
"Source": "BookingEye",
"PaymentMethod": "Cash",
"IsChannelBooking": "1"
}
]
}
}
2.Multiple booking :
{
"Reservations": {
"Reservation": [
{
"BookingTran": [
{
"SubBookingId": "11241254",
"TransactionId": "112400000000001902",
"Createdatetime": "2019-09-04 11:40:30",
"Modifydatetime": "2019-09-04 11:40:30",
"Status": "New",
"IsConfirmed": "1",
"VoucherNo": "single1276/1",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RateplanCode": "112400000000000001",
"RateplanName": "Sea View Deluxe Room",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Start": "2019-09-26",
"End": "2019-09-28",
"ArrivalTime": "12:00:00",
"DepartureTime": "11:00:00",
"CurrencyCode": "USD",
"TotalAmountAfterTax": "976.00",
"TotalAmountBeforeTax": "800.00",
"TotalTax": "176.00",
"TotalDiscount": "0.00",
"TotalExtraCharge": "0.00",
"TotalPayment": "0.00",
"TACommision": "0.00",
"Salutation": "Ms.",
"FirstName": "Lilly",
"LastName": "Harper",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Peoria ",
"State": "Peoria",
"Country": "IL",
"Nationality": "Malta",
"Zipcode": "61614",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LillyJHarper@jourrapide.com",
"RegistrationNo" : "",
"IdentiyType": "Pan card",
"IdentityNo": "12345667765",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "car",
"PickupDate": "",
"PickupTime": "",
"Source": "BookingEye",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "AA",
"TaxName": "VAT @ 12%",
"TaxAmount": "96.0000"
},
{
"TaxCode": "LT",
"TaxName": "Luxury @ 10%",
"TaxAmount": "80.0000"
}
],
"RentalInfo": [
{
"EffectiveDate": "2019-09-26",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "550.00",
"Rent": "671.00",
"Discount": "0.00"
},
{
"EffectiveDate": "2019-09-27",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "250.00",
"Rent": "305.00",
"Discount": "0.00"
}
]
}
],
"LocationId": "1124",
"UniqueID": "11241254",
"BookedBy": "BookingEye",
"Salutation": "Ms.",
"FirstName": "Hae ",
"LastName": " Giles ",
"Gender": "Female",
"Address": " Garfield Road ",
"City": "Peoria",
"State": " Peoria ",
"Country": "IL",
"Zipcode": "61614",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "HaeWGiles@jourrapide.com",
"Source": "BookingEye",
"PaymentMethod": "Cash",
"IsChannelBooking": "1"
},
{
"BookingTran": [
{
"SubBookingId": "11241255",
"TransactionId": "123450000000001903",
"Createdatetime": "2019-09-10 11:31:57",
"Modifydatetime": "2019-09-10 11:31:57",
"Status": "New",
"IsConfirmed": "1",
"CurrentStatus": "Arrived",
"VoucherNo": "",
"PackageCode": "12340000000000001",
"PackageName": "European Plan",
"RateplanCode": "123450000000000001",
"RateplanName": "Sea View Deluxe Room",
"RoomTypeCode": "123450000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Start": "2019-09-11",
"End": "2019-09-12",
"ArrivalTime": "12:00:00",
"DepartureTime": "11:00:00",
"CurrencyCode": "USD",
"TotalAmountAfterTax": "6832.00",
"TotalAmountBeforeTax": "5600.00",
"TotalTax": "1232.00",
"TotalDiscount": "0.00",
"TotalExtraCharge": "0.00",
"TotalPayment": "0.00",
"TACommision": "0.00",
"Salutation": "Dr.",
"FirstName": "Ellen",
"LastName": "Novak",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": "",
"State": "",
"Country": "",
"Nationality": "",
"Zipcode": "",
"Phone": "",
"Mobile": "+123 456 7890",
"Fax": "",
"Email": "EllenDNovak@dayrep.com",
"RegistrationNo" : "",
"IdentiyType": "",
"IdentityNo": "",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "",
"PickupDate": "",
"PickupTime": "",
"Source": "Internet Booking Engine",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "AA",
"TaxName": "VAT @ 12%",
"TaxAmount": "672.0000"
},
{
"TaxCode": "LT",
"TaxName": "Luxury @ 10%",
"TaxAmount": "560.0000"
}
],
"RentalInfo": [
{
"EffectiveDate": "2019-09-11",
"PackageCode": "123450000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "123450000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "2",
"Child": "0",
"RentPreTax": "5600.00",
"Rent": "6832.00",
"Discount": "0.00"
}
],
"Sharer": [
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "One",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"RegistrationNo" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
},
{
"Salutation": "Ms.",
"FirstName": "Test",
"LastName": "Two",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Brockway",
"State": "CA",
"Country": "USA",
"Nationality": "Malta",
"Zipcode": "95730",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "LarryLForney@rhyta.com",
"Registration No" : "",
"IdentityTypeID": "894300000000000003",
"IdentityNo": "12345667765",
"ExpiryDate": "",
}
]
}
],
"LocationId": "1234",
"UniqueID": "11241255",
"BookedBy": "Internet Booking Engine",
"Salutation": "Dr.",
"FirstName": "Audrey",
"LastName": "Manuel",
"Gender": "",
"Address": "",
"City": "",
"State": "",
"Country": "",
"Zipcode": "",
"Phone": "",
"Mobile": "+1234567890",
"Fax": "",
"Email": "AudreyJManuel@armyspy.com",
"Source": "Internet Booking Engine",
"IsChannelBooking": "0"
}
],
"CancelReservation": [
{
"LocationId": "1234",
"UniqueID": "11241008-1",
"Status": "Cancel",
"Canceldatetime": "2019-05-08 14:21:16",
"Remark": "Guest want to cancel reservation through Zenrooms",
"VoucherNo": "100335/1"
},
{
"LocationId": "1234",
"UniqueID": "11241008-2",
"Status": "Cancel",
"Canceldatetime": "2019-05-08 14:21:27",
"Remark": "Guest want to cancel reservation through Zenrooms",
"VoucherNo": "100335/2"
},
{
"LocationId": "1234",
"UniqueID": "11241011",
"Status": "Cancel",
"Canceldatetime": "2019-05-08 14:18:57",
"Remark": "Guest want to cancel reservation through Zenrooms",
"VoucherNo": "1253911111/2"
}
]
}
}
3.Modify Booking :
{
"Reservations": {
"Reservation": [
{
"BookingTran": [
{
"SubBookingId": "12345254",
"TransactionId": "123450000000001902",
"Createdatetime": "2019-09-04 11:40:30",
"Modifydatetime": "2019-09-04 11:40:30",
"Status": "Modify",
"IsConfirmed": "1",
"VoucherNo": "single1276/1",
"PackageCode": "123450000000000001",
"PackageName": "European Plan",
"RateplanCode": "112400000000000001",
"RateplanName": "Sea View Deluxe Room",
"RoomTypeCode": "123450000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Start": "2019-09-26",
"End": "2019-09-28",
"ArrivalTime": "12:00:00",
"DepartureTime": "11:00:00",
"CurrencyCode": "USD",
"TotalAmountAfterTax": "976.00",
"TotalAmountBeforeTax": "800.00",
"TotalTax": "176.00",
"TotalDiscount": "0.00",
"TotalExtraCharge": "0.00",
"TotalPayment": "0.00",
"TACommision": "0.00",
"Salutation": "Ms.",
"FirstName": "Valentina",
"LastName": "Riter",
"Gender": "Female",
"DateOfBirth": "",
"SpouseDateOfBirth": "",
"WeddingAnniversary": "",
"Address": "",
"City": " Peoria ",
"State": "Peoria",
"Country": "IL",
"Nationality": "Malta",
"Zipcode": "61614",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "ValentinaNRiter@jourrapide.com",
"IdentiyType": "Pan card",
"IdentityNo": "12345667765",
"ExpiryDate": "",
"TransportationMode": "",
"Vehicle": "car",
"PickupDate": "",
"PickupTime": "",
"Source": "BookingEye",
"Comment": "",
"AffiliateName": "",
"AffiliateCode": "",
"CCLink": "",
"CCNo": "",
"CCType": "",
"CCExpiryDate": "",
"CardHoldersName": "",
"TaxDeatil": [
{
"TaxCode": "AA",
"TaxName": "VAT @ 12%",
"TaxAmount": "96.0000"
},
{
"TaxCode": "LT",
"TaxName": "Luxury @ 10%",
"TaxAmount": "80.0000"
}
],
"RentalInfo": [
{
"EffectiveDate": "2019-09-26",
"PackageCode": "123450000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "123450000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "550.00",
"Rent": "671.00",
"Discount": "0.00"
},
{
"EffectiveDate": "2019-09-27",
"PackageCode": "112400000000000001",
"PackageName": "European Plan",
"RoomTypeCode": "112400000000000001",
"RoomTypeName": "Sea View Deluxe Room",
"Adult": "4",
"Child": "2",
"RentPreTax": "250.00",
"Rent": "305.00",
"Discount": "0.00"
}
]
}
],
"LocationId": "1234",
"UniqueID": "12345254",
"BookedBy": "BookingEye",
"Salutation": "Ms.",
"FirstName": "Valentina",
"LastName": "Riter",
"Gender": "Female",
"Address": "",
"City": "Charlotte",
"State": "Charlotte",
"Country": "NC",
"Zipcode": "28202",
"Phone": "",
"Mobile": "3534",
"Fax": "564564",
"Email": "ValentinaNRiter@jourrapide.com",
"Source": "BookingEye",
"PaymentMethod": "Cash",
"IsChannelBooking": "1"
}
]
}
}
4.Cancel Booking :
{
"Reservations": {
"CancelReservation": [
{
"LocationId": "xxxx",
"UniqueID": "12345228-1",
"Status": "Cancel",
"Canceldatetime": "2019-08-14 16:33:38",
"Remark": "",
"VoucherNo": ""
},
{
"LocationId": "xxxx",
"UniqueID": "12345228-2",
"Status": "Cancel",
"Canceldatetime": "2019-08-14 16:33:24",
"Remark": "",
"VoucherNo": ""
}
]
}
}
Error Codes
| Error Code | Error Name |
| 100 | Missing required parameters. |
| 500 | Error occurred during processing |
| 502 | Request Type is missing |
| 101 | Hotel Code is missing |
| 102 | Authentication Code is missing |
| 301 | Unauthorized Request. Please check hotel code and authentication code |
| 302 | Unauthorized Request. Integration is not allowed |
| 303 | Auth Code is inactive. |
| 201 | Unauthorized request.(Request Type) request is not valid for this hotel code |
| 202 | Unauthorized request. Hotel code is not active |