Introduction
Welcome to the AxisRooms PMS API! You can use our API to integrate your PMS with CM. So that you can update inventory & price updates to Channel Manager.|
Below are some pin points
PIN POINTS
To start the integration kindly integrate below API |
1. Property setup in AxisRooms : This can be done through csv upload (attaching the csv formats in which you can send the property data ) |
Note : There is an OTA connectivity part which we can deal with later |
2. Transactional Updates |
API NO:1 (daywise inventory api) / API NO:2 (bulk inventory update api) |
API NO:6 (daywise price update api) / API NO:7 (bulk price update api ) |
API NO:9 (push booking update at client system) |
The easiest way to get started will be to send us the details of 1 test property in the attached sample csv formats (property,room and rateplan details). We will set it up in our staging environment and you can start with testing out inventory and price updates (We can do the OTA connectivity part once this phase is done ) |
Authentication
To authorize, use this API key:
{"accessKey": "clientAPIKey"}
AxisRooms CM uses API accesskey to allow access to the API.
This clientAPIKey will be provided by Axisrooms.
OTA API expects the API key to be included in all API requests that looks like the following:
{"accessKey":"clientAPIKey"}
PMS API
1.Inventory Update in AxisRooms
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotels": [
{
"hotelId": "H-01",
"rooms": [
{
"roomId": "DLX",
"availability": [
{
"date": "2018-04-13",
"free": 1
},
{
"date": "2018-04-14",
"free": 1
},
{
"date": "2018-04-15",
"free": 1
}
]
},
{
"roomId": "SPD",
"availability": [
{
"date": "2018-04-13",
"free": 1
},
{
"date": "2018-04-14",
"free": 1
},
{
"date": "2018-04-15",
"free": 1
}
]
}
]
}
]
}
Response JSON:
{
"status": "Success/Error",
"message": "",
"errorCode":""
}
This API call will be used to update the daywiseinventory .Client needs to use this API if they have different inventory for each day once we received the request we will update the client with below JSON response. Axisrooms will provide the end-point for this.
HTTP Request
POST https://sandboxE.axisrooms.com/api/daywiseInventory
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call.values are success/failure. |
errorCode | 1/2/3/4/5/6/11/12. |
2.Bulk Inventory Update in AxisRooms
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotels": [
{
"hotelId": "HT-01",
"rooms": [
{
"roomId": "DLX",
"startDate": "2018-04-30",
"endDate": "2018-12-31",
"availability": 5
}
]
}
]
}
Response JSON:
{
"status": "Success/Error",
"message": "",
"errorCode":1
}
This API can be used for updating hotel room inventory for a specified time period in the AxisRooms system.
HTTP Request
POST http://sandboxE.axisrooms.com/api/inventory
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call.values are success/failure. |
errorCode | 1/2/3/4/5/6/11/12. |
3.Block Channel Inventory
Request JSON:
{
"accessKey": "clientAPIKey",
"pmsId": "AxisRoomsClientId",
"channelId": [
1,
9,
12
],
"hotelId": "HT-01",
"startDate": "2018-04-30",
"endDate": "2018-06-25",
"roomId": "DLX"
}
Response JSON:
{
"status": "Success/Error",
"message": "Error Message"
}
This API can be used for blocking hotel room inventory for a specified time period and a particular OTA
HTTP Request
POST http://sandboxE.axisrooms.com/api/blockChannel
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
pmsId | The identifier for the client in AxisRooms |
channelId | Axisrooms will share the OTA list with their id so based on that client can block the inventory |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
4.Unblock Channel Inventory
Request JSON:
{
"accessKey": "clientAPIKey",
"pmsId": "AxisRoomsClientId",
"channelId": [
1
],
"hotelId": "HT-01",
"startDate": "2018-04-30",
"endDate": "2018-06-25",
"roomId": "DLX"
}
Response JSON:
{
"status": "Success/Error",
"message": "Error Message "
}
This API can be used for unblocking hotel room inventory for a specified time period in a particular OTA
HTTP Request
POST http://sandboxE.axisrooms.com/api/unblockChannel
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
pmsId | The identifier for the client in AxisRooms |
channelId | Axisrooms will share the OTA list with their id so based on that client can block the inventory |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
5.Fetch Inventory(OTA WISE)
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"otaId": "2",
"hotelId": "HT-01",
"roomId": "DLX",
"startDate": "2018-04-23",
"endDate": "2018-04-25"
}
Response JSON:
{
"status": "Success/Failure",
"message": "",
"hotelId": "HT-01",
"roomId": "DLX",
"otaId": "2",
"availability": [
{
"date": "2018-04-23",
"free": 1
},
{
"date": "2018-04-24",
"free": 1
},
{
"date": "2018-04-25",
"free": 1
}
]
}
Hosted by the AxisRooms This will be useful to verify that the inventory and prices updated correctly on the AxisRooms system
HTTP Request
POST https://sandboxE.axisrooms.com/api/otaAvailability
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
otaId | Axisrooms will share the OTA list with their id so based on that client can block the inventory |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
6.Price Update in AxisRooms(DAY WISE)
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotels": [
{
"hotelId": "HT-01",
"rooms": [
{
"roomId": "DLX",
"rateplans": [
{
"rateplanId": "RP-1",
"priceDetails": [
{
"date": "2018-04-25",
"otaIds": [ //optional(in case if you want to push the price OTA Wise)
2,
5
],
"price": {
"Double": 2000,
"Single": 2000,
"Triple": 2500, //optional
"Quad": 3000, //optional
"Penta": 3000, //optional
"Hexa": 3000, //optional
"Hepta": 3000, //optional
"Octa": 3000, //optional
"Nine": 3000, //optional
"Ten": 3000, //optional
"Extra Bed": 500,
"Extra Child": 200, //optional
"Extra Adult": 500, //optional
"Extra Infant": 150 //optional
}
},
{
"date": "2018-04-26",
"otaIds": [ //optional(in case if you want to send the price OTA Wise)
2,
5
],
"price": {
"Double": 2000,
"Single": 2000,
"Triple": 2500, //optional
"Quad": 3000, //optional
"Penta": 3000, //optional
"Hexa": 3000, //optional
"Hepta": 3000, //optional
"Octa": 3000, //optional
"Nine": 3000, //optional
"Ten": 3000, //optional
"Extra Bed": 500,
"Extra Child": 200, //optional
"Extra Adult": 500, //optional
"Extra Infant": 150 //optional
}
}
]
}
]
}
]
}
]
}
Response JSON:
{
"status":"Success/Error",
"message": "" //add reason if error
}
Hosted by AxisRooms This API can be used for updating hotel room price for a specified time period in the AxisRooms system Note : The api supports updation of price for multiple room Ids (and hotels) in one call.You can choose to send in price for a single hotel and room.
** At Axisrooms Double Occupacy Price is mandatory.
HTTP Request
POST https://sandboxE.axisrooms.com/api/daywisePrice
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
ratePlanId | rateplan id in client system |
otaIds | Axisrooms will share the list of OtaIds |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
7.Bulk Price Update in Axisrooms
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotels": [
{
"hotelId": "HT-01",
"rooms": [
{
"roomId": "DLX",
"rateplans": [
{
"rateplanId": "RP-1",
"otaIds": [ //optional(in case if you want to send the Price OTA Wise)
9,
2,
3
],
"priceDetails": [
{
"endDate": "2018-04-30",
"startDate": "2018-08-28",
"price": {
"Double": 2500,
"Single": 2000,
"Triple": 2500,//optional
"Quad": 3000,//optional
"Penta": 3000,//optional
"Hexa": 3000,//optional
"Extra Bed": 500,
"Extra Child": 200,//optional
"Extra Adult": 500,//optional
"Extra Infant": 150,//optional
"Extra Child (5-18) yrs": 200 //optional
}
}
]
}
]
}
]
}
]
}
Response JSON:
{
"status":"Success/Error",
"message": "" //add reason if error
}
Hosted by AxisRooms This API can be used for updating hotel room price for a specified time period in the AxisRooms system Note : The api supports updation of price for multiple room Ids (and hotels) in one call.You can choose to send in price for a single hotel and room. Ota Ids is optional if you want to push same price for all OTA in that case do not push otaid filed in the json request.
** At Axisrooms Double Occupacy Price is mandatory.
HTTP Request
POST http://sandboxE.axisrooms.com/api/bulkPriceUpdate
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
ratePlanId | rateplan id in client system |
otaIds | Axisrooms will share the list of OtaIds |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
8 Fetch Price(OTA WISE)
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"otaId": "2",
"hotelId": "HT-01",
"roomId": "DLX",
"rateplanId": "RP-1",
"startDate": "2018-04-25",
"endDate": "2018-04-26"
}
Response JSON:
{
"status": "Success/Failure",
"message": "",
"hotelId": "SV",
"roomId": "SV_CO",
"rateplanId": "CP",
"otaId": "2",
"priceDetails": [
{
"date": "2018-04-25",
"price": {
"Double": 2300,
"Single": 2000,
"Triple": 2500,
"Quad": 3000,
"Extra Bed": 500,
"Extra Child": 200,
"Extra Adult": 500,
"Extra Adult 2": 500,
"Extra Adult 3": 500
}
},
{
"date": "2018-04-26",
"price": {
"Double": 2300,
"Single": 2000,
"Triple": 2500,
"Quad": 3000,
"Extra Bed": 500,
"Extra Child": 200,
"Extra Adult": 500,
"Extra Adult 2": 500,
"Extra Adult 3": 500
}
}
]
}
Hosted by AxisRooms This API can be used for fetch the price for perticular OTA ** At Axisrooms Double Occupacy Price is mandatory.
HTTP Request
POST http://sandboxE.axisrooms.com/api/otaRates
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
otaId | Axisrooms will share the list of OtaIds |
ratePlanId | rateplanId at client system |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
9.Bookings Update in Client system
Request JSON:
{
"BookingDetails": {
"bookedBy": "test test ",
"bookingDateTime": "2019-06-20 12:33:27",
"bookingNo": "ARK00000USEP",
"bookingSource": "AxisRooms",
"bookingSourceRefId": "",
"bookingStatus": "confirmed",
"hotelId": "DIHRAY",
"ota": "AxisRooms",
"otaRefId": "1"
},
"CheckinDetails": {
"amountToBeCollected": "",
"checkInDate": "2019-06-21",
"checkOutDate": "2019-06-22",
"children": "0",
"isDayWisePrice": true,
"isGeniusBooker": false,
"paid": "false",
"specialRequest": [],
"supplierAmount": "1108.23",
"taxes": "55.55",
"totalAmount": "1166.55",
"totalPax": "2"
},
"GuestDetails": {
"countryCode": "",
"emailId": "tejaswini.m@axisrooms.com",
"guestName": "test test ",
"mobileNo": "7842842078",
"title": ""
},
"Rates": {
"roomType": [
{
"cityTax": "NA",
"dayWiseDetails": [
{
"date": "2019-06-21",
"deals": "NA",
"rate": "1111.0"
}
],
"id": "SR",
"noOfRooms": "1",
"ratePlanId": "BAR",
"ratePlanName": "RO",
"serviceCharge": "NA",
"totalAdults": "2",
"vat": "NA"
}
]
},
"accessKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Response JSON:
{
"status":"success",
"message":"Booking Update Received"
}
Hosted by the partner’s system This API is for updating bookings on partner’s system.The booking details happening on OTAs will be sent from AxisRooms by calling this API
Note : This is a sample API and is subject to change depending on specific requirements of the integrating partner’s system.
Data under roomType array is OTAs Specific If we will get the details from OTA we will push you the same Other wise that perticular json tag will set as "NA"
HTTP Request
POST <end point need to build at client system >
Query Parameters for Request
Parameter | Description |
---|---|
bookedBy | booker name |
bookingDate | booking date |
bookingNo | booking id for that booking |
bookingStatus | booking status should be confirmed/modified/cancelled |
bookingSource | source of booking |
bookingSourceRefId | this can be usefull if the booking is from GO-MMT & Desiya |
hotelId | PMS hotel id for that property |
ota | OTA name |
otaRefId | ota id which is already mapped at Axisrooms(Axisroom will share the ota ids list) |
supplierAmount | this is supplier amount |
checkInDateTime | check in date for that booking |
checkOutDateTime | checkout date for that bookings |
amountTobeCollected | this will come when you get paid field value as partial. |
children | children count |
paid | value should be true/false/partial |
isDayWisePrice | value should be true/false |
isGeniusBooker | value should be true/false |
specialRequest | exist if any special reuest receive from OTA |
taxes | taxe value for that booking |
totalAmount | total amount for that booking |
totalPax | total adult count |
countryCode | Country code |
emailId | email id |
guestName | guest full name |
mobileNo | mobile number of that booking |
title | guest title name |
id | room id in client's system |
noOfRooms | total number of rooms |
ratePlanId | rateplan id which we mapped as same as client system rateplan id |
rateplanName | rate plan name |
totalAdults | number of total adults |
dayWiseDetails | To get the per day rate,deals (its may based on OTAs), this can be a empty array also. |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
10.No Show Enable for BCOM
Request JSON:
{
"bookingId": "XXXXXXX",
"channelId":"AxisRoomsClientId",
"productId": "HT-01"
}
Response JSON:
{
"message":"Request Process Successfully : Booking Id : XXXXXX",
"status":"Success/failure",
"errorCode":""
}
Hosted by AxisRooms This API can be used to set the no show enable at Booking.com only
HTTP Request
POST http://sandboxE.axisrooms.com/api/bookingNoShowEnable
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
BookingId | OTA booking ID |
channelId | The identifier for the client in AxisRooms |
ProductId | PMS HotelId |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
11.Update MLOS in Axisrooms
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotels": [
{
"hotelId": "HT-01",
"rooms": [
{
"roomId": "DLX",
"rateplans": [
{
"rateplanId": "RP-1",
"mlosDetails": [
{
"startDate": "2018-04-03",
"endDate": "2018-04-05",
"otaIds": [9],// pass only booking.com/expedia/go-mmt ota id
"minlos": "1",
"maxlos": "2", ///optional
"Dow": [1,2,3,4,5,6,7] //// Mon = 1, all days if not
}
]
}
]
}
]
}
]
}
Response JSON:
{"status":"Success/Error","message":"","errorCode":""}
Hosted by AxisRooms By this API Client can set the MLOS value for the MLOS supported OTAs
HTTP Request
POST http://sandboxE.axisrooms.com/api/updateMlos
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | Alpha numeric key for authentication given to Client.We will provide different keys for diffferent environments(if applicable).If wrong key is sent ,we will send back a 401 error . |
channelId | The identifier for the client in AxisRooms |
hotelId | The hotelId in the client’s system |
roomId | The roomId in the client’s system. |
rateplanId | The rateplanId in the client’s system. |
otaIds | Axisrooms will share the list of otaIds |
startDate | yyyy-MM-dd |
endDate | yyyy-MM-dd |
minlos | minimum length of stay |
maxlos | maximum lenght of stay |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
12. Pull Booking from Axisrooms
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotelId":"HT-01",
"startDate":"21/03/2018",
"endDate":"30/03/2018"
}
Response JSON:
{
"BookingDetails": {
"bookedBy": "XYZ",
"bookingDate": "23/03/2018 07:19:12",
"cancelledDate":"20/02/2014 13:40:38",//(only for cancelled)
"modifiedDate":"21/02/2014 13:40:38",//(only for modified)
"bookingNo": "1701248481",
"bookingStatus": "confirmed/modified/cancelled",
"hotelId": "77",
"ota": "Booking.com",
"otaRefId": "9"
},
"CheckinDetails": {
"amount": "1189.15",
"checkInDateTime": "06/04/2018",
"checkOutDateTime": "07/04/2018",
"children": "0",
"paid": "false/true/partial",
"taxes": "100.86",
"totalAmount": "1399.0",
"totalPax": "2"
},
"GuestDetails": {
"emailId": "xyz@guest.booking.com", //optional
"guestName": "XYZ ABC",
"mobileNo": "+66 97 016 2349", //optional
"title": ""//optional
},
"Rates": {
"roomType": [
{
"adults": 2, //optional
"checkInDate": "06/04/2018", //optional
"checkOutDate": "07/04/2018", //optional
"children": 0, //optional
"id": "CLBC",
"mealPlan": "<meal plan information>", //optional
"noOfRooms": "1",
"ratePlanId": "RP-1",
"ratePlanName": "EP",
"roomRate": "1399/NA"//optional
}
]
}
}
Hosted by AxisRooms By this API client can fetch the booking only for 10 days
HTTP Request
POST http://sandboxE.axisrooms.com/api/pullBooking
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
accessKey | unique key at axisrooms |
channelId | this is unique channelId at axisrooms |
hotelId | hotel id at client side |
startDate | dd/MM/yyyy |
endDate | dd/MM/yyyy |
Query Parameters for Response
Parameter | Description |
---|---|
bookedBy | booker name |
bookingDate | booking date |
bookingNo | booking id for that booking |
bookingStatus | booking confirmation (confirmed/modification/cancellation) |
hotelId | PMS hotel id for that property |
ota | OTA name |
otaRefId | ota id which is already mapped at Axisrooms(Axisroom will share the ota ids list) |
amount | this is supplier amount |
checkInDateTime | check in date for that booking |
checkOutDateTime | checkout date for that booking |
children | children count |
paid | true/false/partial |
taxes | taxe value for that booking |
totalAmount | total amount for that booking |
totalPax | total adult count |
emailId | email id |
guestName | guest full name |
mobileNo | mobile number of that booking |
title | guest title name |
13. GET CONNECTED OTA from Axisrooms by CHANNEL_ID
Request JSON:
Response JSON:
[{
"channels": [
{
"channelId": 1,
"channelName": "AxisRooms"
},
{
"channelId": 59,
"channelName": "Goomo"
}
],
"hotelId": "XYZ",
"hotelName": "XYXYX YXXYXY"
}
]
Hosted by AxisRooms By this API client can fetch the booking only for 10 days
HTTP Request
GET https://sandboxE.axisrooms.com/api/getConnectedChannel?pmsId=XYZ
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
pmsId | unique Id at axisrooms |
Query Parameters for Response
Parameter | Description |
---|---|
channelId | OTA ID |
channelName | OTA Name |
HotelId | PMS PropertyID |
HotelName | Property Name at Axisrooms |
14. Update Ota Credentials by PmsId
Request JSON:
{
"hotelList": [
{
"channelList": [
{
"channelId": 47,
"channelName": "CHANNEL NAME",
"password": "XYZ",
"userName": "abc"
}
],
"hotelId": "9876"
}
],
"pmsId": "XYZ"
}
Response JSON:
{
"message": "credentials updated successfully",
"success": "true"
}
Hosted by AxisRooms By this API client can fetch the booking only for 10 days
HTTP Request
POST http://sandboxE.axisrooms.com/api/updateOTACredentials
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
pmsId | unique Id at axisrooms |
HotelId | String |
channelId | Number |
channelName | String |
userName | alphanumeric value |
password | alphanumeric value |
Query Parameters for Response
Parameter | Description |
---|---|
channelId | OTA ID |
channelName | OTA Name |
HotelId | PMS PropertyID |
HotelName | Property Name at Axisrooms |
15. Update Ota Restrictions(MLOS|CTA|CTD|Open/Close)
Request JSON:
{
"accessKey": "clientAPIKey",
"channelId": "AxisRoomsClientId",
"hotels": [
{
"hotelId": "HT-01",
"rooms": [
{
"roomId": "DLX",
"rateplans": [
{
"rateplanId": "RP-1",
"mlosDetails": [
{
"startDate": "2018-04-03",
"endDate": "2018-04-05",
"otaIds": [//optional
9
],
"minlos": "1",
"maxlos": "2",
"Dow": [ //MON:1 ,all day if not mention
1,
2,
3,
4,
5,
6,
7
]
}
],
"restrictions": [
{
"startDate": "2018-04-03",
"endDate": "2018-04-05",
"otaIds": [//optional
9
],
"resType": "Master/CTA/CTD",
"reStatus": "close/open",
"Dow": [
1,
2,
3,////MON:1 ,all day if not mention
4,
5,
6,
7
]
}
]
}
]
}
]
}
]
}
Response JSON:
{"status":"Success/Error","message":"","errorCode":""}
Hosted by AxisRooms By this API client can fetch the booking only for 10 days
HTTP Request
POST http://sandboxE.axisrooms.com/api/cm-restrictions
E - > indicates the environment number(ex: 1,2,3,4,5..) of the sandbox. Please contact tech team for the number.
Query Parameters for Request
Parameter | Description |
---|---|
Master | Open and Close rateplan |
CTA | Close to Arrival |
CTD | Close to Departure |
Query Parameters for Response
Parameter | Description |
---|---|
message | Description for failure. Empty or pass any information if in case of success. |
status | Status of the API call. Expected values are success/failure. |
Errors Codes
AxisRooms PMS API uses the following error codes:
Error Code | Meaning |
---|---|
400 | Bad Request. |
401 | Unauthorized. Incorrect API key. |
403 | Forbidden Error. |
404 | URL Not Found. |
500 | Internal Server Error, try again later. |
503 | Service Unavailable. |
1 | data parsing error |
2 | channel(pms client id) id missing |
3 | channel(pms client) not mapped |
4 | authentication fail |
5 | Hotel id not mapped |
6 | room id not mapped |
12 | rate plan id not mapped |
Update-Mlos
Description | Message |
---|---|
If OTA id (otaIds) attribute is not passed then below error is displayed. | message: Update mlos error. |
If MLOS is updated for not supported OTA, the below error message is displayed. | message: Update mlos error :MLOS is updated only for Booking.com,Expedia,GoIbibo Channels. |
If hotel id is not mapped/wrongly mapped in Channel manager, then below error message is displayed. | message: Update mlos error :hotelId XXX not mapped in Channel Manager. Please contact support team. |
If Room id is wrongly mapped then below error message is displayed. | message: Update mlos error :roomId XXX not mapped for hotelId XXX in Channel Manager. Please contact support team. |
If Rateplan id is wrongly mapped then below error message is displayed. | message: Update mlos error :roomId XXX not mapped for hotelId XXX in Channel Manager. Please contact support team. |
Cm-Restrictions
Description | Message |
---|---|
If Close/Open rate request sent for non-supported OTA’s then below message is displayed. | message: no ota connected. |
If the rate plan is not mapped/wrongly mapped, then the below error message is displayed. | message: rateplanId mapping issue occurred, Please contact support team. |