openapi: 3.1.0
info:
title: Booking.com Demand Accommodations API
version: '3.1'
summary: "The Booking.com Demand API enables Affiliate Partners to access Booking.com's travel inventory, including accommodations, car rentals, and flights. \n\nUse Demand API to search, retrieve details, check availability, manage bookings and run reports using orders details.\n\n- RESTful API with JSON responses.\n- Make HTTPS POST requests to interact with endpoints.\n- Requires authentication using your Affiliate ID and token credentials.\n\n[Check the try out guide!](/demand/docs/getting-started/try-out-the-api)\n"
x-last-validated: '2026-06-02'
x-generated-from: documentation
description: This API collection is specific for the stay part of the connected trip. Use these endpoints to search for stays such as hotels and apartments, check availability, retrieve reviews, and get detailed property information.
servers:
- url: https://demandapi.booking.com/3.1
description: Production environment
- url: https://demandapi-sandbox.booking.com/3.1
description: Sandbox environment
security:
- BearerAuth: []
tags:
- name: Accommodations
x-displayName: Accommodation
description: This API collection is specific for the stay part of the connected trip. Use these endpoints to search for stays such as hotels and apartments, check availability, retrieve reviews, and get detailed property information.
paths:
/accommodations/search:
post:
summary: Booking.com Search Accommodation
description: This endpoint returns, by default, the cheapest available product for each accommodation that matches the specified search criteria.
When you apply location filters using parameters such as country or region id, the results are sorted by Booking.com popularity (top_picks) instead of price.
In this case, accommodations are ranked in descending order of popularity, meaning higher-ranked listings will appear earlier in the response.
operationId: accommodationsSearch
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsSearchInput
type: object
properties:
24_hour_reception:
description: Filter the result based if the front desk reception is available 24/7. When specified true, the result will filter the products where front desk is available 24/7.
type: boolean
accommodation_facilities:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property facility. Examples of facilities are: Parking, Restaurant, Room service etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
accommodation_types:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property type. Examples of accommodation types are: Apartment, Hostel, Hotel etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
accommodations:
type: array
items:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
maxItems: 100
airport:
description: A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.
type: string
pattern: ^[A-Z]{3}$
example: AMS
booker:
title: Booker
description: The booker's information.
type: object
properties:
country:
description: The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees.
type: string
pattern: ^[a-z]{2}$
platform:
description: The booker platform for showing the platform based deals and prices.
type: string
enum:
- android
- desktop
- ios
- mobile
- tablet
state:
description: The booker state for showing the best price for that user and obeying laws regarding the display of taxes and fees. Currently applicable only for country US.
type: string
pattern: ^[a-z]{2}$
travel_purpose:
description: The travel purpose of the booker.
type: string
enum:
- business
- leisure
user_groups:
description: The user groups that the booker is a member of.
type: array
items:
type: string
enum:
- authenticated
required:
- country
- platform
brands:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation brand. Examples of brands are: Radisson Blu, WestCord Hotels, Westin etc. The full list can be obtained by calling /accommodations/chains.'
type: integer
minimum: 1
cancellation_type:
description: Filters the result for the cancellation type specified. Possible values are free_cancellation & non_refundable. If cancellation_type is free_cancellation, the result will contain all the products with free_cancellation.
type: string
enum:
- free_cancellation
- non_refundable
checkin:
description: The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
checkout:
description: The checkout date. Must be later than {checkin}. Must be between 1 and 90 days after {checkin}. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
city:
description: A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.
type: integer
coordinates:
title: AccommodationsSearchCoordinatesOutput
description: Limit the result list to the specified coordinates.
type: object
properties:
latitude:
description: Specify a latitude (as well as a longitude and radius) to do searches around a specific location.
type: number
format: double
longitude:
description: Specify a longitude (as well as a latitude and radius) to do searches around a specific location.
type: number
format: double
radius:
description: The radius is km to search around the specified latitude and longitude.
type: number
format: double
country:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
district:
description: A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.
type: integer
minimum: 1
dormitories:
description: This parameter specifies if the results should include dormitory beds or rooms. The default behaviour will include the dormitory beds or rooms with other results. When this flag is set to 'only', the response will only include dormitory beds or rooms. When this flag is set to 'exclude', the response will exclude dormitory beds or rooms. When this flag is set to 'include', the response will include dormitory beds or rooms with other results.
type: string
default: include
enum:
- include
- exclude
- only
extras:
description: Input parameter to request for additional information about the products.
type: array
items:
type: string
enum:
- extra_charges
- products
guests:
title: AccommodationsGuests
description: The guest details for the request.
type: object
properties:
allocation:
description: The exact allocation of guests to rooms.
type: array
items:
properties:
children:
description: The children ages for this room.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for this room.
type: integer
minimum: 1
required:
- number_of_adults
children:
description: Array with the children ages.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for the search.
type: integer
minimum: 1
number_of_rooms:
description: The number of rooms needed.
type: integer
minimum: 1
required:
- number_of_adults
- number_of_rooms
landmark:
description: A signed integer number that uniquely identifies a relevant geographical landmark, like a monument or a natural attraction. The full list can be obtained by calling common/locations/landmarks.
type: integer
minimum: 1
meal_plan:
description: 'Filter the result based on the selected meal plan. Example: When specified breakfast_included, it will show the product with free breakfast.'
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
page:
description: Pagination token used to retrieve the next page of results. Obtained from `next_page`.
type: string
payment:
description: The payment filter for the request
type: object
properties:
credit_card_required:
description: Filter to show accommodations which require credit card
type: boolean
timing:
description: This parameter specifies that the results should only return accommodation and blocks that contain the specified payment timings.
type: string
enum:
- pay_at_the_property
- pay_online
price:
description: If specified, will return only results where the price *per night* falls in the specified range (inclusive). This filter requires that a currency is passed
type: object
properties:
maximum:
description: Set the maximum price per night, in the specified currency, or omit to indicate no upper limit.
type: integer
minimum:
description: Set the minimum price per night, in the specified currency, or omit to indicate no lower limit.
type: integer
rating:
description: The rating filter for the request
type: object
properties:
minimum_review_score:
description: Show only hotels with review_score >= that. Review score should be in the range 1 to 10.
type: integer
minimum: 0
maximum: 10
stars:
description: Limit to accommodations with the given number(s) of stars. Stars should be in the range of 1 to 5.
type: array
items:
type: number
minimum: 1
maximum: 5
region:
description: A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.
type: integer
minimum: 1
room_facilities:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property room facility. Examples of facilities are: Coffee/Tea maker, TV, Airconditioning, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
rows:
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
maximum: 100
default: 100
sort:
description: The sorting parameters for the response
type: object
properties:
by:
description: 'The way to sort your results. NOTE: When ordering by distance please make sure to specify the latitude and longitude!'
type: string
enum:
- distance
- price
- review_score
- stars
direction:
description: The direction you wish for your sort.by parameter to be sorted in
type: string
enum:
- ascending
- descending
travel_proud:
description: Filter the result based on if the property is LGBTQ+ friendly. When specified true, the result will filter and return only the accommodations that are Proud Certified.
type: boolean
required:
- booker
- checkin
- checkout
- guests
example:
booker:
country: nl
platform: desktop
checkin: '!START_DATE!'
checkout: '!END_DATE!'
city: -2140479
extras:
- extra_charges
- products
guests:
number_of_adults: 2
number_of_rooms: 1
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsSearchOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: AccommodationsSearchDataOutput
description: ''
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
commission:
title: AccommodationsCommission
description: Commission details for the partner for a given accommodation
type: object
properties:
amount:
description: The actual commission amount for the partner.
type: number
format: double
minimum: 0
percentage:
description: Percentage of the fee that will be received as commission.
type: number
format: double
minimum: 0
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
deep_link_url:
description: A mobile app URL that directs the user to a specific page or content within the Booking.com app. The link can only be used on a device with the Booking.com app installed. It typically includes an Affiliate ID (AID) to attribute bookings to the affiliate partner when users are redirected
type: string
format: url
price:
title: AccommodationsSearchProductPrice
description: The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller under local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed price. Equivalent to base + included charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
title: AccommodationsExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
excluded:
description: Charges not included in 'book'.
type: number
format: double
minimum: 0
included:
description: Charges included in 'book'.
type: number
format: double
minimum: 0
total:
description: The total price. Includes all extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
products:
type: array
items:
title: AccommodationsSearchProductOutput
description: Details product information. It requires `{"extras":["products"]}`.
type: object
properties:
id:
description: Unique ID of the product.
type: string
bundle:
description: The bundle ID of the product comprising of value added products.
type: integer
children:
description: The ages of the children allocated to this product.
type: array
items:
type: integer
minimum: 0
maximum: 17
deal:
title: Deal
description: This specifies the deal tagging for the product.
type:
- object
- 'null'
properties:
discount_percentage:
description: Discount percentage of the applied deal.
type: integer
minimum: 1
public_price:
description: Original price of this product, before applying any discounts.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
tags:
description: The tags of all the applied deals.
type: array
items:
type: string
enum:
- black_friday
- limited_time_deal
- logged_in_deal
- mobile_rate
- seasonal_deal
inventory:
title: InventoryOutput
type: object
properties:
third_party:
type: boolean
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type:
description: Type of inventory - either net or sell rates.
type: string
enum:
- net
- sell
number_available_at_this_price:
description: Number of rooms available at this price.
type: integer
minimum: 1
nullable: true
number_of_adults:
description: The number of adults allocated to this product.
type: integer
minimum: 1
policies:
title: AccommodationsProductPolicies
description: The policies for this product.
type: object
properties:
cancellation:
title: AccommodationsProductCancellationPolicy
description: The cancellation policy for this product.
type: object
properties:
free_cancellation_until:
description: Until when the order for this product can be cancelled for free.
type:
- string
- 'null'
format: date-time
type:
description: 'The cancellation policy applicable to this product: "free_cancellation" allows a period for free cancellation, "non_refundable" means immediate loss of total amount, "special_conditions" means partly refundable.'
type: string
enum:
- free_cancellation
- non_refundable
- special_conditions
meal_plan:
title: AccommodationsProductMealPlanPolicy
description: The meal plan policy for this product.
type: object
properties:
meals:
description: The meals included in the meal plan.
type: array
items:
type: string
enum:
- breakfast
- dinner
- lunch
plan:
description: The meal plan included in this product.
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
- no_plan
payment:
title: AccommodationsProductPaymentPolicyNew
description: Payment terms and conditions for this product.
type: object
properties:
prepayment_required:
description: Whether prepayment is required for this product.
type: boolean
timings:
description: The payment timings supported by this product.
type: array
items:
type: string
enum:
- pay_at_the_property
- pay_online_later
- pay_online_now
price:
title: AccommodationsProductPrice
description: The price components of this product. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller under local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed price. Equivalent to base + included charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
title: AccommodationsProductExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
conditional:
description: Charges that might apply under a specific condition.
type: array
items:
title: AccommodationsConditionalCharge
description: Charges that might apply under a specific condition.
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
condition:
description: A signed integer number that uniquely identifies the condition ID. Find the full list in the Pricing guidelines.
type:
- integer
- 'null'
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
excluded:
description: Charges not included in 'book'.
type: array
items:
title: AccommodationsSearchCharge
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
included:
description: Charges included in 'book'.
type: array
items:
title: AccommodationsSearchCharge
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total:
description: The total price. Includes all extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
room:
description: A signed integer number that uniquely identifies an accommodation property room. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
third_party_inventory:
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type: boolean
url:
description: Internet address for the property page on Booking.com.
type: string
format: url
next_page:
description: Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter `page`).
type:
- string
- 'null'
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: 10004
currency: EUR
deep_link_url: booking://hotel/10004?affiliate_id=!AFFILIATE_ID!&checkin=!START_DATE!&checkout=!END_DATE!&mcid=10
price:
base: 1081.49
book: 1260.52
extra_charges:
excluded: 0
included: 179.04
total: 1260.52
products:
- id: '1000420_95127794_2_0_0'
bundle: null
children: []
deal: null
inventory:
third_party: false
type: sell
number_of_adults: 2
policies:
cancellation:
free_cancellation_until: null
type: non_refundable
meal_plan:
meals: []
plan: no_plan
payment:
timings:
- pay_at_the_property
price:
base: 1081.49
book: 1260.52
extra_charges:
conditional: []
excluded: []
included:
- charge: 21
mode: percentage
percentage: 9
total_amount: 107.07
unit_amount: null
- charge: 22
mode: percentage
percentage: 7
total_amount: 83.27
unit_amount: null
- charge: 142
mode: per_person_per_night
percentage: null
total_amount: 6
unit_amount: 3
total: 1260.52
room: 1000426
third_party_inventory: false
url: https://www.booking.com/hotel/nl/conscious-the-tire-station.html?affiliate_id=!AFFILIATE_ID!&checkin=!START_DATE!&checkout=!END_DATE!&group_adults=2&no_rooms=1
- '...'
next_page: '...'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/availability:
post:
summary: Booking.com Check Availability
description: 'Use this endpoint to return detailed product availability, price and charges of the accommodation matching a given search criteria.
By default, only product availability and price is returned. To receive extended information use the `extras` parameter.
Note: It is mandatory to pass the input parameters: accommodation, booker, checkin, checkout and guest.'
operationId: accommodationsAvailability
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsAvailabilityInput
type: object
properties:
accommodation:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
booker:
title: Booker
description: The booker's information.
type: object
properties:
country:
description: The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees.
type: string
pattern: ^[a-z]{2}$
platform:
description: The booker platform for showing the platform based deals and prices.
type: string
enum:
- android
- desktop
- ios
- mobile
- tablet
state:
description: The booker state for showing the best price for that user and obeying laws regarding the display of taxes and fees. Currently applicable only for country US.
type: string
pattern: ^[a-z]{2}$
travel_purpose:
description: The travel purpose of the booker.
type: string
enum:
- business
- leisure
user_groups:
description: The user groups that the booker is a member of.
type: array
items:
type: string
enum:
- authenticated
required:
- country
- platform
checkin:
description: The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
checkout:
description: The checkout date. Must be later than {checkin}. Must be between 1 and 90 days after {checkin}. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
extras:
description: Input parameter to request for additional information about this product.include_bundle_variants must be passed in order to retrieve all value added products.
type: array
items:
type: string
enum:
- extra_charges
- include_bundle_variants
guests:
title: AccommodationsGuests
description: The guest details for the request.
type: object
properties:
allocation:
description: The exact allocation of guests to rooms.
type: array
items:
properties:
children:
description: The children ages for this room.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for this room.
type: integer
minimum: 1
required:
- number_of_adults
children:
description: Array with the children ages.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for the search.
type: integer
minimum: 1
number_of_rooms:
description: The number of rooms needed.
type: integer
minimum: 1
required:
- number_of_adults
- number_of_rooms
payment:
description: Payment input information to filter results.
properties:
timing:
description: This parameter specifies that the results should only return accommodation and blocks that contain the specified payment timings.
type: string
enum:
- pay_at_the_property
- pay_online
products:
type: array
items:
description: Unique ID of the product.
type: string
required:
- accommodation
- booker
- checkin
- checkout
- guests
example:
accommodation: 10004
booker:
country: nl
platform: desktop
checkin: '!START_DATE!'
checkout: '!END_DATE!'
extras:
- extra_charges
guests:
number_of_adults: 2
number_of_rooms: 1
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsAvailabilityOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
title: AccommodationsAvailabilityDataOutput
description: ''
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
deep_link_url:
description: A mobile app URL that directs the user to a specific page or content within the Booking.com app. The link can only be used on a device with the Booking.com app installed. It typically includes an Affiliate ID (AID) to attribute bookings to the affiliate partner when users are redirected
type: string
format: url
products:
type: array
items:
title: AccommodationsAvailabilityProductOutput
description: ''
type: object
properties:
id:
description: Unique ID of the product.
type: string
bundle:
description: The bundle ID of the product comprising of value added products.
type: integer
deal:
title: Deal
description: This specifies the deal tagging for the product.
type:
- object
- 'null'
properties:
discount_percentage:
description: Discount percentage of the applied deal.
type: integer
minimum: 1
public_price:
description: Original price of this product, before applying any discounts.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
tags:
description: The tags of all the applied deals.
type: array
items:
type: string
enum:
- black_friday
- limited_time_deal
- logged_in_deal
- mobile_rate
- seasonal_deal
inventory:
title: InventoryOutput
type: object
properties:
third_party:
type: boolean
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type:
description: Type of inventory - either net or sell rates.
type: string
enum:
- net
- sell
maximum_occupancy:
title: AccommodationsMaximumOccupancy
description: Information related to maximum number of occupancy inside the room.
type: object
properties:
adults:
description: The maximum number of adults for this room.
type: integer
minimum: 1
children:
description: The information about maximum number of children and their allowed ages for this room.
type: array
items:
title: AccommodationsChildren
type: object
properties:
total:
description: The maximum number of children for this room.
type: integer
minimum: 1
from_age:
description: The youngest age of the children allowed in this room.
type: integer
minimum: 0
maximum: 17
to_age:
description: The oldest age of the children allowed in this room.
type: integer
minimum: 0
maximum: 17
free_stay:
description: Whether children in this age bracket will be staying for free. False indicates their cost was already included in the price.
type: boolean
total:
description: The maximum number of guests for this room.
type: integer
minimum: 1
number_available_at_this_price:
description: Number of rooms available at this price.
type: integer
minimum: 1
policies:
title: AccommodationsProductPolicies
description: The policies for this product.
type: object
properties:
cancellation:
title: AccommodationsProductCancellationPolicy
description: The cancellation policy for this product.
type: object
properties:
free_cancellation_until:
description: Until when the order for this product can be cancelled for free.
type:
- string
- 'null'
format: date-time
schedule:
description: The cancellation policy schedule for this product.
type: array
items:
title: AccommodationsProductDetailedCancellationPolicy
type: object
properties:
from:
description: The time from which this cancellation fee applies. `now` means from booking time.
type:
- string
- 'null'
oneOf:
- format: date-time
- pattern: now
price:
description: The cancellation fee.
type: number
format: double
minimum: 0
type:
description: 'The cancellation policy applicable to this product: "free_cancellation" allows a period for free cancellation, "non_refundable" means immediate loss of total amount, "special_conditions" means partly refundable.'
type: string
enum:
- free_cancellation
- non_refundable
- special_conditions
meal_plan:
title: AccommodationsProductMealPlanPolicy
description: The meal plan policy for this product.
type: object
properties:
meals:
description: The meals included in the meal plan.
type: array
items:
type: string
enum:
- breakfast
- dinner
- lunch
plan:
description: The meal plan included in this product.
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
- no_plan
payment:
title: AccommodationsProductPaymentPolicyNew
description: Payment terms and conditions for this product.
type: object
properties:
prepayment_required:
description: Whether prepayment is required for this product.
type: boolean
timings:
description: The payment timings supported by this product.
type: array
items:
type: string
enum:
- pay_at_the_property
- pay_online_later
- pay_online_now
price:
title: AccommodationsAvailabilityProductPrice
description: The price components of this product. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller under local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed price. Equivalent to base + included charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The price that will be charged by Booking.com when online payments are used. This field does not apply to the "pay_at_the_property" timing.
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
title: AccommodationsProductExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
conditional:
description: Charges that might apply under a specific condition.
type: array
items:
title: AccommodationsConditionalCharge
description: Charges that might apply under a specific condition.
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
condition:
description: A signed integer number that uniquely identifies the condition ID. Find the full list in the Pricing guidelines.
type:
- integer
- 'null'
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
excluded:
description: Charges not included in 'book'.
type: array
items:
title: AccommodationsAvailabilityCharge
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
chargeable_online:
description: Whether this charge is chargeable online or not. Not applicable to "pay_at_the_property" timing.
type: boolean
nullable: true
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
included:
description: Charges included in 'book'.
type: array
items:
title: AccommodationsAvailabilityCharge
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
chargeable_online:
description: Whether this charge is chargeable online or not. Not applicable to "pay_at_the_property" timing.
type: boolean
nullable: true
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total:
description: The total price. Includes all extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
room:
description: A signed integer number that uniquely identifies an accommodation property room. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
third_party_inventory:
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type: boolean
recommendation:
title: AccommodationsAvailabilityRecommendationOutput
description: The products recommended for the provided search criteria.
type: object
properties:
price:
title: AccommodationsRecommendationPrice
description: The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller in accordance with local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed amount. Equivalent to base + charges where included_in.display=true.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The amount collected by Booking.com from the Virtual Credit Cards (VCCs) when using online payment methods (e.g., pay_online_now, pay_online_later). Equivalent to `base + charges` where `included_in.chargeable_online=true`. Returns `null` for agency-model properties where Booking.com does not process payments.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
extra_charges:
title: AccommodationsExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
excluded:
description: Charges not included in 'book'.
type: number
format: double
minimum: 0
included:
description: Charges included in 'book'.
type: number
format: double
minimum: 0
total:
description: The total price. Includes all extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
products:
description: ''
type: array
items:
title: AccommodationsAvailabilityRecommendationProductOutput
description: ''
type: object
properties:
id:
description: Unique ID of the product.
type: string
children:
description: The ages of the children allocated to this product.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults allocated to this product.
type: integer
minimum: 1
price:
title: AccommodationsRecommendationPrice
description: The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller in accordance with local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed amount. Equivalent to base + charges where included_in.display=true.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The amount collected by Booking.com from the Virtual Credit Cards (VCCs) when using online payment methods (e.g., pay_online_now, pay_online_later). Equivalent to `base + charges` where `included_in.chargeable_online=true`. Returns `null` for agency-model properties where Booking.com does not process payments.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
extra_charges:
title: AccommodationsExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
excluded:
description: Charges not included in 'book'.
type: number
format: double
minimum: 0
included:
description: Charges included in 'book'.
type: number
format: double
minimum: 0
total:
description: The total price. Includes all extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
url:
description: Internet address for the property page on Booking.com.
type: string
format: url
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
id: 10004
currency: EUR
deep_link_url: booking://hotel/10004?affiliate_id=!AFFILIATE_ID!&checkin=!START_DATE!&checkout=!END_DATE!
products:
- id: '1000420_358188572_2_0_0'
bundle: null
deal: null
inventory:
third_party: false
type: sell
maximum_occupancy:
adults: 2
children: null
total: 2
number_available_at_this_price: 3
policies:
cancellation:
free_cancellation_until: '!START_DATE-2!T00:00:00+00:00'
type: free_cancellation
meal_plan:
meals: []
plan: no_plan
payment:
prepayment_required: false
timings:
- pay_at_the_property
price:
base: 1189.63
book: 1385.97
chargeable_online: 1385.97
extra_charges:
conditional: []
excluded: []
included:
- charge: 21
chargeable_online: true
mode: percentage
percentage: 9
total_amount: 107.07
unit_amount: null
- charge: 22
chargeable_online: false
mode: percentage
percentage: 7
total_amount: 83.27
unit_amount: null
- charge: 142
chargeable_online: true
mode: per_person_per_night
percentage: null
total_amount: 6
unit_amount: 3
total: 1385.97
room: 1000420
third_party_inventory: false
- '...'
recommendation:
price:
base: 1081.49
book: 1260.52
chargeable_online: 1260.52
extra_charges:
excluded: 0
included: 179.04
total: 1260.52
products:
- id: '1000420_95127794_2_0_0'
children: []
number_of_adults: 2
price:
base: 1081.49
book: 1260.52
chargeable_online: 1260.52
extra_charges:
excluded: 0
included: 179.04
total: 1260.52
url: https://www.booking.com/hotel/nl/toren.html?aid=!AFFILIATE_ID!&checkin=!START_DATE!&checkout=!END_DATE!&no_rooms=1&group_adults=2
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/bulk-availability:
post:
summary: Booking.com Check Multiple Availability
description: 'Use this endpoint to retrieve detailed product availability, price and charges of a list of accommodations. By default, only product availability and price is returned.
To receive extended information use the `extras` parameter.
Note: It is mandatory to pass the input parameters: accommodations, booker, checkin, checkout and guests.'
operationId: accommodationsBulkAvailability
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsBulkAvailabilityInput
type: object
properties:
accommodations:
type: array
items:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
booker:
title: Booker
description: The booker's information.
type: object
properties:
country:
description: The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees.
type: string
pattern: ^[a-z]{2}$
platform:
description: The booker platform for showing the platform based deals and prices.
type: string
enum:
- android
- desktop
- ios
- mobile
- tablet
state:
description: The booker state for showing the best price for that user and obeying laws regarding the display of taxes and fees. Currently applicable only for country US.
type: string
pattern: ^[a-z]{2}$
travel_purpose:
description: The travel purpose of the booker.
type: string
enum:
- business
- leisure
user_groups:
description: The user groups that the booker is a member of.
type: array
items:
type: string
enum:
- authenticated
required:
- country
- platform
checkin:
description: The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
checkout:
description: The checkout date. Must be later than {checkin}. Must be between 1 and 90 days after {checkin}. Must be within 500 days in the future and in the format yyyy-mm-dd.
type: string
format: date
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
extras:
description: Input parameter to request for additional information about this product.include_bundle_variants must be passed in order to retrieve all value added products.
type: array
items:
type: string
enum:
- extra_charges
- include_bundle_variants
filters:
title: AccommodationsBulkAvailabilityFiltersInput
description: The filters to apply in this availability request.
type: object
properties:
cancellation_type:
description: Filters the result for the cancellation type specified. Possible values are free_cancellation. The result will contain all the products with free_cancellation.
type: string
enum:
- free_cancellation
meal_plan:
description: 'Filter the result based on the selected meal plan. Example: When specified breakfast_included, it will show the product with free breakfast.'
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
payment:
description: Payment input information to filter results.
properties:
timing:
description: This parameter specifies that the results should only return accommodation and blocks that contain the specified payment timings.
type: string
enum:
- pay_at_the_property
- pay_online
third_party_inventory:
description: Whether to include third party inventory in the response
type: boolean
guests:
title: AccommodationsGuests
description: The guest details for the request.
type: object
properties:
allocation:
description: The exact allocation of guests to rooms.
type: array
items:
properties:
children:
description: The children ages for this room.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for this room.
type: integer
minimum: 1
required:
- number_of_adults
children:
description: Array with the children ages.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults for the search.
type: integer
minimum: 1
number_of_rooms:
description: The number of rooms needed.
type: integer
minimum: 1
required:
- number_of_adults
- number_of_rooms
required:
- accommodations
- booker
- checkin
- checkout
- guests
example:
accommodations:
- 10004
booker:
country: nl
platform: desktop
checkin: '!START_DATE!'
checkout: '!END_DATE!'
extras:
- extra_charges
filters:
meal_plan: breakfast_included
cancellation_type: free_cancellation
guests:
number_of_adults: 2
number_of_rooms: 1
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsBulkAvailabilityOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: AccommodationsBulkAvailabilityDataOutput,
description: ''
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
deep_link_url:
description: A mobile app URL that directs the user to a specific page or content within the Booking.com app. The link can only be used on a device with the Booking.com app installed. It typically includes an Affiliate ID (AID) to attribute bookings to the affiliate partner when users are redirected
type: string
format: url
products:
type: array
items:
title: AccommodationsBulkAvailabilityProductOutput
description: ''
type: object
properties:
id:
description: Unique ID of the product.
type: string
bundle:
description: The bundle ID of the product comprising of value added products.
type: integer
deal:
title: Deal
description: This specifies the deal tagging for the product.
type:
- object
- 'null'
properties:
discount_percentage:
description: Discount percentage of the applied deal.
type: integer
minimum: 1
public_price:
description: Original price of this product, before applying any discounts.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
tags:
description: The tags of all the applied deals.
type: array
items:
type: string
enum:
- black_friday
- limited_time_deal
- logged_in_deal
- mobile_rate
- seasonal_deal
maximum_occupancy:
title: AccommodationsMaximumOccupancy
description: Information related to maximum number of occupancy inside the room.
type: object
properties:
adults:
description: The maximum number of adults for this room.
type: integer
minimum: 1
children:
description: The information about maximum number of children and their allowed ages for this room.
type: array
items:
title: AccommodationsChildren
type: object
properties:
total:
description: The maximum number of children for this room.
type: integer
minimum: 1
from_age:
description: The youngest age of the children allowed in this room.
type: integer
minimum: 0
maximum: 17
to_age:
description: The oldest age of the children allowed in this room.
type: integer
minimum: 0
maximum: 17
free_stay:
description: Whether children in this age bracket will be staying for free. False indicates their cost was already included in the price.
type: boolean
total:
description: The maximum number of guests for this room.
type: integer
minimum: 1
number_available:
description: How many units of this product are still available.
type: integer
minimum: 1
policies:
title: AccommodationsProductPolicies
description: The policies for this product.
type: object
properties:
cancellation:
title: AccommodationsProductCancellationPolicy
description: The cancellation policy for this product.
type: object
properties:
free_cancellation_until:
description: Until when the order for this product can be cancelled for free.
type:
- string
- 'null'
format: date-time
schedule:
description: The cancellation policy schedule for this product.
type: array
items:
title: AccommodationsProductDetailedCancellationPolicy
type: object
properties:
from:
description: The time from which this cancellation fee applies. `now` means from booking time.
type:
- string
- 'null'
oneOf:
- format: date-time
- pattern: now
price:
description: The cancellation fee.
type: number
format: double
minimum: 0
type:
description: 'The cancellation policy applicable to this product: "free_cancellation" allows a period for free cancellation, "non_refundable" means immediate loss of total amount, "special_conditions" means partly refundable.'
type: string
enum:
- free_cancellation
- non_refundable
- special_conditions
meal_plan:
title: AccommodationsProductMealPlanPolicy
description: The meal plan policy for this product.
type: object
properties:
meals:
description: The meals included in the meal plan.
type: array
items:
type: string
enum:
- breakfast
- dinner
- lunch
plan:
description: The meal plan included in this product.
type: string
enum:
- all_inclusive
- breakfast_included
- full_board
- half_board
- no_plan
payment:
title: AccommodationsProductPaymentPolicyNew
description: Payment terms and conditions for this product.
type: object
properties:
prepayment_required:
description: Whether prepayment is required for this product.
type: boolean
timings:
description: The payment timings supported by this product.
type: array
items:
type: string
enum:
- pay_at_the_property
- pay_online_later
- pay_online_now
price:
title: AccommodationsAvailabilityProductPrice
description: The price components of this product. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller under local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed price. Equivalent to base + included charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The price that will be charged by Booking.com when online payments are used. This field does not apply to the "pay_at_the_property" timing.
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
extra_charges:
title: AccommodationsProductExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
conditional:
description: Charges that might apply under a specific condition.
type: array
items:
title: AccommodationsConditionalCharge
description: Charges that might apply under a specific condition.
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
condition:
description: A signed integer number that uniquely identifies the condition ID. Find the full list in the Pricing guidelines.
type:
- integer
- 'null'
minimum: 0
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
excluded:
description: Charges not included in 'book'.
type: array
items:
title: AccommodationsAvailabilityCharge
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
chargeable_online:
description: Whether this charge is chargeable online or not. Not applicable to "pay_at_the_property" timing.
type: boolean
nullable: true
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
included:
description: Charges included in 'book'.
type: array
items:
title: AccommodationsAvailabilityCharge
description: All non-conditional charges that will necessarily be paid
type: object
properties:
charge:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
chargeable_online:
description: Whether this charge is chargeable online or not. Not applicable to "pay_at_the_property" timing.
type: boolean
nullable: true
mode:
description: The mode of this charge. Determines how the price is calculated.
type: string
enum:
- calculated_amount
- incalculable
- percentage
- per_day
- per_night
- per_person_per_day
- per_person_per_night
- per_person_per_stay
- per_stay
percentage:
description: The percentage of 'base' that this charge amounts to. Only applicable when 'mode' is 'percentage'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total_amount:
description: The total price for this charge.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
unit_amount:
description: The price per unit for this charge. Only applicable when 'mode' is 'per_day', 'per_night', 'per_person_per_day', 'per_person_per_night', or 'per_person_per_stay'.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
total:
description: The total price. Includes all extra charges.
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
room:
description: A signed integer number that uniquely identifies an accommodation property room. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
third_party_inventory:
description: Boolean value is "true" if the product is facilitated by a Booking.com partner company and "false" otherwise.
type: boolean
recommendation:
title: AccommodationsBulkAvailabilityRecommendationOutput
description: The products recommended for the provided search criteria.
type: object
properties:
price:
title: AccommodationsRecommendationPrice
description: The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller in accordance with local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed amount. Equivalent to base + charges where included_in.display=true.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The amount collected by Booking.com from the Virtual Credit Cards (VCCs) when using online payment methods (e.g., pay_online_now, pay_online_later). Equivalent to `base + charges` where `included_in.chargeable_online=true`. Returns `null` for agency-model properties where Booking.com does not process payments.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
extra_charges:
title: AccommodationsExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
excluded:
description: Charges not included in 'book'.
type: number
format: double
minimum: 0
included:
description: Charges included in 'book'.
type: number
format: double
minimum: 0
total:
description: The total price. Includes all extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
products:
description: ''
type: array
items:
title: AccommodationsAvailabilityRecommendationProductOutput
description: ''
type: object
properties:
id:
description: Unique ID of the product.
type: string
children:
description: The ages of the children allocated to this product.
type: array
items:
type: integer
minimum: 0
maximum: 17
number_of_adults:
description: The number of adults allocated to this product.
type: integer
minimum: 1
price:
title: AccommodationsRecommendationPrice
description: The price components of this product or selection of products. 'base' and 'extra_charges' are returned only when explicitly requested (via 'extras=extra_charges').
type: object
properties:
base:
description: The base price. It does not include any extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
book:
description: The display price that must be shown to the traveller in accordance with local booker protection laws. This price includes the base accommodation cost and all charges that are legally required to be part of the displayed amount. Equivalent to base + charges where included_in.display=true.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
chargeable_online:
description: The amount collected by Booking.com from the Virtual Credit Cards (VCCs) when using online payment methods (e.g., pay_online_now, pay_online_later). Equivalent to `base + charges` where `included_in.chargeable_online=true`. Returns `null` for agency-model properties where Booking.com does not process payments.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
extra_charges:
title: AccommodationsExtraCharges
description: The charge breakdown. Includes taxes and fees.
type: object
properties:
excluded:
description: Charges not included in 'book'.
type: number
format: double
minimum: 0
included:
description: Charges included in 'book'.
type: number
format: double
minimum: 0
total:
description: The total price. Includes all extra charges.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
url:
description: Internet address for the property page on Booking.com.
type: string
format: url
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: 10004
currency: EUR
deep_link_url: booking://hotel/10004?affiliate_id=!AFFILIATE_ID!&checkin=!START_DATE!&checkout=!END_DATE!
products:
- id: '1000420_358188572_2_0_0'
bundle: null
deal: null
maximum_occupancy:
adults: 2
children: null
total: 2
number_available: 3
policies:
cancellation:
free_cancellation_until: '!START_DATE-2!T00:00:00+00:00'
type: free_cancellation
schedule:
- from: now
price: 0
- from: '!START_DATE-2!T00:00:00+00:00'
price: 1189.63
meal_plan:
meals: []
plan: no_plan
payment:
timings:
- pay_at_the_property
price:
base: 1189.63
book: 1385.97
chargeable_online: 1385.97
extra_charges:
conditional: []
excluded: []
included:
- charge: 21
chargeable_online: true
mode: percentage
percentage: 9
total_amount: 107.07
unit_amount: null
- charge: 22
chargeable_online: false
mode: percentage
percentage: 7
total_amount: 83.27
unit_amount: null
- charge: 142
chargeable_online: true
mode: per_person_per_night
percentage: null
total_amount: 6
unit_amount: 3
total: 1385.97
room: 1000420
third_party_inventory: true
- '...'
recommendation:
price:
base: 1081.49
book: 1260.52
chargeable_online: 1260.52
extra_charges:
excluded: 0
included: 179.04
total: 1260.52
products:
- id: '1000420_95127794_2_0_0'
children: []
number_of_adults: 2
price:
base: 1081.49
book: 1260.52
chargeable_online: 1260.52
extra_charges:
excluded: 0
included: 179.04
total: 1260.52
url: https://www.booking.com/hotel/nl/toren.html?aid=!AFFILIATE_ID!&checkin=!START_DATE!&checkout=!END_DATE!&no_rooms=1&group_adults=2
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/chains:
post:
summary: Booking.com Chains
description: Use this endpoint to retrieve a list of accommodation chains and their associated brands.
A chain-branded accommodation is part of a larger corporate group and operates under a recognised brand. The returned information can be used to filter search results by chain or brand across other endpoints.
- To obtain the full list of chains, call this endpoint with an empty request body.
- The `id` values returned are the codes used as input and output in other API requests, ensuring consistency across your integration.
**Example of chain** - "Radisson Hotel Group" with brands such as "Radisson Blu" or "Park Inn by Radisson."
operationId: accommodationsChains
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Accommodations
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsChainsBrandOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: AccommodationsChainsOutput
description: Returns the internal code, name and list of associated brands for an accommodation chain.
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation chain. Examples of chains are: Radisson Hotel Group, Hilton Worldwide etc. The full list can be obtained by calling /accommodations/chains.'
type: integer
minimum: 1
brands:
description: List of all the brands associated with this accommodation chain.
type: array
items:
title: AccommodationsChainsBrandDataOutput
description: Returns the internal code and name of an accommodation brand.
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation brand. Examples of brands are: Radisson Blu, WestCord Hotels, Westin etc. The full list can be obtained by calling /accommodations/chains.'
type: integer
minimum: 1
name:
description: Name of the accommodation brand.
type: string
name:
description: Name of the accommodation chain.
type: string
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: 3
brands:
- id: 1018
name: Campanile
- '...'
name: Louvre Hotels Group
- '...'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/constants:
post:
summary: Booking.com Constants
description: Use this endpoint to retrieve standardised codes and names for accommodation-specific types, including facilities, room types, bed types, themes, and charges.
These constants can be used to filter searches or populate reference data across other accommodation endpoints.
You can request multiple languages using IETF language tags (see common/languages).
Call with an empty body to retrieve all constants. The codes returned are canonical identifiers used across the API.
operationId: accommodationsConstants
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsConstantsInput
type: object
properties:
constants:
description: Allows to filter the results only for specific sections.
type: array
items:
type: string
enum:
- accommodation_facilities
- accommodation_themes
- accommodation_types
- bed_types
- charge_types
- facility_types
- review_scores
- room_facilities
- room_types
languages:
type: array
items:
description: 'A [IETF language tag code](https://en.wikipedia.org/wiki/IETF_language_tag) that uniquely identifies a supported human language or dialect. **Note:** Demand API only accepts lowercase for the language codes. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
default:
- en-gb
example:
languages:
- en-gb
- zh-cn
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsConstantsOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
title: ConstantsDataOutput
type: object
properties:
accommodation_facilities:
type: array
items:
title: AccommodationsFacilityOutput
description: 'A service, equipment or characteristic available at property level, like for example: "Swimming pool outdoor".'
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation property facility. Examples of facilities are: Parking, Restaurant, Room service etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
facility_type:
description: A signed integer number that uniquely identifies the accommodation facility type. The full list can be obtained by calling accommodations/constants.
type: integer
minimum: 1
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
accommodation_themes:
type: array
items:
title: AccommodationsThemeOutput
description: 'Accommodations can be grouped in "themes" depending on their characteristics. For example: "Beach/Seaside".'
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation property theme. Examples of themes are: Beach/Seaside, Ski/Wintersports, Luxury etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
accommodation_types:
type: array
items:
title: AccommodationsTypeOutput
description: The type of an accommodation. Examples of types are "Hotel", "Apartment", etc.
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation property type. Examples of accommodation types are: Apartment, Hostel, Hotel etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
bed_types:
type: array
items:
title: AccommodationsBedTypeOutput
description: ''
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies a bed type. Examples of bed types are: Single, Double etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
description:
description: Translated description of the bed size in metric.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
description_imperial:
description: Translated description of the bed size in imperial.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
name:
description: Translated name of the bed type.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
charge_types:
type: array
items:
title: AccommodationsChargeTypeOutput
description: These are additional charges, which may be included or excluded from the reservation price. If excluded, the amounts may be added by the property upon checkout. The exclusions depend on several factors like local legislation, and sometimes can only be indicated but not be calculated at the time of the reservation.
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation charge type. Examples of charges are: VAT, City Tax, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 0
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
facility_types:
type: array
items:
title: AccommodationsFacilityTypeOutput
description: A more generic designation meant to group a set of facilities.
type: object
properties:
id:
description: A signed integer number that uniquely identifies the accommodation facility type. The full list can be obtained by calling accommodations/constants.
type: integer
minimum: 1
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
review_scores:
type: array
items:
title: AccommodationsReviewScoreOutput
description: Review score category name for each score interval.
type: object
properties:
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
minimum_score:
description: The minimum score of this review score category.
type: number
multipleOf: 0.1
minimum: 1
maximum: 10
maximum_score:
description: The maximum score of this review score category
type: number
multipleOf: 0.1
minimum: 1
maximum: 10
room_facilities:
type: array
items:
title: AccommodationsRoomFacilityOutput
description: 'A service, equipment or characteristic available at room level, like for example: "Coffee/Tea maker".'
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation property room facility. Examples of facilities are: Coffee/Tea maker, TV, Airconditioning, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
facility_type:
description: A signed integer number that uniquely identifies the accommodation facility type. The full list can be obtained by calling accommodations/constants.
type: integer
minimum: 1
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
room_types:
type: array
items:
title: AccommodationsRoomTypeOutput
description: 'Designations for different types of rooms, based on topology and/or setup. Examples: "Twin/Double" or "Dormitory room".'
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation property room type. Example of room types are: Suite, Apartment, Twin/Double etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
name:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
accommodation_facilities:
- id: 2
facility_type: 16
name:
en-gb: Parking
zh-cn: 停车场
- '...'
accommodation_themes:
- id: 1
name:
en-gb: Apartments
zh-cn: 公寓
- '...'
accommodation_types:
- id: 201
name:
en-gb: Apartment
zh-cn: 公寓
- '...'
bed_types:
- id: 1
description:
en-gb: 90-130 cm wide
zh-cn: 宽 90-130 厘米
description_imperial:
en-gb: 35-51 inches wide
zh-cn: 宽 35-51 英寸
name:
en-gb: Single bed(s)
zh-cn: 单人床
- '...'
charge_types:
- id: 0
name:
en-gb: service charge
zh-cn: 服务费
- '...'
facility_types:
- id: 1
name:
en-gb: General
zh-cn: 综合设施
- '...'
review_scores:
- maximum_score: 2.9
minimum_score: 2
name:
en-gb: very poor
zh-cn: 非常差
- '...'
room_facilities:
- id: 1
facility_type: 7
name:
en-gb: Coffee/Tea maker
zh-cn: 沏茶/咖啡设备
- '...'
room_types:
- id: 1
name:
en-gb: Apartment
zh-cn: 公寓
- '...'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/details:
post:
summary: Booking.com Details
description: 'This endpoint returns detailed information on all accommodation properties matching a given search criteria. By default, only basic information is returned.
It is mandatory to pass one of the input parameters: accommodations, airport, city, country or region.
To receive extended information use the `extras` parameter.'
operationId: accommodationsDetails
parameters:
- in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsDetailsInput
type: object
properties:
accommodation_facilities:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property facility. Examples of facilities are: Parking, Restaurant, Room service etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
accommodation_types:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property type. Examples of accommodation types are: Apartment, Hostel, Hotel etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
accommodations:
type: array
items:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
maxItems: 100
airport:
description: A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.
type: string
pattern: ^[A-Z]{3}$
example: AMS
brands:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation brand. Examples of brands are: Radisson Blu, WestCord Hotels, Westin etc. The full list can be obtained by calling /accommodations/chains.'
type: integer
minimum: 1
city:
description: A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.
type: integer
country:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
extras:
description: Input parameter to request for additional information about the accommodation property. It should be passed as a JSON array with one or more items.
type: array
items:
type: string
enum:
- description
- bundles
- facilities
- payment
- photos
- policies
- rooms
languages:
type: array
items:
description: 'A [IETF language tag code](https://en.wikipedia.org/wiki/IETF_language_tag) that uniquely identifies a supported human language or dialect. **Note:** Demand API only accepts lowercase for the language codes. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
page:
description: Pagination token used to retrieve the next page of results. Obtained from `next_page`.
type: string
payment:
description: Payment input information to filter results.
properties:
timing:
description: This parameter specifies that the results should only return accommodation and blocks that contain the specified payment timings.
type: string
enum:
- pay_at_the_property
- pay_online
region:
description: A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.
type: integer
minimum: 1
rows:
maximum: 1000
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
default: 100
example:
accommodations:
- 10004
extras:
- bundles
- description
- facilities
- payment
- photos
- policies
- rooms
languages:
- en-gb
- zh-cn
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsDetailsOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: AccommodationsDetailsDataOutput
description: All static information related to an accommodation property (excludes information on availability).
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
accommodation_type:
description: 'A signed integer number that uniquely identifies an accommodation property type. Examples of accommodation types are: Apartment, Hostel, Hotel etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
booker_address_required:
description: A boolean indicating whether a booker address is required for the property. If true, a booker address must be provided in the orders/create endpoint. If false, the booker address is not required and can be omitted from the orders/create endpoint.
type: boolean
brands:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation brand. Examples of brands are: Radisson Blu, WestCord Hotels, Westin etc. The full list can be obtained by calling /accommodations/chains.'
type: integer
minimum: 1
bundles:
title: BundlesTranslatedOutput
description: List of value-added bundles offered by this accommodation. Each bundle groups one or more value-added benefits that are included with the stay, such as complimentary services, credits, or special amenities. Bundles are informational only. They cannot be selected, filtered, or booked independently and do not represent a separate rate or product. This field is returned only when `bundles` is included in the `extras` request parameter.
type: array
items:
title: BundleTranslatedOutput
type: object
description: A group of value-added benefits included with the accommodation.
properties:
id:
type: integer
description: Unique identifier of the bundle.
value_adds:
type: array
description: List of value-added benefits included in this bundle. Each value-add represents a single benefit and includes localised descriptive text for display purposes.
items:
title: ValueAddTranslatedOutput
type: object
description: A single value-added benefit included in the bundle, with its type and descriptive text localised in multiple languages.
properties:
type:
description: Identifies the type of value-added benefit included in the bundle, such as complimentary services, monetary credits, percentage discounts, or experiential amenities. Enum values encode how the benefit is applied, including time scope (per day or per stay) and unit scope (per room or per adult).
type: string
enum:
- parking
- food_drink_credit_per_day_per_room
- food_drink_credit_per_day_per_adult
- property_credit_per_day_per_room
- food_drink_credit_per_stay_per_adult
- food_drink_credit_per_stay_per_room
- property_credit_per_day_per_adult
- property_credit_per_stay_per_adult
- property_credit_per_stay_per_room
- food_drink_discount
- property_discount
- early_checkin
- late_checkout
- late_checkin
- spa_daily
- spa_hourly
- spa_massage
- high_speed_internet
- airport_transfer
- safari_game_drive
- safari_walk
- pets_stay
- bottle_of_wine
- bottle_of_champagne
- park_sleep_fly
description:
title: TranslatedStringArray
description: List of descriptive text lines for the value-added service, localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- array
- 'null'
items:
title: TranslatedString
description: A string localised in multiple languages.
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
checkin_checkout_times:
title: AccommodationsCheckinCheckoutTimesOutput
type: object
properties:
checkin_from:
description: The time from when checkin starts at this property.
type:
- string
- 'null'
pattern: (0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:00
checkin_to:
description: The time till when checkin can be done at this property.
type:
- string
- 'null'
pattern: (0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:00
checkout_from:
description: The time from when checkout starts at this property.
type:
- string
- 'null'
pattern: (0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:00
checkout_to:
description: The time till when checkout can be done at this property.
type:
- string
- 'null'
pattern: (0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:00
contacts:
title: AccommodationsContactsOutput
description: Contact information of the accommodation.
type: object
properties:
general:
title: AccommodationsContactOutput
description: Contact information of the accommodation. It can be `null` if the data is missing.
type: object
properties:
email:
description: Email address of the accommodation. It can be `null` if the data is missing.
type:
- string
- 'null'
telephone:
description: Telephone number of the accommodation. It can be `null` if the data is missing.
type:
- string
- 'null'
nullable: true
reservations:
title: AccommodationsContactOutput
description: Contact information of the accommodation. It can be `null` if the data is missing.
type: object
properties:
email:
description: Email address of the accommodation. It can be `null` if the data is missing.
type: string
nullable: true
telephone:
description: Telephone number of the accommodation. It can be `null` if the data is missing.
type: string
nullable: true
nullable: true
currency:
description: A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies.
type: string
pattern: ^[A-Z]{3}$
example: EUR
deep_link_url:
description: A mobile app URL that directs the user to a specific page or content within the Booking.com app. The link can only be used on a device with the Booking.com app installed. It typically includes an Affiliate ID (AID) to attribute bookings to the affiliate partner when users are redirected
type: string
format: url
description:
title: AccommodationsDescriptionOutput
description: Textual information about the accommodation. Requires `{"extras":["description"]}`.
type: object
properties:
host_type:
description: Type of host.
type: string
enum:
- private
- professional
- unknown
important_information:
description: Text containing important information about the property. The value is translated in the requested languages.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
license_numbers:
description: List of all the license numbers of this accommodation property.
type: array
nullable: true
items:
type: string
text:
description: The translated description text of this accommodation property in the requested languages. The maximum number of characters returned may be limited by contract.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
trader:
title: TraderOutput
description: The trader information.
type: object
nullable: true
properties:
address:
description: The address of the trader
title: AccommodationsAddress
type: object
properties:
address_line:
type: string
city:
type: string
country:
type: string
post_code:
type: string
email:
description: The email of the trader
type: string
name:
description: The name of the trader
type: string
registration_number:
description: The registration number of the trader
type: string
telephone:
description: The telephone of the trader
type: string
trade_register:
description: The trade register name
type: string
trader_verified:
description: Indicates whether the trader has successfully met Booking.com's internal verification process, based on established criteria and checklists
type: boolean
facilities:
description: The list of facilities available in this property. Requires `{"extras":["facilities"]}`.
type: array
items:
title: AccommodationsFacilityOutput
description: Facility information for the accommodation.
type: object
properties:
id:
description: 'A signed integer number that uniquely identifies an accommodation property facility. Examples of facilities are: Parking, Restaurant, Room service etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
attributes:
type: array
items:
description: List of optional attributes for this facility.
type: string
enum:
- offsite
- paid
facility_details:
description: Provides detailed information about the facilities available at the accommodation. This data is accessible by including `{"extras":["facilities"]}` in the request.
title: accommodationsFacilityDetailsOutput
type: object
properties:
internet_facility:
description: Details about the internet facilities available at the accommodation, including price, charge mode and connection type.
type: object
title: AccommodationsInternetFacilityOutput
properties:
charge_mode:
type: string
description: The charging model for internet access at the accommodation.
nullable: true
enum:
- charges_are_applicable
- free
- per_day
- per_half_hour
- per_hour
- per_minute
connection_type:
type: string
description: The type of internet connection available, whether wireless (Wi-Fi) or wired.
nullable: true
enum:
- wifi
- wired
coverage:
type: string
description: The extent of the internet coverage within the accommodation, indicating the areas where internet access is available.
nullable: true
enum:
- all_rooms
- business_center
- entire_property
- public_areas
- some_rooms
price:
description: The price for using the internet facility, if applicable.
minimum: 0
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
parking_facilities:
type: array
description: A list of parking facilities available at the accommodation.
items:
title: AccommodationsParkingFacilityOutput
description: Information about the parking facilities available at the accommodation, including pricing, type, location, and reservation requirements.
type: object
properties:
charge_mode:
type: string
description: The charging model for parking, such as per hour, per day, or free.
nullable: true
enum:
- free
- charges_are_applicable
- charges_may_apply
- per_hour
- per_day
- per_week
- per_stay
location:
type: string
description: The location of the parking facility relative to the accommodation (on-site or nearby).
nullable: true
enum:
- on_site
- nearby
price:
description: The price for using the parking facility, if applicable.
minimum: 0
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
reservation:
type: string
description: Indicates whether a reservation is required for parking at the accommodation.
nullable: true
enum:
- needed
- not_needed
- not_possible
type:
type: string
description: The type of parking available, either public or private.
nullable: true
enum:
- private
- public
restaurant_facilities:
type: array
description: A list of restaurant facilities available at the accommodation.
items:
title: AccommodationsRestaurantFacilityOutput
description: Information about the restaurant facilities available at the accommodation.
type: object
properties:
accept_reservations:
description: Indicates whether the restaurant accepts reservations.
type: boolean
guests_only:
description: Indicates whether the restaurant is exclusive to guests or open to the public.
type: boolean
name:
type: string
description: The name of the restaurant.
status:
type: string
description: The operational status of the restaurant (e.g., open or closed).
nullable: true
enum:
- closed
- open
swimming_pool_facilities:
type: array
description: A list of swimming pool facilities available at the accommodation.
items:
title: AccommodationsSwimmingPoolFacilityOutput
description: Details about the swimming pool occupancy limits and options.
type: object
properties:
allowed_age_type:
type: string
description: The age group allowed to use the swimming pool (e.g., adults only, all ages, or kids only).
nullable: true
enum:
- adults_only
- all_ages
- kids_only
payment_type:
type: string
description: The payment model for pool access, either free or paid.
nullable: true
enum:
- free
- paid
type:
type: string
description: The type of swimming pool (indoor, outdoor, or a combination).
nullable: true
enum:
- indoor
- indoor_and_outdoor
- outdoor
fiscal_information:
title: AccommodationsFiscalInformationOutput
description: All fiscal related information of this accommodation property.
type: object
properties:
legal_name:
type: string
vat_number:
type: string
is_genius:
description: Whether the accommodation is genius.
type: boolean
is_work_friendly:
description: '**DEPRECATED**, Flags if this accommodation is work friendly.'
type: boolean
deprecated: true
key_collection_information:
title: AccommodationsKeyCollectionInformationOutput
type: object
properties:
alternate_location:
title: AlternateLocationOutput
description: Alternate location to collect the key of this accommodation property. This is returned if the key to access the property is in another location.
type: object
properties:
address:
type: string
city:
type: string
postal_code:
type: string
checkin_method:
description: An enumeration that describes the conditions for the checkin process and for collecting the key to access the property. This is typically relevant for non-hotel accommodations (like houses or apartments) without a 24 hours front-desk.
type: string
enum:
- door_code
- lock_box
- reception
- secret_spot
- someone_will_meet
- unknown
key_location:
description: Location of the key to access this accommodation property.
type: string
enum:
- at_the_property
- different_place
- unknown
location:
title: AccommodationsLocationOutput
description: All location related information of this accommodation property.
type: object
properties:
address:
description: Translated accommodation address.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
city:
description: A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.
type: integer
coordinates:
title: Coordinates
type: object
properties:
latitude:
type: number
format: double
longitude:
type: number
format: double
country:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
districts:
type: array
items:
description: A signed integer number that uniquely identifies a district. Typically, districts define known areas within a city. The full list can be obtained by calling common/locations/districts.
type: integer
minimum: 1
postal_code:
type: string
regions:
type: array
items:
description: A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.
type: integer
minimum: 1
long_stay_friendly_home:
description: Whether the accommodation is long stay friendly. Applicable only for homes.
type: boolean
meal_prices:
title: MealPrices
description: Details regarding the meal pricing options offered at this accommodation.
type: object
properties:
breakfast:
description: The price of breakfast per person, expressed in the accommodation's local currency. If the value is null, it indicates that breakfast pricing is not available.
type: number
minimum: 0
nullable: true
dinner:
description: The price of dinner per person, expressed in the accommodation's local currency. If the value is null, it indicates that dinner pricing is not available.
type: number
minimum: 0
nullable: true
lunch:
description: The price of lunch per person, expressed in the accommodation's local currency. If the value is null, it indicates that lunch pricing is not available.
type: number
minimum: 0
nullable: true
name:
description: Translated name of the accommodation property.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
number_of_rooms:
description: Total number of rooms in the property. Please note that this is not an availability call and that this number is mostly used to determine the size and type of a property.
type: integer
minimum: 0
payment:
title: AccommodationsPaymentOutput
description: Payment information related to this property. Requires `{"extras":["payment"]}`.
type: object
properties:
methods:
title: AccommodationsDetailsPaymentMethodsOutput
description: Payment methods accepted by this property.
type: object
properties:
cards:
description: Credit cards accepted when paying at the property
type: array
items:
description: A signed integer number that uniquely identifies a payment type. Examples of payment types are the different credit and debit cards. The full list can be obtained by calling common/payments/cards.
type: integer
minimum: 1
cash:
description: Whether this property accepts cash
type: boolean
example: true
virtual_cards:
description: Virtual credit cards accepted when paying at the property
type: array
items:
description: A signed integer number that uniquely identifies a payment type. Examples of payment types are the different credit and debit cards. The full list can be obtained by calling common/payments/cards.
type: integer
minimum: 1
timings:
description: The payment timings supported by this product.
type: array
items:
type: string
enum:
- pay_at_the_property
- pay_online_later
- pay_online_now
cvc_required:
description: Whether cvc is mandatory for creating order for this accommodation.
type: boolean
domestic_no_cc:
description: Whether domestic bookers can book without credit card for products with free cancellation policies.
type: boolean
amex_cvc_required:
description: If amex card is used as payment method to create order for this accommodation, whether cvc is mandatory for that.
type: boolean
photos:
description: List of photos for this accommodation property. The maximum number of photos returned may be limited by contract. Requires `{"extras":["photos"]}`. The photos are returned in no particular order.
type: array
items:
title: AccommodationsPhotoOutput
type: object
properties:
main_photo:
description: Flags this as the main photo. Not returned otherwise.
type: boolean
example: true
tags:
type: array
items:
description: A list of tags associated with the photo. Manually generated.
type: string
example: Bathroom
url:
title: AccommodationsPhotoUrlOutput
type: object
properties:
large:
description: URL of the photo image with a maximum width of 1280 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/max1280/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
standard:
description: URL of the photo image with a maximum width of 500 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/max500/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
thumbnail:
description: URL of the photo thumbnail image with dimensions 100x100 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/100x100/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
thumbnail_large:
description: URL of the photo thumbnail image with dimensions 300x300 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/300x300/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
policies:
title: AccommodationsPoliciesOutput
description: Set of price relevant rules, options and constraints defined by the accommodation for this product. Requires `{"extras":["policies"]}`.
type: object
properties:
cots_and_extra_beds:
description: Prices for cots and extra beds.
type: array
items:
title: PoliciesCotsAndExtraBedsOutput
type: object
properties:
age:
title: AccommodationsPoliciesAgeOutput
description: Ages to which this entry is applicable. Children are aged 0-17. 18/null means adult. The interval is inclusive.
type: object
properties:
from:
type: integer
minimum: 0
maximum: 18
to:
type: integer
minimum: 0
maximum: 18
nullable: true
mode:
description: How the price is applied per cot/extra bed.
type: string
enum:
- per_night
- per_stay
percentage:
description: Non-null when the price is a percentage.
type: number
multipleOf: 0.01
exclusiveMinimum: 0
nullable: true
price:
description: Non-null when the price is fixed or free.
minimum: 0
nullable: true
type: number
format: double
multipleOf: 0.01
exclusiveMinimum: 0
type:
description: Whether this entry relates to a cot or an extra bed.
type: string
enum:
- cot
- extra_bed
maximum_checkin_age:
description: Defines the maximum (inclusive) check-in age for this property. If null, then there is no maximum age for checking in
type: integer
minimum: 18
minimum_checkin_age:
description: Defines the minimum (inclusive) check-in age for this property.
type: integer
minimum: 18
minimum_guest_age:
description: Defines the minimum age (inclusive) for staying in this property. If "0", then a guest of any age is allowed.
type: integer
minimum: 0
pets:
title: AccommodationsPetsPolicyOutput
type: object
properties:
allowed:
description: An enumerated value describing if pets are allowed
type: string
enum:
- 'yes'
- 'no'
- upon_request
charge_mode:
description: An enumerated value describing the charge mode for pets
type: string
enum:
- free
- charges_may_apply
damage:
type: object
description: DamagePolicy of the property
properties:
deposit:
description: If a deposit needs to be paid upfront
type: object
properties:
collect:
properties:
date:
type: object
properties:
reference_date:
type: string
enum:
- checkin
- checkout
days_offset:
description: The number of days on or before reference date.
type: integer
payment_method:
type: string
enum:
- bank_transfer
- cash
- credit_card
- paypal
- other
refund:
properties:
date:
type: object
properties:
reference_date:
type: string
enum:
- checkin
- checkout
days_offset:
description: The number of days on or after reference date.
type: integer
payment_method:
type: string
enum:
- bank_transfer
- cash
- credit_card
- paypal
- other
amount:
description: The amount that can be charged
type: number
format: double
currency:
description: Currency in which payment needs to be made
type: string
price_category:
description: Indicates the qualitative price reference (between $ and $$$$) on how expensive an accommodation is. Accommodations in the same city are sorted by ascending price (average per guest per night in the last month), the ones in the lowest 25 percentile are in category $, between 25 and 50 percentile are in category $$, between 50 and 75 percentile are in category $$$, remaining ones are in category $$$$.
type: string
pattern: '[$]{0,4}'
programmes:
title: AccommodationsProgrammes
description: Details of programmes undergone by the property.
type: object
properties:
travel_proud:
description: Boolean value is "true" if property has travel proud badge and "false" otherwise.
type: boolean
ranking:
description: The public ranking of the accommodation.
type: number
minimum: 0
rating:
title: AccommodationsDetailsRatingOutput
type: object
properties:
number_of_reviews:
description: Number of validated reviews for this accommodation.
type: integer
minimum: 0
preferred:
description: Boolean value is "true" if this accommodation is in the Booking.com's preferred program and "false" otherwise.
type: boolean
example: true
review_score:
nullable: true
description: A decimal number indicating the current review score of this accommodation property, in the range 1..10.
type: number
multipleOf: 0.1
minimum: 1
maximum: 10
stars:
description: Number of stars of this accommodation property.
type: number
format: double
multipleOf: 0.1
nullable: true
minimum: 1
maximum: 5
example: 4
stars_type:
description: An enumerated value describing which type of stars this accommodation has.
type: string
nullable: true
enum:
- estimated_by_accommodation
- estimated_by_booking
- official
rooms:
description: The list of room types available at this property. Requires `{"extras":["rooms"]}`.
type: array
items:
title: AccommodationsDetailsRoomOutput
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property room. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
attributes:
description: Lists a set of attribute qualifiers for this room. Will not be returned if no relevant attributes are applicable.
type: array
items:
type: string
enum:
- non_smoking
- smoking
- work_friendly
bed_options:
description: Lists all possible bedding options for this room or apartment.
type: array
items:
title: AccommodationsBedOptionOutput
description: List of all possible bed arrangements. For apartments and other types of hotel accommodations, beds and bathrooms may be available as separate rooms.
type: object
properties:
bed_configurations:
description: Lists all alternative bed configurations that are supported.
type: array
items:
title: AccommodationsBedConfigurationOutput
description: List of all beds available for this configuration.
type: object
properties:
id:
description: Uniquely identifies this bed configuration.
type: string
configuration:
description: Detail list of all different types and number of beds included in this configuration.
type: array
items:
title: AccommodationsBedOutput
description: Detail information about a type of bed and number of beds included in this configuration.
type: object
properties:
bed_type:
description: 'A signed integer number that uniquely identifies a bed type. Examples of bed types are: Single, Double etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
number_of_beds:
description: Number of similar beds included in this configuration.
type: integer
minimum: 0
has_bathroom:
description: Flags if this area includes its own bathroom.
type: boolean
is_bedroom:
description: Flags if this area is marked as a bedroom, otherwise, it should be considered a living room.
type: boolean
cots_and_extra_beds:
title: AccommodationsRoomsCotsAndExtraBedsOutput
description: Lists room options regarding adding cots and/or extra beds.
type: object
properties:
are_allowed_together:
description: Flags if cots and extra beds can be placed together in the room. `true` allows both up to their maximum limits. `false` requires exclusive choice of either cots or extra beds.
type: boolean
maximum_number_of_cots:
description: Maximum number of cots that can be added.
type: integer
minimum: 0
maximum_number_of_extra_beds:
description: Maximum number of extra beds that can be added.
type: integer
minimum: 0
cribs_and_extra_beds:
title: AccommodationsRoomsCribsAndExtraBedsOutput
description: '**DEPRECATED**, please use ''cots_and_extra_beds''.'
type: object
properties:
are_allowed:
description: Flags if it's possible to add cribs and/or extra beds.
type: boolean
maximum_number_of_cribs:
description: Maximum number of cribs that can be added.
type: integer
minimum: 0
maximum_number_of_extra_beds:
description: Maximum number of extra beds that can be added.
type: integer
minimum: 0
deprecated: true
description:
description: Translated description of this room. The maximum number of characters returned may be limited by contract.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
facilities:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property room facility. Examples of facilities are: Coffee/Tea maker, TV, Airconditioning, etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
maximum_occupancy:
title: AccommodationsDetailsMaximumOccupancyOutput
description: Occupancy limits and options.
type: object
properties:
adults:
description: Maximum number of adults allowed.
type: integer
minimum: 0
children:
description: Maximum number of children allowed (children will be typically defined by being under 18 years of age).
type: integer
minimum: 0
total_guests:
description: '**DEPRECATED** Total capacity of adults + children allowed.'
type: integer
minimum: 0
deprecated: true
name:
description: Translated name of this room.
title: TranslatedString
type: object
patternProperties:
^[a-z]{2}(-[a-z]{2})$:
description: The content localised in this language.
type:
- string
- 'null'
number_of_rooms:
title: AccommodationsNumberOfRoomsOutput
description: Total rooms available.
type: object
properties:
bathrooms:
description: Total number of bathrooms.
type: integer
minimum: 0
bedrooms:
description: Total number of rooms equipped or that can be fitted with a bed.
type: integer
minimum: 0
living_rooms:
description: Total number of rooms without a bed.
type: integer
minimum: 0
photos:
description: List of photos for this accommodation room. The maximum number of photos returned may be limited by contract. Requires `{"extras":["rooms","photos"]}`. The photos are returned in no particular order.
type: array
items:
title: AccommodationsPhotoOutput
type: object
properties:
main_photo:
description: Flags this as the main photo. Not returned otherwise.
type: boolean
example: true
tags:
type: array
items:
description: A list of tags associated with the photo. Manually generated.
type: string
example: Bathroom
url:
title: AccommodationsPhotoUrlOutput
type: object
properties:
large:
description: URL of the photo image with a maximum width of 1280 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/max1280/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
standard:
description: URL of the photo image with a maximum width of 500 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/max500/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
thumbnail:
description: URL of the photo thumbnail image with dimensions 100x100 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/100x100/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
thumbnail_large:
description: URL of the photo thumbnail image with dimensions 300x300 pixels.
type: string
format: url
example: https://q-xx.bstatic.com/xdata/images/hotel/300x300/20934654.jpg?k=806399263699a47361bdbbefc9c872a3db03eea26c4a815f5f4df95c93e38cdb&o=
room_type:
description: 'A signed integer number that uniquely identifies an accommodation property room type. Example of room types are: Suite, Apartment, Twin/Double etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
size:
description: The room area in square meters.
type: number
minimum: 0
example: 20
spoken_languages:
description: Languages spoken by the staff of this accommodation property.
type: array
items:
description: 'A [IETF language tag code](https://en.wikipedia.org/wiki/IETF_language_tag) that uniquely identifies a supported human language or dialect. **Note:** Demand API only accepts lowercase for the language codes. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
themes:
type: array
items:
description: 'A signed integer number that uniquely identifies an accommodation property theme. Examples of themes are: Beach/Seaside, Ski/Wintersports, Luxury etc. The full list can be obtained by calling accommodations/constants.'
type: integer
minimum: 1
url:
description: Internet address for the property page on Booking.com.
type: string
format: url
work_friendly_home:
description: Whether the accommodation is work friendly. Applicable only for homes.
type: boolean
next_page:
description: Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter `page`).
type:
- string
- 'null'
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: 10004
accommodation_type: 204
brands: []
bundles:
- id: 12345
value_adds:
- type: high_speed_internet
description:
en-gb:
- High speed internet throughout your stay.
checkin_checkout_times:
checkin_from: '15:00:00'
checkin_to: null
checkout_from: 07:00:00
checkout_to: '12:00:00'
currency: EUR
deep_link_url: booking://hotel/10004?affiliate_id=!AFFILIATE_ID!
description:
important_information:
en-gb: 'The credit card that has been used to book a non-refundable rate, will be charged on the day of booking and needs to be presented upon check-in. In case the credit card owner is not traveling with you, an online payment link will be sent to prepay your stay.
Please note that the hotel pre-authorizes your credit card with the amount for the first night, 8 days prior to arrival. This is not a payment and this only applies to flexible rates.
Parking in Amsterdam is challenging, there are parking garages near to the hotel or a valet service is possible to arrange upon request. Charges are applicable. Please contact the hotel ahead of time for information'
zh-cn: '酒店将在预订当天收取用于支付不退款房价的信用卡，客人需在办理入住手续时出示该信用卡。如果信用卡持有人未与客人同行，酒店将发送在线付款链接以预付客人的住宿费用。
请注意，酒店将在客人抵达前8天通过其信用卡预授权第一晚的房费。这不是付款，这仅适用于变化的利率。
在阿姆斯特丹（Amsterdam）停车很有挑战性，酒店附近有停车库，或者可应要求为客人安排代客泊车服务，收费适用。请提前联系酒店以获取信息。'
fallback: null
license_numbers: []
text:
en-gb: 'The Pavilions Amsterdam, The Toren features elegant accommodation alongside the famous Keizersgracht canal, around the corner from the Anne Frank House. It offers elegant rooms with flat-screen TVs with digital entertainment system.
Each air-conditioned room at the Toren has an en suite bathroom with a bathtub. They have classic decorations such as chandeliers and ceiling paintings. Tea/coffee making facilities and a complimentary mini bar are also provided in every room.
In the morning, guests can enjoy a delightful breakfast buffet in the elegant breakfast room with views of the Keizersgracht. The trendy hotel bar serves refreshing drinks during the day.
Westermarkt Tram Stop is less than 250 metres from the hotel. Dam Square and the Royal Palace are a 10-minute walk away.'
zh-cn: 'The Pavilions Amsterdam, The Toren酒店位于安妮弗兰克之家（Anne Frank House）拐角处，毗邻著名的Keizersgracht运河，提供典雅的住宿。酒店提供带平板电视和数字娱乐系统的典雅客房。
Toren酒店的每间空调客房均配有带浴缸的独立浴室。客房拥有典雅的装饰，如吊灯和天花板画。每间客房还提供沏茶/咖啡设施和免费迷你吧。
早晨，客人可在典雅的早餐室享用可口的自助早餐，并欣赏Keizersgracht的景色。时髦的酒店酒吧白天提供清凉饮料。
酒店距离韦斯特马克特电车站（Westermarkt Tram Stop）不到250米，距离水坝广场（Dam Square）和皇宫（Royal Palace）有10分钟的步行路程。'
fallback: null
trader:
address:
address_line: Prinsengract 153
city: Amsterdam
country: nl
post_code: '94571'
email: test@test.test
name: Test Test
registration_number: '123456788'
telephone: '+123456789'
trade_register: hjdfvhfjd
trader_verified: true
facilities:
- id: 5
attributes: []
- '...'
is_genius: true
is_work_friendly: false
location:
address:
fallback: Keizersgracht 164
city: -2140479
coordinates:
latitude: 52.375858
longitude: 4.886006
country: nl
districts:
- 145
- 3024
- 9173
postal_code: 1015 CZ
regions:
- 1010
- 2776
long_stay_friendly_home: false
meal_prices:
breakfast: 20
dinner: null
lunch: null
name:
fallback: The Pavilions Amsterdam, The Toren
number_of_rooms: 11
payment:
amex_cvc_required: false
cvc_required: true
domestic_no_cc: false
methods:
cash: true
cards:
- 1
- 2
- 3
virtual_cards:
- 1
- 2
- 3
timings:
- pay_at_the_property
photos:
- main_photo: true
tags:
- Neighbourhood
url:
large: https://q-xx.bstatic.com/xdata/images/hotel/max1280/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
standard: https://q-xx.bstatic.com/xdata/images/hotel/max500/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
thumbnail: https://q-xx.bstatic.com/xdata/images/hotel/100x100/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
thumbnail_large: https://q-xx.bstatic.com/xdata/images/hotel/300x300/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
- '...'
policies:
cots_and_extra_beds:
- age:
from: 0
to: 2
mode: per_night
price: 0
type: crib
damage:
amount: 50
currency: EUR
deposit:
collect:
date:
days_offset: 0
reference_date: checkin
payment_method: credit_card
refund:
date:
days_offset: 0
reference_date: checkout
payment_method: credit_card
maximum_checkin_age: null
minimum_checkin_age: 18
minimum_guest_age: 0
pets:
allowed: 'no'
charge_mode: null
price_category: $$$$
programmes:
travel_proud: false
ranking: 123456
rating:
number_of_reviews: 930
preferred: true
review_score: 9
stars: 4
stars_type: official
rooms:
- id: 1000420
attributes:
- non_smoking
bed_options:
- bed_configurations:
- id: 1000420-1
configuration:
- bed_type: 6
number_of_beds: 1
- id: 1000420-2
configuration:
- bed_type: 1
number_of_beds: 2
has_bathroom: true
is_bedroom: true
cots_and_extra_beds:
are_allowed_together: false
maximum_number_of_cots: 0
maximum_number_of_extra_beds: 0
cribs_and_extra_beds:
are_allowed: false
maximum_number_of_cribs: 0
maximum_number_of_extra_beds: 0
description:
en-gb: This room features decor with rich colours and original features. It is located in the annex building, 8 houses away from the main building. It is internally positioned, overlooking a small courtyard.
fallback: null
facilities:
- 1
- '...'
maximum_occupancy:
adults: 2
children: 1
total_guests: 2
name:
en-gb: Standard Double or Twin Room
zh-cn: '标准双人或双床间 '
fallback: null
number_of_rooms:
bathrooms: 1
bedrooms: 1
living_rooms: 0
photos:
- tags:
- Neighbourhood
url:
large: https://q-xx.bstatic.com/xdata/images/hotel/max1280/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
standard: https://q-xx.bstatic.com/xdata/images/hotel/max500/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
thumbnail: https://q-xx.bstatic.com/xdata/images/hotel/100x100/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
thumbnail_large: https://q-xx.bstatic.com/xdata/images/hotel/300x300/243931754.jpg?k=a1fea83a088f20b8f8a0e68ac06cb0090a093808f6e2a129bfb990165a0009f3&o=
- '...'
room_type: 9
size: 18
- '...'
spoken_languages:
- de
- en-gb
- fr
- nl
themes:
- 6
- '...'
url: https://www.booking.com/hotel/nl/toren.html?affiliate_id=!AFFILIATE_ID!
work_friendly_home: false
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/details/changes:
post:
summary: Booking.com Updated Accommodations
description: Use this endpoint to track accommodations that have opened, closed, or had relevant content updates since a specific timestamp. Changes can include updates to general information, facilities, rooms, photos, payments, and more.
You can:
- Filter results by country or city.
- Use the "next" timestamp from the response to request further updates.
To keep your local accommodation cache up to date, use this endpoint in combination with [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details)
The maximum number of IDs returned is approximately 5000 per request.
operationId: accommodationsDetailsChanges
parameters:
- $ref: '#/components/parameters/AffiliateIdHeader'
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsDetailsChangesInput
type: object
properties:
last_change:
description: 'The timestamp in ISO-8601 format from which changes to accommodations are returned (inclusive). Only UTC time zone is supported. We support changes for last 24 hours. Format: YYYY-MM-DDTHH:mm:ss+00:00'
type: string
format: date-time
filters:
description: parameter basis which filtering needs to be done. Only one of (countries or cities) must be provided.
type: object
properties:
countries:
description: Filter changes based on these countries. The valid full list can be obtained by calling common/locations/countries.
type: array
items:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
cities:
description: Filter changes based on these cities. The valid full list can be obtained by calling common/locations/cities.
type: array
items:
description: A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.
type: integer
required:
- last_change
example:
last_change: '!START_DATE!T12:00:00+00:00'
filters:
countries:
- nl
- es
- in
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsDetailsChangesOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
title: AccommodationDetailsChangesDataOutput
type: object
properties:
changes:
title: AccommodationsDetailsChangesListOutput
description: The list of changed accommodations.
type: object
properties:
changed:
type: array
items:
description: 'Accommodations which have had relevant changes to their content since the given timestamp. Changes being tracked include: general information, standard phrase, photos, payments, facilities and rooms.'
type: integer
closed:
type: array
items:
description: Accommodations which have closed since the given timestamp. Note that these same accommodations may be re-opened shortly after.
type: integer
opened:
type: array
items:
description: Accommodations which have opened since the given timestamp. Note that sometimes accommodations may be closed again shortly after.
type: integer
from:
description: ISO 8601 timestamp which indicates the timestamp from which the changes are returned (inclusive).
type: string
format: date-time
next:
description: 'ISO 8601 timestamp which indicates the next timestamp to be used for `last_change`. This will be 1 second after the latest change returned in the result (all changes from the "last" second are returned). NOTE: this field will not be present unless changes are returned. In this case, repeat the call after one minute with the same `last_change` date.'
type: string
format: date-time
total_changes:
description: Total number of changed accommodation ids returned. If 0, then repeat the call after one minute with the same `last_change` date.
type: integer
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
changes:
changed:
- 403115
- '...'
closed:
- 9876832
- '...'
opened:
- 8034270
- '...'
from: '!START_DATE!T12:00:00+00:00'
next: '!START_DATE!T12:24:42+00:00'
total_changes: 5125
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/reviews:
post:
summary: Booking.com Accommodation Reviews
description: This endpoint provides access to reviews for specified accommodations, allowing you to retrieve traveller feedback associated with a particular property. ✅ The reviews returned can be [filtered and sorted](/demand/docs/accommodations/filter-sorting), with the option to limit the number of reviews per accommodation by specifying the `rows` parameter. Please note that the ratings **score is based on all traveller traffic across Booking.com**, and may not necessarily reflect the experience of your own customers. If you choose to display or use these ratings and reviews, you are responsible for ensuring that your travellers are properly informed about what these scores represent.
operationId: accommodationsReviews
parameters:
- $ref: '#/components/parameters/AffiliateIdHeader'
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsReviewsInput
type: object
properties:
accommodations:
type: array
items:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
maxItems: 100
languages:
description: Limits reviews to those written in this language.
type: array
items:
description: 'An IETF language tag code that uniquely identifies a supported human language or dialect as described here: https://en.wikipedia.org/wiki/IETF_language_tag. Note that in v3 the whole tag is always lowercase. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
last_change:
description: 'Limits the reviews to those changed after the given date. Format: YYYY-MM-DD.'
type: string
format: date
page:
description: Pagination token used to retrieve the next page of results. Obtained from `next_page`.
type: string
reviewer:
title: AccommodationsReviewer
type: object
properties:
countries:
description: Limits reviews to those written by reviewer from the given country.
type: array
items:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
travel_purposes:
description: Limits reviews to those written by specific travel purposes.
type: array
items:
description: Defines if this was a leisure or business trip.
type: string
enum:
- business
- leisure
types:
description: Limits reviews to those written by specific reviewer type.
type: array
items:
description: The reviewer type.
type: string
enum:
- couple
- extended_group
- family_with_children
- solo_traveller
rows:
description: The maximum number of results to return.
type: integer
multipleOf: 10
minimum: 10
maximum: 100
default: 100
score:
title: AccommodationsReviewScoreInput
type: object
properties:
maximum:
description: Limits the reviews to those having score lesser or equal to this value.
type: integer
minimum: 1
maximum: 10
minimum:
description: Limits the reviews to those having score greater or equal to this value.
type: integer
minimum: 1
maximum: 10
required:
- accommodations
example:
accommodations:
- 10004
languages:
- en-gb
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsReviewsOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: AccommodationsReviewsDataOutput
description: ''
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
reviews:
type: array
items:
title: AccommodationsReviewOutput
type: object
properties:
id:
description: Unique identifier of the review.
type: integer
date:
description: 'The date when the review was last modified. Format: YYYY-MM-DD.'
type: string
format: date
language:
description: 'An IETF language tag code that uniquely identifies a supported human language or dialect as described here: https://en.wikipedia.org/wiki/IETF_language_tag. Note that in v3 the whole tag is always lowercase. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
negative:
description: Negative comments from this review.
type:
- string
- 'null'
positive:
description: Positive comments from this review.
type:
- string
- 'null'
reviewer:
title: AccommodationsReviewerOutput
type: object
properties:
country:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
name:
description: Name of the reviewer. If the value is null then the reviewer is anonymous.
type:
- string
- 'null'
travel_purpose:
description: Defines if this was a leisure or business trip.
type: string
enum:
- business
- leisure
type:
description: The reviewer type.
type: string
enum:
- couple
- extended_group
- family_with_children
- solo_traveller
score:
description: The aggregated score of the review.
type: number
multipleOf: 0.1
minimum: 1
maximum: 10
summary:
description: The summary of the review.
type:
- string
- 'null'
text_meets_guidelines:
description: Set to true when review meets the guidelines. The review text will be removed if it doesn't meet guidelines.
type: boolean
url:
description: Internet address for the property page on Booking.com.
type: string
format: url
next_page:
description: Indicates that more results are available. Use this pagination token to retrieve the next page of results (via parameter `page`).
type:
- string
- 'null'
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: 10004
reviews:
- id: 2130645894
date: '2023-04-12'
language: en-gb
negative: 'front entrance is not clean (
breakfast was served not like a buffet, every time you have to ask a waiter to bring additional food.'
positive: beautiful hôtel in the central area
reviewer:
country: ch
name: Svetlana
travel_purpose: leisure
type: couple
score: 9
summary: Fantastic hotel with kind personal who are providing hospitality and excellent service.
text_meets_guidelines: true
- '...'
url: https://www.booking.com/hotel/nl/toren.html?aid=!AFFILIATE_ID!#tab-reviews
next_page: '...'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/accommodations/reviews/scores:
post:
summary: Booking.com Accommodation Review Scores
description: This endpoint returns score distribution and score breakdown for the specified accommodations. The scores information can be filtered by reviewer parameters and languages.
operationId: accommodationsReviewsScores
parameters:
- $ref: '#/components/parameters/AffiliateIdHeader'
tags:
- Accommodations
requestBody:
content:
application/json:
schema:
title: AccommodationsReviewsInput
type: object
properties:
accommodations:
type: array
items:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
maxItems: 100
languages:
description: Limits reviews to those written in this language.
type: array
items:
description: 'An IETF language tag code that uniquely identifies a supported human language or dialect as described here: https://en.wikipedia.org/wiki/IETF_language_tag. Note that in v3 the whole tag is always lowercase. Examples: "nl" for Dutch/Nederlands or "en-us" for English (US). To retrieve the full list of supported languages, call the `/common/languages` endpoint in the same Demand API version you are using.'
type: string
pattern: ^[a-z]{2}(-[a-z]{2})?$
example: en-us
reviewer:
title: AccommodationsReviewer
type: object
properties:
countries:
description: Limits reviews to those written by reviewer from the given country.
type: array
items:
description: 'A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.'
type: string
pattern: ^[a-z]{2}$
example: nl
travel_purposes:
description: Limits reviews to those written by specific travel purposes.
type: array
items:
description: Defines if this was a leisure or business trip.
type: string
enum:
- business
- leisure
types:
description: Limits reviews to those written by specific reviewer type.
type: array
items:
description: The reviewer type.
type: string
enum:
- couple
- extended_group
- family_with_children
- solo_traveller
required:
- accommodations
example:
accommodations:
- 10004
languages:
- en-gb
responses:
'200':
description: Successful response.
content:
application/json:
schema:
title: AccommodationsReviewsOutput
type: object
properties:
request_id:
description: Uniquely identifies the request. Please provide this identifier when contacting support.
type: string
data:
type: array
items:
title: AccommodationsReviewsScoresOutput
description: ''
type: object
properties:
id:
description: A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling [accommodations/details](/demand/docs/open-api/demand-api/accommodations/accommodations/details).
type: integer
minimum: 1
breakdown:
title: AccommodationsReviewsBreakdownOutput
description: 'Review scores breakdown for each criteria. List of criteria includes: cleanliness, comfort, facilities, free_wifi, location, staff, value_for_money.'
type: object
patternProperties:
^(cleanliness|comfort|facilities|free_wifi|location|staff|value_for_money)$:
title: AccommodationsReviewsBreakdownSchemaOutput
type: object
properties:
number_of_reviews:
description: Number of reviews for this criteria.
type: integer
minimum: 0
score:
description: A decimal number indicating the review score of this criteria, in the range 1..10.
type: number
multipleOf: 0.1
minimum: 1
maximum: 10
distribution:
title: AccommodationsReviewsDistributionOutput
description: Overall score distribution for each score (1-10).
type: object
patternProperties:
^[1-9]|10$:
title: AccommodationsReviewsDistributionSchemaOutput
type: object
properties:
number_of_reviews:
description: Number of reviews with this score.
type: integer
minimum: 0
percentage:
description: Percent of score distribution for this score.
type: number
multipleOf: 0.01
number_of_reviews:
description: Number of validated reviews for this accommodation.
type: integer
minimum: 0
score:
description: A decimal number indicating the current review score of this accommodation property, in the range 1..10.
type: number
multipleOf: 0.1
minimum: 1
maximum: 10
url:
description: Internet address for the property page on Booking.com.
type: string
format: url
example:
request_id: 01fr9ez700exycb98w90w5r9sh
data:
- id: 10004
breakdown:
cleanliness:
number_of_reviews: 243
score: 9.27
comfort:
number_of_reviews: 242
score: 9.26
facilities:
number_of_reviews: 242
score: 8.84
free_wifi:
number_of_reviews: 24
score: 8.75
location:
number_of_reviews: 242
score: 9.59
staff:
number_of_reviews: 243
score: 9.63
value_for_money:
number_of_reviews: 243
score: 8.25
distribution:
'1':
number_of_reviews: 1
percentage: 0.41
'2':
number_of_reviews: 0
percentage: 0
'3':
number_of_reviews: 2
percentage: 0.82
'4':
number_of_reviews: 2
percentage: 0.82
'5':
number_of_reviews: 5
percentage: 2.06
'6':
number_of_reviews: 3
percentage: 1.23
'7':
number_of_reviews: 18
percentage: 7.41
'8':
number_of_reviews: 41
percentage: 16.87
'9':
number_of_reviews: 67
percentage: 27.57
'10':
number_of_reviews: 104
percentage: 42.8
number_of_reviews: 243
score: 8.9
url: https://www.booking.com/hotel/nl/toren.html?aid=!AFFILIATE_ID!#tab-reviews
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
parameters:
AffiliateIdHeader:
in: header
name: X-Affiliate-Id
schema:
type: integer
required: true
description: Include here your Affiliate identifier number
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: string
x-tagGroups:
- name: Travel services
tags:
- Accommodations
- Cars
- name: Common
tags:
- Common/locations
- Common/payments
- Common/languages
- name: Orders
tags:
- Orders
- name: Messaging
tags:
- Messages
- Conversations
- Attachments