Get availability
Retuns Booking Availability
Header
Content-Type: application/x-www-form-urlencoded
POST
/Availability
&
/AvailabilityMulti
There are 2 availability calls with the same parameters. The difference is that the first (/Availability) returns results for one room to accommodate all the rooms requests with total prices based on the occupancy request. E.g. for two rooms for adults=1 and adults=2 only rooms that can accommodate the maximum adults in the request ,in this case 2, will be in the results with the total price to book two rooms of the same type. The second (/AvailabilityMulti) returns different rooms for each room request with the addition of the room request number in the results hosted in the response parameter room_request, room_request is not part of the (/Availability) response.
Body
api_version=1
&hotels=899,1,1174
&start_date=2016-01-21
&end_date=2016-01-23
&party=[{"adults":2, "children" : [ 1 ]}]
&lang=en_US
¤cy=EUR
&user_country=GR
&booking_source=1
&promo_code=thePromoParameter
| Field | Type | Description | Mandatory |
|---|---|---|---|
| api_version | number | The version of the API used by this request. Set to 1 | true |
| hotel | String | comma seperated list of hotels to search | true |
| start_date | String | The user's check-in date in YYYY-MM-DD | true |
| end_date | String | The user's check-out date in YYYY-MM-DD | true |
| party | Party array | Array of JSON objects including number of adults and children requested. Each party object represents the occupation for a separate room. For example, "party":[{"adults": 3}] is a request for one room that accommodates three adults, or "party":[{"adults": 2},{"adults": 2, "children": [11,8]}] is a request for one room for two adults and one room for two adults and two children aged 11 and 8. | true |
| lang | String | Language code (see Supported Languages), which identifies the corresponding language and POS. | true |
| user_country | String | SO 3166-1 alpha-2 country code corresponding to the user making this request. Can include and exclude rates base on rate setup | false |
| booking_source | Number | a number defined by bookonlinenow that can be used to differentiate the rate and promotion provided. If not specified the public available rates and promotion will be retuned | False |
| promo_code | String | a string defined by bookonlinenow that can be used to differentiate the rates and promotion provided. | false |
| currency | String | ISO 4217 currency code. All prices, taxes, fees, and discount amounts should be returned in this requested currency. | true |
Success Response (200)
| Field | Type | Description | Mandatory |
|---|---|---|---|
| api_version | number | Version of the API used. | true |
| hotel | String | Echo the hotels list | true |
| start_date | String | The user's check-in date in YYYY-MM-DD | true |
| end_date | String | Echo the check-out date | true |
| party | Party array | Echo the party array | true |
| lang | String | Language code The language of the response, if language not available English are returned | true |
| user_country | String | Echo the user country | true |
| currency | String | Echo the currency. | true |
| hotels | Hotels array | Object of all offers per hotel listed in hotel_ids | true |
Hotels
| Field | Type | Description | Mandatory |
|---|---|---|---|
| hotelid | number | the unique hotelid | true |
| room_types | RoomType array | An array of objects detailing the different kinds of rooms that are available for the entire party. The short description must be unique for each room type available in the hotel. | true |
RoomType
| Field | Type | Description | Mandatory |
|---|---|---|---|
| room_request | string | party request that the room accommodates based on the number of rooms in the party array | true only for /AvailabilityMulti |
| name | string | Short description of the room type. | true |
| board_type | string | RO:room Only, BB:Bed&Breakfast, HB:Half Board, FB:Full Board, AI: All Inclusive | true |
| final_price_at_booking | Price object | Contains the entire price to be paid at time of booking, including taxes and fees. | true |
| final_price_at_checkout | Price object | Contains the entire price to be paid at checkout (usually city taxes) | true |
| profit_margin | Price object | this is the profit margin (the amount of discount you get of the original price) | true |
| description | string | Contains information about room | true |
| rooms_available | Number | The number of rooms remaining/available. | true |
| partner_data | object | Must be provide provided when a booking submit request is sent. to validate the request | true |
| line_items | LineItem array | Contains the detailed breakdown of charges. An array of LineItem objects will contain a separate LineItem for each of rate, tax, and fee types. | true |
| photos | Photo array | An array of photo objects for the room | true |
| cancellation | Cancellation | Specifies the penalty users have to pay at time of cancellation. | true |
| occupancy | Occupancy | The occupancy for this room | true |
| discounts | array of discounts | the discounts applied | true |
Price
| Field | Type | Description | Mandatory |
|---|---|---|---|
| amount | number | The value of the price. | true |
| currency | string | ISO 4217 currency code for the price. | true |
LineItem
| Field | Type | Description | Mandatory |
|---|---|---|---|
| price | Price | Contains the price of the line item. | true |
| type | string | "net_rate" - Net rate or "vat" - VAT amount | true |
| paid_at_checkout | boolean | true, if specific lineItem is to be paid at hotel; false, if it has to be paid at booking time. | true |
| description | string | A textual description of the charge. | true |
Photo
| Field | Type | Description | Mandatory |
|---|---|---|---|
| url | string | URL for the image. | true |
| width | number | Width in pixels of full size image | false |
| height | number | Height in pixels of full size image | false |
| description | string | A textual description of the charge. | true |
Cancellation
| Field | Type | Description | Mandatory |
|---|---|---|---|
| policy | string | text to describe the cancellation policy. | false |
| penalties | Penalty array | Array to describe the costs user has to pay if the rate is being cancelled. | true |
Penalty
| Field | Type | Description | Mandatory |
|---|---|---|---|
| from | string | Date determined from which time stamp this penalty is applied. Must be in ISO-8601 format, e.g. 2015-05-25T16:00:00+0000 | true, if penalty is not applied from the starting time of a booking. |
| penalties | Price | Object containing amount & currency of the fee the user has to pay if rate is being cancelled. | true |
Occupancy
| Field | Type | Description | Mandatory |
|---|---|---|---|
| standard_persons | integer | The standard occupancy for this room | true |
| max_persons | integer | The maximum number of persons (adults and children) allowed to stay in the room. | true |
| max_adults | integer | The maximum number of adults allowed to stay in the room. | true |
| max_children | integer | The maximum number of children allowed to stay in the room | true |
| max_children_age | integer | The maximum age for a person to be considered as child | true |
Discount
| Field | Type | Description | Mandatory |
|---|---|---|---|
| marketing_text | string | A short description of the discount | true |
| final_rate | number | Tthe total amount of the discount | true |
Response
{
"api_version": 1,
"hotel_ids": "899",
"start_date": "2019-11-01",
"end_date": "2019-11-02",
"lang": "en_US",
"currency": "EUR",
"party": [
{
"adults": 2,
"children": [
1
]
}
],
"hotels": [
{
"hotel_id": 899,
"room_types": [
{
"name": "Two-unit Suite-Saver : Early Bird Promotion",
"final_price_at_booking": {
"amount": 129.0,
"currency": "EUR"
},
"final_price_at_checkout": {
"amount": 15.5,
"currency": "EUR"
},
"profit_margin": {
"amount": 36.0,
"currency": "EUR"
},
"description": "The rooms are spacious, furnished with modern design and decoration and are equipped with all modern facilities and amenities. View: City viewRoom Size: 67 sq/m roomBeds: 1 large double, 1 single bed and 1 sofa bed",
"rooms_available": 4,
"partner_data": {
"hotelID": "899",
"roomType": "3025",
"ratetype": "8775",
"rateDetail": "33949",
"price": "129",
"discount": "6986",
"discount2": "0"
},
"occupancy": {
"standard_persons": 4,
"max_persons": 4,
"max_adults": 4,
"max_children": 2,
"max_children_age": 12
},
"line_items": [
{
"price": {
"amount": 117.0,
"currency": "EUR"
},
"type": "net_rate",
"paid_at_checkout": false,
"description": "Total amount at check-in"
},
{
"price": {
"amount": 12.0,
"currency": "EUR"
},
"type": "vat",
"paid_at_checkout": false,
"description": "Total tax at check-in"
},
{
"price": {
"amount": 0.5,
"currency": "EUR"
},
"type": "city_tax",
"paid_at_checkout": true,
"description": "city tax"
},
{
"price": {
"amount": 15.0,
"currency": "EUR"
},
"type": "service_fee",
"paid_at_checkout": true,
"description": "cleaning"
}
],
"photos": [
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/family-hotel-cork-city.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/Triple-Room-2048x1024.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/4.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/images3.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/images2.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/01IMG_TS_7919.jpg",
"width": 500,
"height": 300
}
],
"cancellation": {
"policy": "This rate is available only on a non-refundable basis. \nFull prepayment is required for this special rate. Upon booking entire stay amount will be charged to your credit card (full prepayment). The reservation is non changeable and, in case of cancellation, modification or non-show the prepayment is non refundable.\n",
"penalties": [
{
"fee": {
"amount": 117.0,
"currency": "EUR"
}
}
]
},
"discounts": [
{
"marketing_text": "",
"final_rate": 63.0
}
]
},
{
"name": "Deluxe Apartment-Saver : Early Bird Promotion",
"final_price_at_booking": {
"amount": 215.0,
"currency": "EUR"
},
"final_price_at_checkout": {
"amount": 15.5,
"currency": "EUR"
},
"profit_margin": {
"amount": 60.0,
"currency": "EUR"
},
"description": "3 Bedrooms - accommodates up to 6 personGroundfloor: 1 twin beds bedroom, shower WC, kitchen, living room. Upper floor: 1 Double bed bedroom, 1 twin bed bedroom, bathroom with bathtub, balcony. Extra facilities: Private swimming pool, dishwasher",
"rooms_available": 7,
"partner_data": {
"hotelID": "899",
"roomType": "3026",
"ratetype": "8775",
"rateDetail": "33950",
"price": "215",
"discount": "6986",
"discount2": "0"
},
"occupancy": {
"standard_persons": 6,
"max_persons": 6,
"max_adults": 6,
"max_children": 2,
"max_children_age": 12
},
"line_items": [
{
"price": {
"amount": 195.0,
"currency": "EUR"
},
"type": "net_rate",
"paid_at_checkout": false,
"description": "Total amount at check-in"
},
{
"price": {
"amount": 20.0,
"currency": "EUR"
},
"type": "vat",
"paid_at_checkout": false,
"description": "Total tax at check-in"
},
{
"price": {
"amount": 0.5,
"currency": "EUR"
},
"type": "city_tax",
"paid_at_checkout": true,
"description": "city tax"
},
{
"price": {
"amount": 15.0,
"currency": "EUR"
},
"type": "service_fee",
"paid_at_checkout": true,
"description": "cleaning"
}
],
"photos": [
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/9d7510205d2616cb23d2.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/60af54122f254401ea3b.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/c982be60be86587be748.jpg",
"width": 500,
"height": 300
}
],
"cancellation": {
"policy": "This rate is available only on a non-refundable basis. \nFull prepayment is required for this special rate. Upon booking entire stay amount will be charged to your credit card (full prepayment). The reservation is non changeable and, in case of cancellation, modification or non-show the prepayment is non refundable.\n",
"penalties": [
{
"fee": {
"amount": 195.0,
"currency": "EUR"
}
}
]
},
"discounts": [
{
"marketing_text": "",
"final_rate": 105.0
}
]
},
{
"name": "Junior Elegance Suite-Saver : Early Bird Promotion",
"final_price_at_booking": {
"amount": 222.0,
"currency": "EUR"
},
"final_price_at_checkout": {
"amount": 15.5,
"currency": "EUR"
},
"profit_margin": {
"amount": 62.0,
"currency": "EUR"
},
"description": "The rooms are spacious, furnished with modern design and decoration and are equipped with all modern facilities and amenitiesView: Port viewRoom Size: 45 sq/m roomBeds: 1 large double and 1 single bed",
"rooms_available": 6,
"partner_data": {
"hotelID": "899",
"roomType": "3023",
"ratetype": "8775",
"rateDetail": "33947",
"price": "222",
"discount": "6986",
"discount2": "0"
},
"occupancy": {
"standard_persons": 4,
"max_persons": 4,
"max_adults": 4,
"max_children": 2,
"max_children_age": 12
},
"line_items": [
{
"price": {
"amount": 202.0,
"currency": "EUR"
},
"type": "net_rate",
"paid_at_checkout": false,
"description": "Total amount at check-in"
},
{
"price": {
"amount": 20.0,
"currency": "EUR"
},
"type": "vat",
"paid_at_checkout": false,
"description": "Total tax at check-in"
},
{
"price": {
"amount": 0.5,
"currency": "EUR"
},
"type": "city_tax",
"paid_at_checkout": true,
"description": "city tax"
},
{
"price": {
"amount": 15.0,
"currency": "EUR"
},
"type": "service_fee",
"paid_at_checkout": true,
"description": "cleaning"
}
],
"photos": [
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/isrotel-tower-hotel.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/Junior-Suite-City-View2.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/junior-city-view-double.jpg",
"width": 500,
"height": 300
}
],
"cancellation": {
"policy": "This rate is available only on a non-refundable basis. \nFull prepayment is required for this special rate. Upon booking entire stay amount will be charged to your credit card (full prepayment). The reservation is non changeable and, in case of cancellation, modification or non-show the prepayment is non refundable.\n",
"penalties": [
{
"fee": {
"amount": 202.0,
"currency": "EUR"
}
}
]
},
"discounts": [
{
"marketing_text": "",
"final_rate": 108.0
}
]
},
{
"name": "Master Suite -Saver : Early Bird Promotion",
"final_price_at_booking": {
"amount": 343.0,
"currency": "EUR"
},
"final_price_at_checkout": {
"amount": 15.5,
"currency": "EUR"
},
"profit_margin": {
"amount": 96.0,
"currency": "EUR"
},
"description": "The Master Suites feature large furnished terrace with seating and dining area perfect for enjoying romantic sunsets or a delicious dinner. They include kitchen, WC, shower and lovely bedroom has a king size bed, work desk and luxurious open bathroom with bathtub with Jacuzzi and shower.View: Sea viewRoom Size: 45sq.m. roomBeds: 1 double ,3rd person in sofa bed Max Persons: 2+1extras",
"rooms_available": 10,
"partner_data": {
"hotelID": "899",
"roomType": "3024",
"ratetype": "8775",
"rateDetail": "33948",
"price": "343",
"discount": "6986",
"discount2": "0"
},
"occupancy": {
"standard_persons": 3,
"max_persons": 3,
"max_adults": 3,
"max_children": 2,
"max_children_age": 12
},
"line_items": [
{
"price": {
"amount": 312.0,
"currency": "EUR"
},
"type": "net_rate",
"paid_at_checkout": false,
"description": "Total amount at check-in"
},
{
"price": {
"amount": 31.0,
"currency": "EUR"
},
"type": "vat",
"paid_at_checkout": false,
"description": "Total tax at check-in"
},
{
"price": {
"amount": 0.5,
"currency": "EUR"
},
"type": "city_tax",
"paid_at_checkout": true,
"description": "city tax"
},
{
"price": {
"amount": 15.0,
"currency": "EUR"
},
"type": "service_fee",
"paid_at_checkout": true,
"description": "cleaning"
}
],
"photos": [
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/17E_113_Presidential_Suite_ELYSIUM.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/17F_114_Presidential_Suite_ELYSIUM.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/17G_115_Presidential_Suite_ELYSIUM.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/18_601_Elite_Club_Reception_ELYSIUM.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/20180529_145113.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/20180529_145149.jpg",
"width": 500,
"height": 300
},
{
"url": "https://demov3.book-onlinenow.net/Webpages/899/20180529_150225.jpg",
"width": 500,
"height": 300
}
],
"cancellation": {
"policy": "This rate is available only on a non-refundable basis. \nFull prepayment is required for this special rate. Upon booking entire stay amount will be charged to your credit card (full prepayment). The reservation is non changeable and, in case of cancellation, modification or non-show the prepayment is non refundable.\n",
"penalties": [
{
"fee": {
"amount": 312.0,
"currency": "EUR"
}
}
]
},
"discounts": [
{
"marketing_text": "",
"final_rate": 168.0
}
]
}
]
}
]
}