openapi: 3.0.1
info:
title: Expedia Group EPS Deposit Bookings Content API
description: 'The EPS Deposit API manages the deposit policy for a property, offering operations to create/update, read and delete it.
To start experimenting, please use your existing EQC credentials and properties. We''ve also made the following test credentials available: EQCtest12933870 / ew67nk33 assigned to test property ID 12933870.'
contact:
name: Expedia Partner Services
url: https://expediaconnectivity.com/developer
email: eqcss@expedia.com
version: '1.0'
servers:
- url: https://services.expediapartnercentral.com/
security:
- Basic: []
tags:
- name: Content
description: This section outlines the API calls available to you to access property content.
paths:
/properties/content:
get:
tags:
- Content
summary: Expedia Group Property Content
description: 'Search property content for active properties in the requested language.
When searching with query parameter, `property_id`, you may request 1 to 250 properties at a time.
When searching with query parameters other than `property_id`, the response will be paginated. See the `Link`
header in the 200 response section.
The response is a JSON map where the key is the property ID and the value is the property object itself, which
can include property-level, room-level and rate-level information.
'
operationId: getPropertyContent
parameters:
- name: Accept
in: header
description: 'Specifies the response format that the client would like to receive back. This must be `application/json`.
'
required: true
schema:
type: string
example: application/json
- name: Accept-Encoding
in: header
description: 'Specifies the response encoding that the client would like to receive back. This must be `gzip`.
'
required: true
schema:
type: string
example: gzip
- name: User-Agent
in: header
description: 'The `User-Agent` header string from the customer''s request, as captured by your integration. If you are
building an application then the `User-Agent` value should be `{app name}/{app version}`.
'
required: true
schema:
type: string
example: TravelNow/3.30.112
- name: Customer-Session-Id
in: header
description: 'Insert your own unique value for each user session, beginning with the first API call. Continue to pass the
same value for each subsequent API call during the user''s session, using a new value for every new customer
session.
Including this value greatly eases EPS''s internal debugging process for issues with partner requests, as it
explicitly links together request paths for individual user''s session.
'
schema:
type: string
- name: language
in: query
description: 'Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit
language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes.
See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options)
'
required: true
schema:
type: string
examples:
English:
value: en-US
Cantonese:
value: zh-HK
- name: supply_source
in: query
description: "Options for which supply source you would like returned in the content response. This parameter may only be\nsupplied once and will return all properties that match the requested supply source. An error is thrown if\nthe parameter is provided multiple times.\n * `expedia` - Standard Expedia supply.\n * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their\nprofile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for\nmore information.\n"
required: true
schema:
type: string
examples:
Standard:
value: expedia
VRBO:
value: vrbo
- name: all_inclusive
in: query
description: "Search to include properties that have the requested `all_inclusive` values equal to true. If this parameter\nis not supplied, all `all_inclusive` scenarios are included. This parameter can be supplied multiple times\nwith different values, which will include properties that match any of the requested scenarios.\n * `all_rate_plans` - Return properties where `all_inclusive.all_rate_plans` is true.\n * `some_rate_plans` = Return properties where `all_inclusive.some_rate_plans` is true.\n"
schema:
type: array
items:
type: string
examples:
Optional:
value: null
All:
value: all_rate_plans
- name: amenity_id
in: query
description: 'The ID of the amenity you want to search for. This parameter can be supplied multiple times with different
values, which will include properties that match any of the requested amenity IDs. This is currently only
capable of searching for property level amenities. Room and rate level amenities cannot be searched on.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Elevator:
value: 8
Multiple:
value:
- 115
- 43
- name: attribute_id
in: query
description: 'The ID of the attribute you want to search for. This parameter can be supplied multiple times with different
values, which will include properties that match any of the requested attribute IDs.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Pets:
value: 51
Multiple:
value:
- 5058
- 5059
- name: brand_id
in: query
description: 'The ID of the brand you want to search for. This parameter can be supplied multiple times with different
values, which will include properties that match any of the requested brand IDs.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Hyatt:
value: 11210
Multiple:
value:
- 1
- 11210
- name: business_model
in: query
description: "Search for properties with the requested business model enabled. This parameter can be supplied multiple\ntimes with different values, which will return all properties that match any of the requested business\nmodels. The value must be lower case.\n * `expedia_collect` - Return only properties where the payment is collected by Expedia.\n * `property_collect` - Return only properties where the payment is collected at the property.\n"
schema:
type: array
items:
type: string
enum:
- expedia_collect
- property_collect
examples:
Optional:
value: null
Single:
value: expedia_collect
- name: category_id
in: query
description: 'Search to include properties that have the requested
[category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If
this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times
with different values, which will include properties that match any of the requested category IDs.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Single:
value: 1
Multiple:
value:
- 1
- 2
- name: category_id_exclude
in: query
description: 'Search to exclude properties that do not have the requested
[category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If
this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times
with different values, which will exclude properties that match any of the requested category IDs.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Single:
value: 1
Multiple:
value:
- 1
- 2
- name: chain_id
in: query
description: 'The ID of the chain you want to search for. These chain IDs can be positive and negative numbers. This
parameter can be supplied multiple times with different values, which will include properties that match any
of the requested chain IDs.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Single:
value: -6
Multiple:
value:
- 1
- 2
- name: country_code
in: query
description: 'Search for properties with the requested country code, in ISO 3166-1 alpha-2 format. This parameter can be
supplied multiple times with different values, which will include properties that match any of the requested
country codes.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Single:
value: US
Multiple:
value:
- US
- CA
- name: date_added_end
in: query
description: 'Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
'
schema:
type: string
examples:
Optional:
value: null
Recent:
value: '2023-09-21'
- name: date_added_start
in: query
description: 'Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
'
schema:
type: string
examples:
Optional:
value: null
Recent:
value: '2023-09-20'
- name: date_updated_end
in: query
description: 'Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
'
schema:
type: string
examples:
Optional:
value: null
Recent:
value: '2023-09-21'
- name: date_updated_start
in: query
description: 'Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
'
schema:
type: string
examples:
Optional:
value: null
Recent:
value: '2023-09-20'
- name: include
in: query
description: "Each time this parameter is specified will add to the list of fields and associated objects returned in the\nresponse. All values and field names are lower case. The values `property_ids` and `catalog` will continue\nto behave as specified below for backwards compatibility. All other top level field names will add the\nspecified field to the list of fields returned in the response. See the response schema for a full list of\ntop level field names. Additionally, the field `property_id` will always be returned regardless of what\ninclude values are passed.
\nPossible values:\n * `property_ids` - ***DEPRECATED*** - Please use `property_id` which matches the response field name.\n * `catalog` - Include all property catalog fields. See\n [Property Catalog File endpoint](https://developers.expediagroup.com/docs/rapid/resources/rapid-api#get-/files/properties/catalog)\nfor a list of fields.\n * `property_id` - Passing in the value `property_id` and no other values will limit the response to only\n `property_id`. Not necessary to include in combination with other field name values, as it will always\n be returned.\n * All field names found at the top level of the property content response are now valid values for\n inclusion.\n"
schema:
type: array
items:
type: string
examples:
IncludeAll:
value: null
Single:
value: images
Multiple:
value:
- images
- address
- name: multi_unit
in: query
description: "Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit\nproperties will be included.\n * `true` - Include only properties that are multi-unit.\n * `false` - Do not include properties that are multi-unit.\n"
schema:
type: boolean
examples:
Optional:
value: null
Single:
value: false
- name: property_id
in: query
description: 'The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
'
schema:
type: array
items:
type: string
examples:
Single:
value: 1337
Multiple:
value:
- 1337
- 1
- name: property_rating_max
in: query
description: 'Search for properties with a property rating less than or equal to the requested rating. The highest
property rating value is 5.0.
'
schema:
type: string
examples:
Optional:
value: null
Single:
value: 5.0
- name: property_rating_min
in: query
description: 'Search for properties with a property rating greater than or equal to the requested rating. The lowest
property rating value is 0.0.
'
schema:
type: string
examples:
Optional:
value: null
Single:
value: 3.5
- name: spoken_language_id
in: query
description: 'The id of the spoken language you want to search for. This parameter can be supplied multiple times with
different values, which will include properties that match any of the requested spoken languages. The
language code as a subset of BCP47 format.
'
schema:
type: array
items:
type: string
examples:
Optional:
value: null
Single:
value: en
Multiple:
value:
- zh-yue
- vi
- name: billing_terms
in: query
description: 'This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed,
the value for this will be provided to you separately.
'
schema:
type: string
- name: partner_point_of_sale
in: query
description: 'This parameter is to specify what point of sale is being used to shop and book. If this field is needed, the
value for this will be provided to you separately.
'
schema:
type: string
- name: payment_terms
in: query
description: 'This parameter is to specify what terms should be used when being paid for a resulting booking. If this
field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: platform_name
in: query
description: 'This parameter is to specify what platform is being used to shop and book. If this field is needed, the
value for this will be provided to you separately.
'
schema:
type: string
responses:
'200':
description: OK
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
Link:
description: 'Contains a single link to get the immediate next page of results, and follows the
[IETF standard](https://tools.ietf.org/html/rfc5988). To get the next page of results, simply follow
the `next` URL in this header without modifying it. This header will be missing when there are no
further pages. If the link expires, there will be an `expires` link-extension that is the UTC date the
link will expire, in ISO 8601 format.
'
schema:
type: string
example: ; rel="next"; expires=2023-06-29T20:15:05.324083439Z
Pagination-Total-Results:
description: Contains the total number of property objects found.
schema:
type: number
example: 743
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/PropertyContent'
examples:
Single Property Example:
value:
'12345':
property_id: '12345'
name: Test Property Name
address:
line_1: 123 Main St
line_2: Apt A
city: Springfield
state_province_code: MO
state_province_name: Missouri
postal_code: '65804'
country_code: US
obfuscation_required: false
localized:
links:
es-ES:
method: GET
href: https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345
fr-FR:
method: GET
href: https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345
ratings:
property:
rating: '3.5'
type: Star
guest:
count: 48382
overall: '3.1'
cleanliness: '4.2'
service: '1.1'
comfort: '4.3'
condition: '1.6'
location: '4.0'
neighborhood: '3.4'
quality: '3.4'
value: '2.2'
amenities: '1.4'
recommendation_percent: 73%
location:
coordinates:
latitude: 37.158451
longitude: -93.268382
obfuscated_coordinates:
latitude: 37.159532
longitude: -93.271681
obfuscation_required: false
phone: 1-417-862-0153
fax: 1-417-863-7249
category:
id: '1'
name: Hotel
rank: 42
business_model:
expedia_collect: true
property_collect: false
checkin:
24_hour: 24-hour check-in
begin_time: 3:00 PM
end_time: 11:00 PM
instructions: Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />
special_instructions: There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.
min_age: 18
checkout:
time: 11:00 AM
fees:
mandatory: 'You''ll be asked to pay the following charges at the hotel:
- Deposit: USD 50 per day
- Resort fee: USD 29.12 per accommodation, per night
The hotel resort fee includes:- Fitness center access
- Internet access
- Phone calls
- Additional inclusions
We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.
'
optional: 'Fee for in-room wireless Internet: USD 15 per hour (rates may vary) Airport shuttle fee: USD 350 per vehicle (one way) Rollaway bed fee: USD 175 per night'
policies:
know_before_you_go: Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation. Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. Only registered guests are allowed in the guestrooms. Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
attributes:
general:
'3357':
id: '3357'
name: Caters to adults only
'2549':
id: '2549'
name: No elevators
pets:
'51':
id: '51'
name: Pets allowed
'2809':
id: '2809'
name: Dogs only
'3321':
id: '3321'
name: Pet maximum weight in kg is - 24
value: 24
amenities:
'9':
id: '9'
name: Fitness facilities
'2820':
id: '2820'
name: Number of indoor pools - 10
value: 10
images:
- caption: Featured Image
hero_image: true
category: 3
links:
70px:
method: GET
href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg
onsite_payments:
currency: USD
types:
'171':
id: '171'
name: American Express
rooms:
'224829':
id: '224829'
name: Single Room
descriptions:
overview: 2 Twin Beds
269-sq-foot (25-sq-meter) room with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV with cable channels
Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
Sleep - Premium bedding
Bathroom - Private bathroom, shower, bathrobes, and free toiletries
Practical - Safe and desk; cribs/infant beds available on request
Comfort - Climate-controlled air conditioning and daily housekeeping
Non-Smoking
amenities:
'130':
id: '130'
name: Refrigerator
'1234':
id: '1234'
name: Test Amenity - 200
value: '200'
images:
- hero_image: true
category: 21001
links:
70px:
method: GET
href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg
caption: Guestroom
bed_groups:
'37321':
id: '37321'
description: 1 King Bed
configuration:
- type: KingBed
size: King
quantity: 1
area:
square_meters: 20
square_feet: 215
views:
'4146':
id: '4146'
name: Courtyard view
occupancy:
max_allowed:
total: 5
children: 2
adults: 4
age_categories:
Adult:
name: Adult
minimum_age: 9
rates:
333abc:
id: 333abc
amenities:
'2104':
id: '2104'
name: Full Breakfast
'1234':
id: '1234'
name: Test Amenity - 200
value: '200'
special_offer_description: "Breakfast for 2 - Rate includes the following:\r\n- Accommodations as selected
\r\n- Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room
\r\n
Must book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"
dates:
added: '1998-07-19T05:00:00.000Z'
updated: '2018-03-22T07:23:14.000Z'
descriptions:
amenities: Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.
dining: Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.
renovations: 'During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: '
national_ratings: For the benefit of our customers, we have provided a rating based on our rating system.
business_amenities: Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.
rooms: Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.
attractions: Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.
Distances are displayed to the nearest 0.1 mile and kilometer. Sogo Department Store - 0.7 km / 0.4 mi
National Museum of Natural Science - 1.1 km / 0.7 mi
Shr-Hwa International Tower - 1.4 km / 0.8 mi
Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
Taichung Metropolitan Opera House - 1.7 km / 1 mi
Tiger City Mall - 1.8 km / 1.1 mi
Maple Garden Park - 1.9 km / 1.2 mi
National Museum of Fine Arts - 2.1 km / 1.3 mi
Feng Chia University - 2.4 km / 1.5 mi
Bao An Temple - 2.5 km / 1.6 mi
Fengjia Night Market - 2.5 km / 1.6 mi
Zhonghua Night Market - 2.7 km / 1.7 mi
Chonglun Park - 2.9 km / 1.8 mi
Wan He Temple - 2.9 km / 1.8 mi
Chungyo Department Store - 3.1 km / 1.9 mi
The nearest airports are:
Taichung (RMQ) - 12 km / 7.5 mi
Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
Taipei (TSA-Songshan) - 135.5 km / 84.2 mi
location: This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science.
headline: Near National Museum of Natural Science
statistics:
'52':
id: '52'
name: Total number of rooms - 820
value: '820'
'54':
id: '54'
name: Number of floors - 38
value: '38'
airports:
preferred:
iata_airport_code: SGF
themes:
'2337':
id: '2337'
name: Luxury Hotel
'2341':
id: '2341'
name: Spa Hotel
all_inclusive:
all_rate_plans: true
some_rate_plans: false
details: This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).
Activities and facilities/equipment
Land activities
Lessons/classes/games
Entertainment
- Onsite entertainment and activities
- Onsite live performances
tax_id: AB-012-987-1234-01
chain:
id: -6
name: Hyatt Hotels
brand:
id: '2209'
name: Hyatt Place
spoken_languages:
vi:
id: vi
name: Vietnamese
multi_unit: true
payment_registration_recommended: false
supply_source: expedia
Single Property VRBO Example:
value:
'4687248':
property_id: '4687248'
name: Beautiful 6 Bedroom Home With Two Pools, Only 10 minutes To Theme Park!
address:
city: Springfield
state_province_code: MO
state_province_name: Missouri
postal_code: '65801'
country_code: US
obfuscation_required: true
localized:
links:
en-US:
method: GET
href: https://api.ean.com/v3/properties/content?language=en-US&property_id=4687248&include=address&supply_source=vrbo
ratings:
guest:
count: 59
overall: '5.0'
cleanliness: '4.9'
recommendation_percent: '100.0'
location:
coordinates:
latitude: 38.139185
longitude: -92.823674
obfuscated_coordinates:
latitude: 38.247296
longitude: -92.912563
obfuscation_required: false
phone: 1-4175551212
category:
id: '17'
name: Private vacation home
business_model:
expedia_collect: true
property_collect: true
rank: 99999999
checkin:
begin_time: 4:00 PM
instructions: - Extra-person charges may apply and vary depending on property policy
- Government-issued photo identification and a credit card, debit card, or cash deposit may be required at check-in for incidental charges
- Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed
- Onsite parties or group events are strictly prohibited
- Safety features at this property include a fire extinguisher, a smoke detector, a first aid kit, and a deadbolt lock
- This property is managed through our partner, Vrbo. You will receive an email from Vrbo with a link to a Vrbo account, where you can change or cancel your reservation
special_instructions: You will receive an email from the host with check-in and check-out instructions. You will also receive an email from Vrbo with a link to a Vrbo account which will enable you to manage your booking.
min_age: 21
checkout:
time: 10:00 AM
fees:
traveler_service: Your credit card statement will show two separate charges, one for the booking amount and property fees and another for the service fee. Both will be charged by Expedia partner HomeAway.com, Inc.. The traveler service fee is refundable only when your entire booking is fully refundable. Please refer to HomeAway's terms and conditions for the rules applicable to the booking facilitation services provided.
attributes:
pets:
'2050':
id: '2050'
name: Pets not allowed
general:
'2940':
id: '2940'
name: Minimum guest age is 0
value: '0'
'1073743917':
id: '1073743917'
name: Events/parties not allowed
'1073745102':
id: '1073745102'
name: Private host property
amenities:
'9':
id: '9'
name: Fitness facilities
categories:
- gym
'1073745320':
id: '1073745320'
name: Paddle boating nearby
images:
- hero_image: true
category: 21001
links:
350px:
method: GET
href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_b.jpg
70px:
method: GET
href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_t.jpg
1000px:
method: GET
href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_z.jpg
caption: Room
onsite_payments:
currency: USD
dates:
added: '2021-04-30T09:00:28.495Z'
updated: '2023-08-06T12:52:58.185Z'
descriptions:
amenities: Take advantage of recreational opportunities offered, including a water park, an outdoor pool, and a fitness center. This vacation home also features an arcade/game room and barbecue grills.
business_amenities: Guests will find features like Internet access and onsite parking.
rooms: Make yourself comfortable in this air-conditioned vacation home, which features a fireplace and a Smart TV. There's a private balcony. A kitchen is outfitted with a refrigerator, an oven, and a stovetop. Complimentary wireless Internet access keeps you connected, and a DVD player is provided for your entertainment.
attractions: Distances are displayed to the nearest 0.1 mile and kilometer.
Super Cool Lake - 3.9 km / 2.5 mi
Gray River - 7 km / 4.4 mi
Super Cool Lake State Park - 8.5 km / 5.6 mi
State Park Marina - 7.6 km / 4.7 mi
The nearest airports are:
Springfield-Branson National Airport (SGF) - 7.3 km / 4.8 mi
Branson, MO (BKG) - 94.1 km / 60.4 mi
location: When you stay at this vacation home, you'll be ready for a great vacation.
headline: Super Interesting Attractions Nearby
general: A stay in a vacation home shows a different side of Fun. Onsite parking is available during your stay.
statistics:
'52':
id: '52'
name: Total number of rooms - 1
value: '1'
'1073743378':
id: '1073743378'
name: Number of bedrooms - 6
value: '6'
'1073743379':
id: '1073743379'
name: Number of bathrooms - 4
value: '4'
'1073743380':
id: '1073743380'
name: Max occupancy - 16
value: '16'
themes:
'5019':
id: '5019'
name: Adventure sport property
'1073744357':
id: '1073744357'
name: Family
chain:
id: '0'
name: Independent
brand:
id: '0'
name: Independent
multi_unit: false
payment_registration_recommended: false
vacation_rental_details:
private_host: true
property_manager:
name: Scott Horton
house_rules:
- Children welcome
- No pets
- No smoking
- No parties or events
amenities:
'1':
id: '1'
name: Air conditioning
'1073745174':
id: '1073745174'
name: Travel crib
vrbo_srp_id: 334.3634257.3458973
listing_id: '1252577'
listing_number: '3834275'
listing_source: VRBO
listing_unit: /units/0001/429ecad2-bade-429a-a427-8adee57420ec
ipm_name: Good Company
unit_configurations:
'1':
- quantity: 1
type: KING_BED
description: 'King bed(s) - '
'2':
- quantity: 1
type: SLEEP_SOFA_FUTON
description: 'Sleep sofa/futon(s) - '
- quantity: 2
type: BUNK_BED
description: 'Bunk bed(s) - '
'3':
- quantity: 1
type: KING_BED
description: 'King bed(s) - '
'4':
- quantity: 1
type: KING_BED
description: 'King bed(s) - '
'5':
- quantity: 1
type: KING_BED
description: 'King bed(s) - '
'6':
- quantity: 1
type: KING_BED
description: 'King bed(s) - '
enhanced_house_rules:
Pets:
rule: No pets allowed
additional_information: []
CheckOut:
rule: Check out before 10:00 AM
additional_information: []
Events:
rule: No events allowed
additional_information: []
MinBookingAge:
rule: 'Minimum age to rent: 21'
additional_information: []
Occupancy:
rule: 'Maximum overnight guests: 16 (sleeps up to 16 adults)'
additional_information: []
CustomRules:
rule: No fireworks are permitted. Please respect our neighbors as many of them live here full time. Quiet hours are 10pm-8am.
additional_information:
- No weapons, illegal drugs, parties, disruptive guests, or underage drinking is permitted.
CheckIn:
rule: Check in after 4:00 PM
additional_information: []
Children:
rule: 'Children allowed: ages 0-17'
additional_information: []
Smoking:
rule: Smoking is not permitted
additional_information: []
free_text: 'Stunning brand new 2-story home with 6 bedrooms, 4 bathrooms, brand new appliances/furniture, game room, grill, patio, and beautiful scenery all around. Minutes from Super Cool Lake. This place is the perfect getaway for a larger group whether it be a golf trip, lake trip, or time to gather with the family. Please note this property has two parking stalls, in addition to first come first serve overflow parking in the community. Celebrating something special? Birthday, Anniversary, Bachelor/Bachelorette, etc? We also offer decorating services for an extra fee. Please inquire within! This home features a fully-equipped kitchen for preparing meals, onsite washer and dryer and most importantly a private space, much larger than a hotel room for private family time away from crowds and people. We have a self-check-in and check-out system to limit your contact with people as well. THE BASICS: 6 bedrooms & 1 loft - 5 Kings, 2 Bunk beds , and 1 pull-out couch in the loft - Sleeps 16 people. 4 Bathrooms - Master (jetted tub, walk-in shower, double sinks), other 3 bathrooms (tub/shower combo & sink). Fully Equipped Kitchen. Open Main Room with plenty of seating. Dining Room table and bar stools around kitchen island area. Plenty of space to spread out and enjoy your friends/family. Free Wifi. THE EXPERIENCE IN DETAIL: -As you walk in the front door and are greeted by the open floor layout of our kitchen and great room you immediately breathe easy seeing that there is plenty of room here for you and your family. Our Kitchen is stocked with plenty of cookware and dishes so you can create a huge breakfast that will get everyone out of bed and ready for a day of fun. A potted coffee maker and a Keurig is available. You will need to bring your own coffee/pods/filters/creamer etc. Cozy up in the living room for a late night movie on our large flat-screen TV equipped for your viewing pleasure. Our luxury Master bedroom with it’s King size bed, premium bedding, and TV invite you and your spouse to relax together and feel a little spoiled. This is a vacation after all! Enjoy our Master Bath with it’s jetted tub, walk-in shower, and double sinks. Explore the Upstairs which has 4 Bedrooms - 3 furnished with a King size bed, premium bedding, 1 is the bunk room which is equipped with 4 twin size beds. This home is not handicapped accessible!!!'
supply_source: Vrbo
spoken_languages:
en:
id: en
name: English
Multiple Properties Example:
value:
'12345':
property_id: '12345'
name: Test Property Name
address:
line_1: 123 Main St
line_2: Apt A
city: Springfield
state_province_code: MO
state_province_name: Missouri
postal_code: '65804'
country_code: US
obfuscation_required: false
localized:
links:
es-ES:
method: GET
href: https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345
fr-FR:
method: GET
href: https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345
ratings:
property:
rating: '3.5'
type: Star
guest:
count: 48382
overall: '3.1'
cleanliness: '4.2'
service: '1.1'
comfort: '4.3'
condition: '1.6'
location: '4.0'
neighborhood: '3.4'
quality: '3.4'
value: '2.2'
amenities: '1.4'
recommendation_percent: 73%
location:
coordinates:
latitude: 37.158451
longitude: -93.268382
obfuscated_coordinates:
latitude: 37.159532
longitude: -93.271681
obfuscation_required: false
phone: 1-417-862-0153
fax: 1-417-863-7249
category:
id: '1'
name: Hotel
rank: 42
business_model:
expedia_collect: true
property_collect: false
checkin:
24_hour: 24-hour check-in
begin_time: 3:00 PM
end_time: 11:00 PM
instructions: Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />
special_instructions: There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.
min_age: 18
checkout:
time: 11:00 AM
fees:
mandatory: 'You''ll be asked to pay the following charges at the hotel:
- Deposit: USD 50 per day
- Resort fee: USD 29.12 per accommodation, per night
The hotel resort fee includes:- Fitness center access
- Internet access
- Phone calls
- Additional inclusions
We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.
'
optional: 'Fee for in-room wireless Internet: USD 15 per hour (rates may vary) Airport shuttle fee: USD 350 per vehicle (one way) Rollaway bed fee: USD 175 per night'
policies:
know_before_you_go: Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation. Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. Only registered guests are allowed in the guestrooms. Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
attributes:
general:
'3357':
id: '3357'
name: Caters to adults only
'2549':
id: '2549'
name: No elevators
pets:
'51':
id: '51'
name: Pets allowed
'2809':
id: '2809'
name: Dogs only
'3321':
id: '3321'
name: Pet maximum weight in kg is - 24
value: 24
amenities:
'9':
id: '9'
name: Fitness facilities
'2820':
id: '2820'
name: Number of indoor pools - 10
value: 10
images:
- caption: Featured Image
hero_image: true
category: 3
links:
70px:
method: GET
href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg
onsite_payments:
currency: USD
types:
'171':
id: '171'
name: American Express
rooms:
'224829':
id: '224829'
name: Single Room
descriptions:
overview: 2 Twin Beds
269-sq-foot (25-sq-meter) room with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV with cable channels
Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
Sleep - Premium bedding
Bathroom - Private bathroom, shower, bathrobes, and free toiletries
Practical - Safe and desk; cribs/infant beds available on request
Comfort - Climate-controlled air conditioning and daily housekeeping
Non-Smoking
amenities:
'130':
id: '130'
name: Refrigerator
'1234':
id: '1234'
name: Test Amenity - 200
value: '200'
images:
- hero_image: true
category: 21001
links:
70px:
method: GET
href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg
caption: Guestroom
bed_groups:
'37321':
id: '37321'
description: 1 King Bed
configuration:
- type: KingBed
size: King
quantity: 1
area:
square_meters: 20
square_feet: 215
views:
'4146':
id: '4146'
name: Courtyard view
occupancy:
max_allowed:
total: 5
children: 2
adults: 4
age_categories:
Adult:
name: Adult
minimum_age: 9
rates:
333abc:
id: 333abc
amenities:
'2104':
id: '2104'
name: Full Breakfast
'1234':
id: '1234'
name: Test Amenity - 200
value: '200'
special_offer_description: "Breakfast for 2 - Rate includes the following:\r\n- Accommodations as selected
\r\n- Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room
\r\n
Must book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"
dates:
added: '1998-07-19T05:00:00.000Z'
updated: '2018-03-22T07:23:14.000Z'
descriptions:
amenities: Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.
dining: Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.
renovations: 'During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: '
national_ratings: For the benefit of our customers, we have provided a rating based on our rating system.
business_amenities: Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.
rooms: Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.
attractions: Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.
Distances are displayed to the nearest 0.1 mile and kilometer. Sogo Department Store - 0.7 km / 0.4 mi
National Museum of Natural Science - 1.1 km / 0.7 mi
Shr-Hwa International Tower - 1.4 km / 0.8 mi
Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
Taichung Metropolitan Opera House - 1.7 km / 1 mi
Tiger City Mall - 1.8 km / 1.1 mi
Maple Garden Park - 1.9 km / 1.2 mi
National Museum of Fine Arts - 2.1 km / 1.3 mi
Feng Chia University - 2.4 km / 1.5 mi
Bao An Temple - 2.5 km / 1.6 mi
Fengjia Night Market - 2.5 km / 1.6 mi
Zhonghua Night Market - 2.7 km / 1.7 mi
Chonglun Park - 2.9 km / 1.8 mi
Wan He Temple - 2.9 km / 1.8 mi
Chungyo Department Store - 3.1 km / 1.9 mi
The nearest airports are:
Taichung (RMQ) - 12 km / 7.5 mi
Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
Taipei (TSA-Songshan) - 135.5 km / 84.2 mi
location: This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science.
headline: Near National Museum of Natural Science
statistics:
'52':
id: '52'
name: Total number of rooms - 820
value: '820'
'54':
id: '54'
name: Number of floors - 38
value: '38'
airports:
preferred:
iata_airport_code: SGF
themes:
'2337':
id: '2337'
name: Luxury Hotel
'2341':
id: '2341'
name: Spa Hotel
all_inclusive:
all_rate_plans: true
some_rate_plans: false
details: This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).
Activities and facilities/equipment
Land activities
Lessons/classes/games Entertainment
- Onsite entertainment and activities
- Onsite live performances
tax_id: AB-012-987-1234-01
chain:
id: -6
name: Hyatt Hotels
brand:
id: '2209'
name: Hyatt Place
spoken_languages:
en:
id: en
name: English
zh-yue:
id: zh-yue
name: Chinese (Cantonese)
multi_unit: true
payment_registration_recommended: false
supply_source: expedia
'67890':
property_id: '67890'
name: Test Property Name 2
address:
line_1: 123 Main St
line_2: Apt A
city: Springfield
state_province_code: MO
state_province_name: Missouri
postal_code: '65804'
country_code: US
obfuscation_required: true
localized:
links:
es-ES:
method: GET
href: https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890
de-DE:
method: GET
href: https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890
ratings:
property:
rating: '3.5'
type: Star
guest:
count: 7651
overall: '4.3'
cleanliness: '4.2'
service: '1.1'
comfort: '4.3'
condition: '1.6'
location: '4.0'
neighborhood: '3.4'
quality: '3.4'
value: '2.2'
amenities: '1.4'
recommendation_percent: 80%
location:
coordinates:
latitude: 37.158451
longitude: -93.268382
obfuscated_coordinates:
latitude: 37.159532
longitude: -93.271681
obfuscation_required: false
phone: 1-417-862-0153
fax: 1-417-863-7249
category:
id: '1'
name: Hotel
rank: 42
business_model:
expedia_collect: true
property_collect: true
checkin:
24_hour: 24-hour check-in
begin_time: 3:00 PM
end_time: 11:00 PM
instructions: Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />
special_instructions: There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.
min_age: 18
checkout:
time: 11:00 AM
fees:
mandatory: 'You''ll be asked to pay the following charges at the hotel:
- Deposit: USD 50 per day
- Resort fee: USD 29.12 per accommodation, per night
The hotel resort fee includes:- Fitness center access
- Internet access
- Phone calls
- Additional inclusions
We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.
'
optional: 'Fee for in-room wireless Internet: USD 15 per hour (rates may vary) Airport shuttle fee: USD 350 per vehicle (one way) Rollaway bed fee: USD 175 per night'
policies:
know_before_you_go: Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation. Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. Only registered guests are allowed in the guestrooms. Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
attributes:
general:
'3357':
id: '3357'
name: Caters to adults only
'2549':
id: '2549'
name: No elevators
pets:
'51':
id: '51'
name: Pets allowed
'2809':
id: '2809'
name: Dogs only
'3321':
id: '3321'
name: Pet maximum weight in kg is - 24
value: 24
amenities:
'9':
id: '9'
name: Fitness facilities
'2820':
id: '2820'
name: Number of indoor pools - 10
value: 10
images:
- caption: Featured Image
hero_image: true
category: 3
links:
70px:
method: GET
href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg
onsite_payments:
currency: USD
types:
'171':
id: '171'
name: American Express
rooms:
'224829':
id: '224829'
name: Single Room
descriptions:
overview: 2 Twin Beds
269-sq-foot (25-sq-meter) room with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV with cable channels
Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
Sleep - Premium bedding
Bathroom - Private bathroom, shower, bathrobes, and free toiletries
Practical - Safe and desk; cribs/infant beds available on request
Comfort - Climate-controlled air conditioning and daily housekeeping
Non-Smoking
amenities:
'130':
id: '130'
name: Refrigerator
'1234':
id: '1234'
name: Test Amenity - 200
value: '200'
images:
- hero_image: true
category: 21001
links:
70px:
method: GET
href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg
caption: Guestroom
bed_groups:
'37321':
id: '37321'
description: 1 King Bed
configuration:
- type: KingBed
size: King
quantity: 1
area:
square_meters: 17
views:
'4134':
id: '4134'
name: City view
occupancy:
max_allowed:
total: 3
children: 2
adults: 3
age_categories:
ChildAgeA:
name: ChildAgeA
minimum_age: 3
rates:
333abc:
id: 333abc
amenities:
'2104':
id: '2104'
name: Full Breakfast
'1234':
id: '1234'
name: Test Amenity - 200
value: '200'
special_offer_description: "Breakfast for 2 - Rate includes the following:\r\n- Accommodations as selected
\r\n- Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room
\r\n
Must book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"
dates:
added: '1998-07-20T05:00:00.000Z'
updated: '2018-03-22T13:33:17.000Z'
descriptions:
amenities: Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.
dining: Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.
renovations: 'During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: '
national_ratings: For the benefit of our customers, we have provided a rating based on our rating system.
business_amenities: Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.
rooms: Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.
attractions: Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.
Distances are displayed to the nearest 0.1 mile and kilometer. Sogo Department Store - 0.7 km / 0.4 mi
National Museum of Natural Science - 1.1 km / 0.7 mi
Shr-Hwa International Tower - 1.4 km / 0.8 mi
Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
Taichung Metropolitan Opera House - 1.7 km / 1 mi
Tiger City Mall - 1.8 km / 1.1 mi
Maple Garden Park - 1.9 km / 1.2 mi
National Museum of Fine Arts - 2.1 km / 1.3 mi
Feng Chia University - 2.4 km / 1.5 mi
Bao An Temple - 2.5 km / 1.6 mi
Fengjia Night Market - 2.5 km / 1.6 mi
Zhonghua Night Market - 2.7 km / 1.7 mi
Chonglun Park - 2.9 km / 1.8 mi
Wan He Temple - 2.9 km / 1.8 mi
Chungyo Department Store - 3.1 km / 1.9 mi
The nearest airports are:
Taichung (RMQ) - 12 km / 7.5 mi
Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
Taipei (TSA-Songshan) - 135.5 km / 84.2 mi
location: This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science.
headline: Near National Museum of Natural Science
statistics:
'52':
id: '52'
name: Total number of rooms - 820
value: '820'
'54':
id: '54'
name: Number of floors - 38
value: '38'
airports:
preferred:
iata_airport_code: SGF
themes:
'2337':
id: '2337'
name: Luxury Hotel
'2341':
id: '2341'
name: Spa Hotel
all_inclusive:
all_rate_plans: true
some_rate_plans: false
details: This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).
Activities and facilities/equipment
Land activities
Lessons/classes/games Entertainment
- Onsite entertainment and activities
- Onsite live performances
tax_id: CD-012-987-1234-02
chain:
id: -5
name: Hilton Worldwide
brand:
id: '358'
name: Hampton Inn
spoken_languages:
en:
id: en
name: English
multi_unit: true
payment_registration_recommended: true
supply_source: expedia
Multiple Properties With include name, and ratings:
value:
'12345':
property_id: '12345'
name: Test property 1
ratings:
property:
rating: '3.5'
type: Star
guest:
count: 48382
overall: '3.1'
cleanliness: '4.2'
service: '1.1'
comfort: '4.3'
condition: '1.6'
location: '4.0'
neighborhood: '3.4'
quality: '3.4'
value: '2.2'
amenities: '1.4'
recommendation_percent: 73%
'67890':
property_id: '67890'
name: Test property 2
ratings:
property:
rating: '4.0'
type: Star
guest:
count: 3451
overall: '4.1'
cleanliness: '4.9'
service: '3.1'
comfort: '4.8'
condition: '3.6'
location: '4.7'
neighborhood: '4.4'
quality: '3.9'
value: '3.2'
amenities: '4.4'
recommendation_percent: 90%
No Properties Example:
value: {}
'400':
description: Invalid Input
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: invalid_input
message: An invalid request was sent in, please check the nested errors for details.
errors:
- type: language.required
message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
- type: language.above_maximum
message: The number of languages passed in must not be greater than 1.
fields:
- name: language
type: querystring
- type: language.not_supported
message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
value: xXX
- type: property_id.must_be_numeric
message: All provided property_id query parameters must be numeric (contains only digits 0-9, with no other characters).
fields:
- name: property_id
type: querystring
value: abc
- name: property_id
type: querystring
value: 123adsf
- type: property_id.above_maximum
message: A maximum of 250 property_id query parameters may be provided to this request.
fields:
- name: property_id
type: querystring
'401':
description: Unauthorized
headers:
Region:
$ref: '#/components/headers/Region'
WWW-Authenticate:
description: Provides an example of the Authorization header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthenticated
message: Data required to authenticate your request is missing or inaccurate. Ensure that your request follows the guidelines in our documentation.
fields:
- name: apikey
type: header
value: jaj3982k239dka328e
- name: signature
type: header
value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b
- name: timestamp
type: header
value: 198284729
- name: servertimestamp
type: server
value: 198284729
'403':
description: Forbidden
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthorized
message: Your request could not be authorized.
'410':
description: Gone
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: link.expired
message: The link you followed has expired. Please build a new request to restart pagination.
'426':
description: Upgrade Required
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: upgrade_required
message: This service requires the use of TLS.
'429':
description: Too Many Requests
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: too_many_requests
message: You have reached your capacity for this type of request.
'500':
description: Unknown Internal Error
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unknown_internal_error
message: An internal server error has occurred.
'503':
description: Service Unavailable
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: service_unavailable
message: This service is currently unavailable.
security:
- rapidAuth: []
/properties/inactive:
get:
tags:
- Content
summary: Expedia Group Inactive Properties
description: 'Request a list of properties that are inactive because they have been removed from sale since a specified
date.
When there are a large number of properties in the response, it will be paginated. See the `Link` header in the
200 response section.
'
operationId: getInactiveProperties
parameters:
- name: Accept
in: header
description: 'Specifies the response format that the client would like to receive back. This must be `application/json`.
'
required: true
schema:
type: string
example: application/json
- name: Accept-Encoding
in: header
description: 'Specifies the response encoding that the client would like to receive back. This must be `gzip`.
'
required: true
schema:
type: string
example: gzip
- name: User-Agent
in: header
description: "The `User-Agent` header string from the customer's request, as captured by your integration. If you are \nbuilding an application then the `User-Agent` value should be `{app name}/{app version}`.\n"
required: true
schema:
type: string
example: TravelNow/3.30.112
- name: Customer-Session-Id
in: header
description: 'Insert your own unique value for each user session, beginning with the first API call. Continue to pass the same
value for each subsequent API call during the user''s session, using a new value for every new customer session.
Including this value greatly eases EPS''s internal debugging process for issues with partner requests,
as it explicitly links together request paths for individual user''s session.
'
schema:
type: string
- name: since
in: query
description: 'Required on initial call, not accepted on subsequent paging links provided in response header.
The earliest date that a property became inactive to include in the results. ISO 8601 format (YYYY-MM-DD)
'
schema:
type: string
example: '2023-05-01'
- name: token
in: query
description: 'Only used for requesting additional pages of data. Provided by the `next` URL in the `Link` response header.
'
schema:
type: string
example: MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m
- name: billing_terms
in: query
description: 'This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed,
the value for this will be provided to you separately.
'
schema:
type: string
- name: payment_terms
in: query
description: 'This parameter is to specify what terms should be used when being paid for a resulting booking. If this
field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: partner_point_of_sale
in: query
description: 'This parameter is to specify what point of sale is being used to shop and book. If this field is needed,
the value for this will be provided to you separately.
'
schema:
type: string
- name: platform_name
in: query
description: 'This parameter is to specify what platform is being used to shop and book. If this field is needed, the
value for this will be provided to you separately.
'
schema:
type: string
responses:
'200':
description: OK
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Link:
description: 'Contains a single link to get the immediate next page of results, and follows the
[IETF standard](https://tools.ietf.org/html/rfc5988). To get the next page of results, simply follow
the `next` URL in this header without modifying it. This header will be missing when there are no
further pages. If the link expires, there will be an `expires` link-extension that is the UTC date the
link will expire, in ISO 8601 format.
'
schema:
type: string
example: ; rel="next"; expires=2023-06-29T20:15:05.324083439Z
Pagination-Total-Results:
description: Contains the total number of property objects found.
schema:
type: number
example: 827
content:
application/json:
schema:
type: array
description: The list of properties that became inactive and are still inactive since the requested date.
items:
$ref: '#/components/schemas/PropertyInactive'
examples:
Inactive Properties:
value:
- property_id: '12345'
- property_id: '23456'
No Results:
value: []
'400':
description: Invalid Input
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: invalid_input
message: An invalid request was sent in, please check the nested errors for details.
errors:
- type: since.required
message: The since field is required. Please provide a date in ISO 8601 (YYYY-MM-DD) format.
fields:
- name: since
type: querystring
- type: since.invalid_date_format
message: The since field is not formatted correctly. Please provide a date in ISO 8601 (YYYY-MM-DD) format.
fields:
- name: since
type: querystring
value: 23-1-1
'401':
description: Unauthorized
headers:
WWW-Authenticate:
description: Provides an example of the Authorization header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthenticated
message: Data required to authenticate your request is missing or inaccurate. Ensure that your request follows the guidelines in our documentation.
fields:
- name: apikey
type: header
value: jaj3982k239dka328e
- name: signature
type: header
value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b
- name: timestamp
type: header
value: 198284729
- name: servertimestamp
type: server
value: 198284729
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthorized
message: Your request could not be authorized.
'410':
description: Gone
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: link.expired
message: The link you followed has expired. Please build a new request to restart pagination.
'426':
description: Upgrade Required
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: upgrade_required
message: This service requires the use of TLS.
'429':
description: Too Many Requests
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: too_many_requests
message: You have reached your capacity for this type of request.
'500':
description: Unknown Internal Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unknown_internal_error
message: An internal server error has occurred.
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: service_unavailable
message: This service is currently unavailable.
security:
- rapidAuth: []
/properties/{property_id}/guest-reviews:
get:
tags:
- Content
summary: Expedia Group Property Guest Reviews
description: 'Note: Property Guest Reviews are only available if your account is configured for access and all launch requirements have been followed. Please find the launch requirements here [https://support.expediapartnersolutions.com/hc/en-us/articles/360008646799](https://support.expediapartnersolutions.com/hc/en-us/articles/360008646799) and contact your Account Manager for more details.
The response is an individual Guest Reviews object containing multiple guest reviews for the requested active property.
To ensure you always show the latest guest reviews, this call should be made whenever a customer looks at the details for a specific property.
'
operationId: getPropertyGuestReviews
parameters:
- name: Accept
in: header
description: 'Specifies the response format that the client would like to receive back. This must be `application/json`.
'
required: true
schema:
type: string
example: application/json
- name: Accept-Encoding
in: header
description: 'Specifies the response encoding that the client would like to receive back. This must be `gzip`.
'
required: true
schema:
type: string
example: gzip
- name: Customer-Session-Id
in: header
description: 'Insert your own unique value for each user session, beginning with the first API call.
Continue to pass the same value for each subsequent API call during the user''s session, using a new value for every new customer session.
Including this value greatly eases EPS''s internal debugging process for issues with partner requests, as it explicitly links together request paths for individual user''s session.
'
schema:
type: string
- name: User-Agent
in: header
description: 'The `User-Agent` header string from the customer''s request, as captured by your integration. If you are building an application then the `User-Agent` value should be `{app name}/{app version}`.
'
required: true
schema:
type: string
example: TravelNow/3.30.112
- name: property_id
in: path
description: 'Expedia Property ID.
'
required: true
schema:
type: string
example: '19248'
- name: language
in: query
description: 'Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options)
'
required: true
schema:
type: string
example: language=en-US
- name: billing_terms
in: query
description: 'This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: payment_terms
in: query
description: 'This parameter is to specify what terms should be used when being paid for a resulting booking. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: partner_point_of_sale
in: query
description: 'This parameter is to specify what point of sale is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: platform_name
in: query
description: 'This parameter is to specify what platform is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
responses:
'200':
description: OK
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/GuestReviews'
example:
verified:
recent:
- verification_source: Expedia verified Review
title: Definitely staying again
date_submitted: '2019-02-11T18:19:40Z'
rating: '5'
reviewer_name: Bill
trip_reason: leisure
travel_companion: self
text: Staff very helpful and friendly. Pool was 18 meters deep, very strange.
- verification_source: Expedia verified Review
title: Pool much too deep
date_submitted: '2019-02-10T11:15:01Z'
rating: '2'
reviewer_name: Gregory
trip_reason: friends_and_family
travel_companion: family_with_children
text: Bottom of the 18 meter pool was too scary. Staff were nice though.
'400':
description: Invalid Input
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: invalid_input
message: An invalid request was sent in, please check the nested errors for details.
errors:
- type: language.required
message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
- type: language.above_maximum
message: The number of languages passed in must not be greater than 1.
fields:
- name: language
type: querystring
- type: language.not_supported
message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
value: xXX
'401':
description: Unauthorized
headers:
Region:
$ref: '#/components/headers/Region'
WWW-Authenticate:
description: Provides an example of the Authorization header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthenticated
message: Data required to authenticate your request is missing or inaccurate. Ensure that your request follows the guidelines in our documentation.
fields:
- name: apikey
type: header
value: jaj3982k239dka328e
- name: signature
type: header
value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b
- name: timestamp
type: header
value: 198284729
- name: servertimestamp
type: server
value: 198284729
'403':
description: Forbidden
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthorized
message: Your request could not be authorized.
'404':
description: Not Found
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: guest_reviews.not_found
message: The requested guest reviews could not be found.
'426':
description: Upgrade Required
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: upgrade_required
message: This service requires the use of TLS.
'429':
description: Too Many Requests
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: too_many_requests
message: You have reached your capacity for this type of request.
'500':
description: Unknown Internal Error
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unknown_internal_error
message: An internal server error has occurred.
'503':
description: Service Unavailable
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: service_unavailable
message: This service is currently unavailable.
security:
- rapidAuth: []
/files/properties/catalog:
get:
tags:
- Content
summary: Expedia Group Property Catalog File
description: "Returns a link to download the master list of EPS's active properties in the requested language. The response includes high-level details about each property.\n\n
This file is in JSONL format and is gzipped. The schema of each JSON object in the JSONL file is a subset of the schema of each JSON object from the Property Content call. The subset of fields included are:\n\n * property_id\n * name\n * address\n * ratings\n * location\n * phone\n * fax\n * category\n * rank\n * business_model\n * dates\n * statistics\n * chain\n * brand\n * supply_source\n\n
Example of a JSONL file with 2 properties:\n```\n{\"property_id\":\"12345\",\"name\":\"Test Property Name\",\"address\":{\"line_1\":\"123 Main St\",\"line_2\":\"Apt A\",\"city\":\"Springfield\",\"state_province_code\":\"MO\",\"state_province_name\":\"Missouri\",\"postal_code\":\"65804\",\"country_code\":\"US\",\"obfuscation_required\":false,\"localized\":{\"links\":{\"es-ES\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345\"},\"fr-FR\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345\"}}}},\"ratings\":{\"property\":{\"rating\":\"3.5\",\"type\":\"Star\"},\"guest\":{\"count\":48382,\"overall\":\"3.1\",\"cleanliness\":\"4.2\",\"service\":\"1.1\",\"comfort\":\"4.3\",\"condition\":\"1.6\",\"location\":\"4.0\",\"neighborhood\":\"3.4\",\"quality\":\"3.4\",\"value\":\"2.2\",\"amenities\":\"1.4\",\"recommendation_percent\":\"73%\"}},\"location\":{\"coordinates\":{\"latitude\":37.15845,\"longitude\":-93.26838}},\"phone\":\"1-417-862-0153\",\"fax\":\"1-417-863-7249\",\"category\":{\"id\":\"1\",\"name\":\"Hotel\"},\"rank\":42,\"business_model\":{\"expedia_collect\":true,\"property_collect\":false},\"dates\":{\"added\":\"1998-07-19T05:00:00.000Z\",\"updated\":\"2018-03-22T07:23:14.000Z\"},\"statistics\":{\"52\":{\"id\":\"52\",\"name\":\"Total number of rooms - 820\",\"value\":\"820\"},\"54\":{\"id\":\"54\",\"name\":\"Number of floors - 38\",\"value\":\"38\"}},\"chain\":{\"id\":\"-6\",\"name\":\"Hyatt Hotels\"},\"brand\":{\"id\":\"2209\",\"name\":\"Hyatt Place\"},\"supply_source\":\"expedia\"}\n{\"property_id\":\"67890\",\"name\":\"Test Property Name 2\",\"address\":{\"line_1\":\"123 Main St\",\"line_2\":\"Apt A\",\"city\":\"Springfield\",\"state_province_code\":\"MO\",\"state_province_name\":\"Missouri\",\"postal_code\":\"65804\",\"country_code\":\"US\",\"obfuscation_required\":true,\"localized\":{\"links\":{\"es-ES\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890\"},\"de-DE\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890\"}}}},\"ratings\":{\"property\":{\"rating\":\"3.5\",\"type\":\"Star\"},\"guest\":{\"count\":7651,\"overall\":\"4.3\",\"cleanliness\":\"4.2\",\"service\":\"1.1\",\"comfort\":\"4.3\",\"condition\":\"1.6\",\"location\":\"4.0\",\"neighborhood\":\"3.4\",\"quality\":\"3.4\",\"value\":\"2.2\",\"amenities\":\"1.4\",\"recommendation_percent\":\"80%\"}},\"location\":{\"coordinates\":{\"latitude\":37.15845,\"longitude\":-93.26838}},\"phone\":\"1-417-862-0153\",\"fax\":\"1-417-863-7249\",\"category\":{\"id\":\"1\",\"name\":\"Hotel\"},\"rank\":42,\"business_model\":{\"expedia_collect\":true,\"property_collect\":true},\"dates\":{\"added\":\"1998-07-20T05:00:00.000Z\",\"updated\":\"2018-03-22T13:33:17.000Z\"},\"statistics\":{\"52\":{\"id\":\"52\",\"name\":\"Total number of rooms - 820\",\"value\":\"820\"},\"54\":{\"id\":\"54\",\"name\":\"Number of floors - 38\",\"value\":\"38\"}},\"chain\":{\"id\":\"-5\",\"name\":\"Hilton Worldwide\"},\"brand\":{\"id\":\"358\",\"name\":\"Hampton Inn\"},\"supply_source\":\"expedia\"}\n```\n"
operationId: getPropertyCatalogFile
parameters:
- name: Accept
in: header
description: 'Specifies the response format that the client would like to receive back. This must be `application/json`.
'
required: true
schema:
type: string
example: application/json
- name: Accept-Encoding
in: header
description: 'Specifies the response encoding that the client would like to receive back. This must be `gzip`.
'
required: true
schema:
type: string
example: gzip
- name: Customer-Session-Id
in: header
description: 'Insert your own unique value for each user session, beginning with the first API call.
Continue to pass the same value for each subsequent API call during the user''s session, using a new value for every new customer session.
Including this value greatly eases EPS''s internal debugging process for issues with partner requests, as it explicitly links together request paths for individual user''s session.
'
schema:
type: string
- name: User-Agent
in: header
description: 'The `User-Agent` header string from the customer''s request, as captured by your integration. If you are building an application then the `User-Agent` value should be `{app name}/{app version}`.
'
required: true
schema:
type: string
example: TravelNow/3.30.112
- name: language
in: query
description: 'Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options)
'
required: true
schema:
type: string
example: language=en-US
- name: supply_source
in: query
description: "Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times.\n * `expedia` - Standard Expedia supply.\n * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information.\n"
required: true
schema:
type: string
example: vrbo
- name: billing_terms
in: query
description: 'This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: payment_terms
in: query
description: 'This parameter is to specify what terms should be used when being paid for a resulting booking. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: partner_point_of_sale
in: query
description: 'This parameter is to specify what point of sale is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: platform_name
in: query
description: 'This parameter is to specify what platform is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
responses:
'200':
description: OK
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Link'
example:
method: GET
href: https://example.com/propertycatalog.jsonl.gz?amz-security-token=FQoDYXdzEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDD%2FiIFt2RCrdJKrkKSK3A2ncL3qC6SsXLyC3XxgRBGKykCfsfF40Jm8ud6ht6C1LB3q9X0maQCHyXV5gSl9g9hrHtOiC5fnihUQBASMAbOsepEKCfS%2B%2FWDrKAr5lTR%2FptslJxQs6v5GTO7G3R6PYIKFG%2FFgQydd8bEB2njMjynyvgXNgEPsb%2FVuiDC1K%2BMhvoRAguXo4QHQgOVVRXXmbl87j0Ih6s5ffI3yfIvEBnmEfdLdd2E5yPHuIO%2FOItXYxEc0vgipvlT41PylYtS8rhgc3MKqJO4Uw7yNPMlbphdxy6TJzQRJW15o9TaHrFBBYvWrtfcMewOlLYu6N6R1EGQhT9Ayok9J2oKzFJ%2FSbMNmVUsHReM7v1chuY7XNGld9bKeu0xFjDth%2BcEHrjkqhyxBc2pBINvk8LT9uPOCykqbuc2OWlCpNtQyahPnxpdPMW4WEbIFaWUNHWj0ui507CN2useZBYfGIST94KEtJFlpZRB0ntz%2BxmWRSnPYG3K47meFS9cthMsYH1rxIdDei2W49TQbjnVIXY2RldvO2JaTKtYPJT85ds9W71R0s4t9LSgY%2BZ9kaLjF%2BLk7PGKIhBbLowqKRBBUozOf2zAU%3D&AWSAccessKeyId=ASIAIZYRJJGNLGQGVLDA&Expires=1503512048&Signature=p7V%2BTN6rZMiVaz6MxqU%2F4YHYkw8%3D
expires: '2019-03-05T07:23:14.000Z'
'400':
description: Invalid Input
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: invalid_input
message: An invalid request was sent in, please check the nested errors for details.
errors:
- type: language.required
message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
- type: language.above_maximum
message: The number of languages passed in must not be greater than 1.
fields:
- name: language
type: querystring
- type: language.not_supported
message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
value: xXX
'401':
description: Unauthorized
headers:
Region:
$ref: '#/components/headers/Region'
WWW-Authenticate:
description: Provides an example of the Authorization header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthenticated
message: Data required to authenticate your request is missing or inaccurate. Ensure that your request follows the guidelines in our documentation.
fields:
- name: apikey
type: header
value: jaj3982k239dka328e
- name: signature
type: header
value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b
- name: timestamp
type: header
value: 198284729
- name: servertimestamp
type: server
value: 198284729
'403':
description: Forbidden
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthorized
message: Your request could not be authorized.
'404':
description: Not Found
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: file.not_found
message: The requested file could not be found.
fields:
- name: filename
type: path
value: file.jsonl.gz
'426':
description: Upgrade Required
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: upgrade_required
message: This service requires the use of TLS.
'429':
description: Too Many Requests
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: too_many_requests
message: You have reached your capacity for this type of request.
'500':
description: Unknown Internal Error
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unknown_internal_error
message: An internal server error has occurred.
'503':
description: Service Unavailable
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: service_unavailable
message: This service is currently unavailable.
security:
- rapidAuth: []
/files/properties/content:
get:
tags:
- Content
summary: Expedia Group Property Content File
description: "Returns a link to download all content for all of EPS’s active properties in the requested language. The response includes property-level, room-level and rate-level information.\n\n
This file is in JSONL format and is gzipped. The schema of each JSON object in the JSONL file is the same as the schema of each JSON object from the Property Content call.\n\n
Example of a JSONL file with 2 properties:\n ```\n {\"property_id\":\"12345\",\"name\":\"Test Property Name\",\"address\":{\"line_1\":\"123 Main St\",\"line_2\":\"Apt A\",\"city\":\"Springfield\",\"state_province_code\":\"MO\",\"state_province_name\":\"Missouri\",\"postal_code\":\"65804\",\"country_code\":\"US\",\"obfuscation_required\":false,\"localized\":{\"links\":{\"es-ES\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345\"},\"fr-FR\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345\"}}}},\"ratings\":{\"property\":{\"rating\":\"3.5\",\"type\":\"Star\"},\"guest\":{\"count\":48382,\"overall\":\"3.1\",\"cleanliness\":\"4.2\",\"service\":\"1.1\",\"comfort\":\"4.3\",\"condition\":\"1.6\",\"location\":\"4.0\",\"neighborhood\":\"3.4\",\"quality\":\"3.4\",\"value\":\"2.2\",\"amenities\":\"1.4\",\"recommendation_percent\":\"73%\"}},\"location\":{\"coordinates\":{\"latitude\":37.15845,\"longitude\":-93.26838}},\"phone\":\"1-417-862-0153\",\"fax\":\"1-417-863-7249\",\"category\":{\"id\":\"1\",\"name\":\"Hotel\"},\"rank\":42,\"business_model\":{\"expedia_collect\":true,\"property_collect\":false},\"checkin\":{\"24_hour\":\"24-hour check-in\",\"begin_time\":\"3:00 PM\",\"end_time\":\"11:00 PM\",\"instructions\":\"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />\",\"special_instructions\":\"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.\",\"min_age\":18},\"checkout\":{\"time\":\"11:00 AM\"},\"fees\":{\"mandatory\":\"You'll be asked to pay the following charges at the hotel:
- Deposit: USD 50 per day
- Resort fee: USD 29.12 per accommodation, per night
The hotel resort fee includes:- Fitness center access
- Internet access
- Phone calls
- Additional inclusions
We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.
\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary) Airport shuttle fee: USD 350 per vehicle (one way) Rollaway bed fee: USD 175 per night\"},\"policies\":{\"know_before_you_go\":\"Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation. Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. Only registered guests are allowed in the guestrooms. Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. \"},\"attributes\":{\"general\":{\"2549\":{\"id\":\"2549\",\"name\":\"No elevators\"},\"3357\":{\"id\":\"3357\",\"name\":\"Caters to adults only\"}},\"pets\":{\"51\":{\"id\":\"51\",\"name\":\"Pets allowed\"},\"2809\":{\"id\":\"2809\",\"name\":\"Dogs only\"},\"3321\":{\"id\":\"3321\",\"name\":\"Pet maximum weight in kg is - 24\",\"value\":24}}},\"amenities\":{\"9\":{\"id\":\"9\",\"name\":\"Fitness facilities\"},\"2820\":{\"id\":\"2820\",\"name\":\"Number of indoor pools - 10\",\"value\":10}},\"images\":[{\"caption\":\"Featured Image\",\"hero_image\":true,\"category\":3,\"links\":{\"70px\":{\"method\":\"GET\",\"href\":\"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg\"}}}],\"onsite_payments\":{\"currency\":\"USD\",\"types\":{\"171\":{\"id\":\"171\",\"name\":\"American Express\"}}},\"rooms\":{\"224829\":{\"id\":\"224829\",\"name\":\"Single Room\",\"descriptions\":{\"overview\":\"2 Twin Beds
269-sq-foot (25-sq-meter) room with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV with cable channels
Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
Sleep - Premium bedding
Bathroom - Private bathroom, shower, bathrobes, and free toiletries
Practical - Safe and desk; cribs/infant beds available on request
Comfort - Climate-controlled air conditioning and daily housekeeping
Non-Smoking
\"},\"amenities\":{\"130\":{\"id\":\"130\",\"name\":\"Refrigerator\"},\"1234\":{\"id\":\"1234\",\"name\":\"Test Amenity - 200\",\"value\":\"200\"}},\"images\":[{\"hero_image\":true,\"category\":21001,\"links\":{\"70px\":{\"method\":\"GET\",\"href\":\"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg\"}},\"caption\":\"Guestroom\"}],\"bed_groups\":{\"37321\":{\"id\":\"37321\",\"description\":\"1 King Bed\",\"configuration\":[{\"type\":\"KingBed\",\"size\":\"King\",\"quantity\":1}]}},\"area\":{\"square_meters\":20,\"square_feet\":215},\"views\":{\"4146\":{\"id\":\"4146\",\"name\":\"Courtyard view\"}},\"occupancy\":{\"max_allowed\":{\"total\":5,\"children\":2,\"adults\":4},\"age_categories\":{\"Adult\":{\"name\":\"Adult\",\"minimum_age\":9}}}}},\"rates\":{\"333abc\":{\"id\":\"333abc\",\"amenities\":{\"1234\":{\"id\":\"1234\",\"name\":\"Test Amenity - 200\",\"value\":\"200\"},\"2104\":{\"id\":\"2104\",\"name\":\"Full Breakfast\"}},\"special_offer_description\":\"Breakfast for 2 - Rate includes the following:\\r\\n- Accommodations as selected
\\r\\n- Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room
\\r\\n
Must book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\\r\\n\"}},\"dates\":{\"added\":\"1998-07-19T05:00:00.000Z\",\"updated\":\"2018-03-22T07:23:14.000Z\"},\"descriptions\":{\"amenities\":\"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.\",\"dining\":\"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.\",\"renovations\":\"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: \",\"national_ratings\":\"For the benefit of our customers, we have provided a rating based on our rating system.\",\"business_amenities\":\"Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.\",\"rooms\":\"Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.\",\"attractions\":\"Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.
Distances are displayed to the nearest 0.1 mile and kilometer. Sogo Department Store - 0.7 km / 0.4 mi
National Museum of Natural Science - 1.1 km / 0.7 mi
Shr-Hwa International Tower - 1.4 km / 0.8 mi
Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
Taichung Metropolitan Opera House - 1.7 km / 1 mi
Tiger City Mall - 1.8 km / 1.1 mi
Maple Garden Park - 1.9 km / 1.2 mi
National Museum of Fine Arts - 2.1 km / 1.3 mi
Feng Chia University - 2.4 km / 1.5 mi
Bao An Temple - 2.5 km / 1.6 mi
Fengjia Night Market - 2.5 km / 1.6 mi
Zhonghua Night Market - 2.7 km / 1.7 mi
Chonglun Park - 2.9 km / 1.8 mi
Wan He Temple - 2.9 km / 1.8 mi
Chungyo Department Store - 3.1 km / 1.9 mi
The nearest airports are:
Taichung (RMQ) - 12 km / 7.5 mi
Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
Taipei (TSA-Songshan) - 135.5 km / 84.2 mi
\",\"location\":\"This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science.\",\"headline\":\"Near National Museum of Natural Science\",\"general\":\"General description\"},\"statistics\":{\"52\":{\"id\":\"52\",\"name\":\"Total number of rooms - 820\",\"value\":\"820\"},\"54\":{\"id\":\"54\",\"name\":\"Number of floors - 38\",\"value\":\"38\"}},\"airports\":{\"preferred\":{\"iata_airport_code\":\"SGF\"}},\"themes\":{\"2337\":{\"id\":\"2337\",\"name\":\"Luxury Hotel\"},\"2341\":{\"id\":\"2341\",\"name\":\"Spa Hotel\"}},\"all_inclusive\":{\"all_rate_plans\":true,\"some_rate_plans\":false,\"details\":\"This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).
Activities and facilities/equipment
Land activities
Lessons/classes/games Entertainment
- Onsite entertainment and activities
- Onsite live performances
\"},\"tax_id\":\"AB-012-987-1234-01\",\"chain\":{\"id\":\"-6\",\"name\":\"Hyatt Hotels\"},\"brand\":{\"id\":\"2209\",\"name\":\"Hyatt Place\"},\"spoken_languages\":{\"vi\":{\"id\":\"vi\",\"name\":\"Vietnamese\"}},\"multi_unit\":true,\"payment_registration_recommended\":false,\"vacation_rental_details\": {\"registry_number\": \"Property Registration Number 123456\",\"private_host\": \"true\",\"property_manager\": {\"name\": \"Victor\",\"links\": {\"image\": {\"method\": \"GET\",\"href\": \"https://test-image/test/test/836f1097-fbcf-43b5-bc02-c8ff6658cb90.c1.jpg\"}}},\"rental_agreement\": {\"links\": {\"rental_agreement\": {\"method\": \"GET\",\"href\": \"https://test-link.test.amazonaws.com/rentalconditions_property_d65e7eb5-4a7c-4a80-a8a3-171999f9f444.pdf\"}}},\"house_rules\": [\"Children welcome\",\"No pets\",\"No smoking\",\"No parties or events\"],\"amenities\": {\"4296\": {\"id\": \"4296\",\"name\": \"Furnished balcony or patio\"},\"2859\": {\"id\": \"2859\",\"name\": \"Private pool\"}},\"vrbo_srp_id\": \"123.1234567.5678910\",\"listing_id\": \"1234567\",\"listing_number\": \"5678910\",\"listing_source\": \"HOMEAWAY_US\",\"listing_unit\": \"/units/0000/32d82dfa-1a48-45d6-9132-49fdbf1bfc60\"},\"supply_source\":\"vrbo\"}\n {\"property_id\":\"67890\",\"name\":\"Test Property Name 2\",\"address\":{\"line_1\":\"123 Main St\",\"line_2\":\"Apt A\",\"city\":\"Springfield\",\"state_province_code\":\"MO\",\"state_province_name\":\"Missouri\",\"postal_code\":\"65804\",\"country_code\":\"US\",\"obfuscation_required\":true,\"localized\":{\"links\":{\"es-ES\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890\"},\"de-DE\":{\"method\":\"GET\",\"href\":\"https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890\"}}}},\"ratings\":{\"property\":{\"rating\":\"3.5\",\"type\":\"Star\"},\"guest\":{\"count\":7651,\"overall\":\"4.3\",\"cleanliness\":\"4.2\",\"service\":\"1.1\",\"comfort\":\"4.3\",\"condition\":\"1.6\",\"location\":\"4.0\",\"neighborhood\":\"3.4\",\"quality\":\"3.4\",\"value\":\"2.2\",\"amenities\":\"1.4\",\"recommendation_percent\":\"80%\"}},\"location\":{\"coordinates\":{\"latitude\":37.15845,\"longitude\":-93.26838},\"obfuscated_coordinates\":{\"latitude\":28.339303,\"longitude\":-81.47791},\"obfuscation_required\":true},\"phone\":\"1-417-862-0153\",\"fax\":\"1-417-863-7249\",\"category\":{\"id\":\"1\",\"name\":\"Hotel\"},\"rank\":42,\"business_model\":{\"expedia_collect\":true,\"property_collect\":true},\"checkin\":{\"24_hour\":\"24-hour check-in\",\"begin_time\":\"3:00 PM\",\"end_time\":\"11:00 PM\",\"instructions\":\"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />\",\"special_instructions\":\"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.\",\"min_age\":18},\"checkout\":{\"time\":\"11:00 AM\"},\"fees\":{\"mandatory\":\"You'll be asked to pay the following charges at the hotel:
- Deposit: USD 50 per day
- Resort fee: USD 29.12 per accommodation, per night
The hotel resort fee includes:- Fitness center access
- Internet access
- Phone calls
- Additional inclusions
We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.
\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary) Airport shuttle fee: USD 350 per vehicle (one way) Rollaway bed fee: USD 175 per night\"},\"policies\":{\"know_before_you_go\":\"Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation. Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. Only registered guests are allowed in the guestrooms. Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. \"},\"attributes\":{\"general\":{\"2549\":{\"id\":\"2549\",\"name\":\"No elevators\"},\"3357\":{\"id\":\"3357\",\"name\":\"Caters to adults only\"}},\"pets\":{\"51\":{\"id\":\"51\",\"name\":\"Pets allowed\"},\"2809\":{\"id\":\"2809\",\"name\":\"Dogs only\"},\"3321\":{\"id\":\"3321\",\"name\":\"Pet maximum weight in kg is - 24\",\"value\":24}}},\"amenities\":{\"9\":{\"id\":\"9\",\"name\":\"Fitness facilities\"},\"2820\":{\"id\":\"2820\",\"name\":\"Number of indoor pools - 10\",\"value\":10}},\"images\":[{\"caption\":\"Featured Image\",\"hero_image\":true,\"category\":3,\"links\":{\"70px\":{\"method\":\"GET\",\"href\":\"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg\"}}}],\"onsite_payments\":{\"currency\":\"USD\",\"types\":{\"171\":{\"id\":\"171\",\"name\":\"American Express\"}}},\"rooms\":{\"224829\":{\"id\":\"224829\",\"name\":\"Single Room\",\"descriptions\":{\"overview\":\"2 Twin Beds
269-sq-foot (25-sq-meter) room with mountain views
Internet - Free WiFi
Entertainment - Flat-screen TV with cable channels
Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
Sleep - Premium bedding
Bathroom - Private bathroom, shower, bathrobes, and free toiletries
Practical - Safe and desk; cribs/infant beds available on request
Comfort - Climate-controlled air conditioning and daily housekeeping
Non-Smoking
\"},\"amenities\":{\"130\":{\"id\":\"130\",\"name\":\"Refrigerator\"},\"1234\":{\"id\":\"1234\",\"name\":\"Test Amenity - 200\",\"value\":\"200\"}},\"images\":[{\"hero_image\":true,\"category\":21001,\"links\":{\"70px\":{\"method\":\"GET\",\"href\":\"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg\"}},\"caption\":\"Guestroom\"}],\"bed_groups\":{\"37321\":{\"id\":\"37321\",\"description\":\"1 King Bed\",\"configuration\":[{\"type\":\"KingBed\",\"size\":\"King\",\"quantity\":1}]}},\"area\":{\"square_meters\":17},\"views\":{\"4134\":{\"id\":\"4134\",\"name\":\"City view\"}},\"occupancy\":{\"max_allowed\":{\"total\":3,\"children\":2,\"adults\":3},\"age_categories\":{\"ChildAgeA\":{\"name\":\"ChildAgeA\",\"minimum_age\":3}}}}},\"rates\":{\"333abc\":{\"id\":\"333abc\",\"amenities\":{\"1234\":{\"id\":\"1234\",\"name\":\"Test Amenity - 200\",\"value\":\"200\"},\"2104\":{\"id\":\"2104\",\"name\":\"Full Breakfast\"}},\"special_offer_description\":\"Breakfast for 2 - Rate includes the following:\\r\\n- Accommodations as selected
\\r\\n- Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room
\\r\\n
Must book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\\r\\n\"}},\"dates\":{\"added\":\"1998-07-20T05:00:00.000Z\",\"updated\":\"2018-03-22T13:33:17.000Z\"},\"descriptions\":{\"amenities\":\"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.\",\"dining\":\"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.\",\"renovations\":\"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: \",\"national_ratings\":\"For the benefit of our customers, we have provided a rating based on our rating system.\",\"business_amenities\":\"Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.\",\"rooms\":\"Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.\",\"attractions\":\"Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.
Distances are displayed to the nearest 0.1 mile and kilometer. Sogo Department Store - 0.7 km / 0.4 mi
National Museum of Natural Science - 1.1 km / 0.7 mi
Shr-Hwa International Tower - 1.4 km / 0.8 mi
Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
Taichung Metropolitan Opera House - 1.7 km / 1 mi
Tiger City Mall - 1.8 km / 1.1 mi
Maple Garden Park - 1.9 km / 1.2 mi
National Museum of Fine Arts - 2.1 km / 1.3 mi
Feng Chia University - 2.4 km / 1.5 mi
Bao An Temple - 2.5 km / 1.6 mi
Fengjia Night Market - 2.5 km / 1.6 mi
Zhonghua Night Market - 2.7 km / 1.7 mi
Chonglun Park - 2.9 km / 1.8 mi
Wan He Temple - 2.9 km / 1.8 mi
Chungyo Department Store - 3.1 km / 1.9 mi
The nearest airports are:
Taichung (RMQ) - 12 km / 7.5 mi
Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
Taipei (TSA-Songshan) - 135.5 km / 84.2 mi
\",\"location\":\"This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science.\",\"headline\":\"Near National Museum of Natural Science\",\"general\":\"General description\"},\"statistics\":{\"52\":{\"id\":\"52\",\"name\":\"Total number of rooms - 820\",\"value\":\"820\"},\"54\":{\"id\":\"54\",\"name\":\"Number of floors - 38\",\"value\":\"38\"}},\"airports\":{\"preferred\":{\"iata_airport_code\":\"SGF\"}},\"themes\":{\"2337\":{\"id\":\"2337\",\"name\":\"Luxury Hotel\"},\"2341\":{\"id\":\"2341\",\"name\":\"Spa Hotel\"}},\"all_inclusive\":{\"all_rate_plans\":true,\"some_rate_plans\":false,\"details\":\"This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).
Activities and facilities/equipment
Land activities
Lessons/classes/games Entertainment
- Onsite entertainment and activities
- Onsite live performances
\"},\"tax_id\":\"CD-012-987-1234-02\",\"chain\":{\"id\":\"-5\",\"name\":\"Hilton Worldwide\"},\"brand\":{\"id\":\"358\",\"name\":\"Hampton Inn\"},\"spoken_languages\":{\"en\":{\"id\":\"en\",\"name\":\"English\"}},\"multi_unit\":true,\"payment_registration_recommended\":true,\"vacation_rental_details\":{\"registry_number\":\"Property Registration Number 123456\",\"private_host\":\"true\",\"property_manager\":{\"name\":\"John Smith\",\"links\":{\"image\":{\"method\":\"GET\",\"href\":\"https://example.com/profile.jpg\"}}},\"rental_agreement\":{\"links\":{\"rental_agreement\":{\"method\":\"GET\",\"href\":\"https:/example.com/rentalconditions.pdf\"}}},\"house_rules\":[\"Children welcome\",\"No pets\",\"No smoking\",\"No parties or events\"],\"amenities\":{\"2859\":{\"id\":\"2859\",\"name\":\"Private pool\"},\"4296\":{\"id\":\"4296\",\"name\":\"Furnished balcony or patio\"}},\"vrbo_srp_id\":\"123.1234567.5678910\",\"listing_id\":\"1234567\",\"listing_number\":\"5678910\",\"listing_source\":\"HOMEAWAY_US\",\"listing_unit\":\"/units/0000/32d82dfa-1a48-45d6-9132-49fdbf1bfc60\"},\"supply_source\":\"vrbo\"}\n ```\n"
operationId: getPropertyContentFile
parameters:
- name: Accept
in: header
description: 'Specifies the response format that the client would like to receive back. This must be `application/json`.
'
required: true
schema:
type: string
example: application/json
- name: Accept-Encoding
in: header
description: 'Specifies the response encoding that the client would like to receive back. This must be `gzip`.
'
required: true
schema:
type: string
example: gzip
- name: Customer-Session-Id
in: header
description: 'Insert your own unique value for each user session, beginning with the first API call.
Continue to pass the same value for each subsequent API call during the user''s session, using a new value for every new customer session.
Including this value greatly eases EPS''s internal debugging process for issues with partner requests, as it explicitly links together request paths for individual user''s session.
'
schema:
type: string
- name: User-Agent
in: header
description: 'The `User-Agent` header string from the customer''s request, as captured by your integration. If you are building an application then the `User-Agent` value should be `{app name}/{app version}`.
'
required: true
schema:
type: string
example: TravelNow/3.30.112
- name: language
in: query
description: 'Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options)
'
required: true
schema:
type: string
example: language=en-US
- name: supply_source
in: query
description: "Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times.\n * `expedia` - Standard Expedia supply.\n * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information.\n"
required: true
schema:
type: string
example: vrbo
- name: billing_terms
in: query
description: 'This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: payment_terms
in: query
description: 'This parameter is to specify what terms should be used when being paid for a resulting booking. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: partner_point_of_sale
in: query
description: 'This parameter is to specify what point of sale is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: platform_name
in: query
description: 'This parameter is to specify what platform is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
responses:
'200':
description: OK
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Link'
example:
method: GET
href: https://example.com/propertycontent.jsonl.gz?amz-security-token=FQoDYXdzEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDD%2FiIFt2RCrdJKrkKSK3A2ncL3qC6SsXLyC3XxgRBGKykCfsfF40Jm8ud6ht6C1LB3q9X0maQCHyXV5gSl9g9hrHtOiC5fnihUQBASMAbOsepEKCfS%2B%2FWDrKAr5lTR%2FptslJxQs6v5GTO7G3R6PYIKFG%2FFgQydd8bEB2njMjynyvgXNgEPsb%2FVuiDC1K%2BMhvoRAguXo4QHQgOVVRXXmbl87j0Ih6s5ffI3yfIvEBnmEfdLdd2E5yPHuIO%2FOItXYxEc0vgipvlT41PylYtS8rhgc3MKqJO4Uw7yNPMlbphdxy6TJzQRJW15o9TaHrFBBYvWrtfcMewOlLYu6N6R1EGQhT9Ayok9J2oKzFJ%2FSbMNmVUsHReM7v1chuY7XNGld9bKeu0xFjDth%2BcEHrjkqhyxBc2pBINvk8LT9uPOCykqbuc2OWlCpNtQyahPnxpdPMW4WEbIFaWUNHWj0ui507CN2useZBYfGIST94KEtJFlpZRB0ntz%2BxmWRSnPYG3K47meFS9cthMsYH1rxIdDei2W49TQbjnVIXY2RldvO2JaTKtYPJT85ds9W71R0s4t9LSgY%2BZ9kaLjF%2BLk7PGKIhBbLowqKRBBUozOf2zAU%3D&AWSAccessKeyId=ASIAIZYRJJGNLGQGVLDA&Expires=1503512048&Signature=p7V%2BTN6rZMiVaz6MxqU%2F4YHYkw8%3D
expires: '2019-03-05T07:23:14.000Z'
'400':
description: Invalid Input
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: invalid_input
message: An invalid request was sent in, please check the nested errors for details.
errors:
- type: language.required
message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
- type: language.above_maximum
message: The number of languages passed in must not be greater than 1.
fields:
- name: language
type: querystring
- type: language.not_supported
message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]'
fields:
- name: language
type: querystring
value: xXX
'401':
description: Unauthorized
headers:
Region:
$ref: '#/components/headers/Region'
WWW-Authenticate:
description: Provides an example of the Authorization header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthenticated
message: Data required to authenticate your request is missing or inaccurate. Ensure that your request follows the guidelines in our documentation.
fields:
- name: apikey
type: header
value: jaj3982k239dka328e
- name: signature
type: header
value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b
- name: timestamp
type: header
value: 198284729
- name: servertimestamp
type: server
value: 198284729
'403':
description: Forbidden
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthorized
message: Your request could not be authorized.
'404':
description: Not Found
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: file.not_found
message: The requested file could not be found.
fields:
- name: filename
type: path
value: file.jsonl.gz
'426':
description: Upgrade Required
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: upgrade_required
message: This service requires the use of TLS.
'429':
description: Too Many Requests
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: too_many_requests
message: You have reached your capacity for this type of request.
'500':
description: Unknown Internal Error
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unknown_internal_error
message: An internal server error has occurred.
'503':
description: Service Unavailable
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: service_unavailable
message: This service is currently unavailable.
security:
- rapidAuth: []
/chains:
get:
tags:
- Content
summary: Expedia Group Chain Reference
description: 'Returns a complete collection of chains recognized by the Rapid API.
Chains represent a parent company which can have multiple brands associated with it. A brand can only be associated with one chain. For example, Hilton Worldwide is a chain that has multiple associated brands including Doubletree, Hampton Inn and Embassy Suites.
The response is a JSON map where the key is the chain ID and the value is a chain object. Each chain object also contains a map of its related brands.
Note that the set of chain IDs and brand IDs are totally independent of one another. It is possible for a chain and a brand to both use the same number as their ID, but this is just a coincidence that holds no meaning.
Chain and brand names are provided in English only.
'
operationId: getChainReference
parameters:
- name: Accept
in: header
description: 'Specifies the response format that the client would like to receive back. This must be `application/json`.
'
required: true
schema:
type: string
example: application/json
- name: Accept-Encoding
in: header
description: 'Specifies the response encoding that the client would like to receive back. This must be `gzip`.
'
required: true
schema:
type: string
example: gzip
- name: Customer-Session-Id
in: header
description: 'Insert your own unique value for each user session, beginning with the first API call.
Continue to pass the same value for each subsequent API call during the user''s session, using a new value for every new customer session.
Including this value greatly eases EPS''s internal debugging process for issues with partner requests, as it explicitly links together request paths for individual user''s session.
'
schema:
type: string
- name: User-Agent
in: header
description: 'The `User-Agent` header string from the customer''s request, as captured by your integration. If you are building an application then the `User-Agent` value should be `{app name}/{app version}`.
'
required: true
schema:
type: string
example: TravelNow/3.30.112
- name: billing_terms
in: query
description: 'This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: partner_point_of_sale
in: query
description: 'This parameter is to specify what point of sale is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: payment_terms
in: query
description: 'This parameter is to specify what terms should be used when being paid for a resulting booking. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
- name: platform_name
in: query
description: 'This parameter is to specify what platform is being used to shop and book. If this field is needed, the value for this will be provided to you separately.
'
schema:
type: string
responses:
'200':
description: OK
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/Chain'
example:
'-5':
id: -5
name: Hilton Worldwide
brands:
'33':
id: '33'
name: Doubletree
'2146':
id: '2146'
name: Conrad
'358':
id: '358'
name: Hampton Inn
'38':
id: '38'
name: Embassy Suites
'4615':
id: '4615'
name: Tapestry Collection by Hilton
'4138':
id: '4138'
name: Tru by Hilton
'2059':
id: '2059'
name: Hilton Garden Inn
'2608':
id: '2608'
name: Home2 Suites by Hilton
'2513':
id: '2513'
name: Hilton Grand Vacations
'2194':
id: '2194'
name: Waldorf Astoria
'54':
id: '54'
name: Homewood Suites
'55':
id: '55'
name: Hilton Hotels
'2199':
id: '2199'
name: Hilton International
'3000':
id: '3000'
name: Curio Collection
'2102':
id: '2102'
name: MGM
brands:
'2102':
id: '2102'
name: MGM
'4445':
id: '4445'
name: Studios 2 Let
brands:
'4498':
id: '4498'
name: Studios 2 Let
'6325':
id: '6325'
name: Isla Bonita
brands:
'6399':
id: '6399'
name: Isla Bonita
'6200':
id: '6200'
name: Urban Dream Hotels
brands:
'6325':
id: '6325'
name: Urban Dream Hotels
'401':
description: Unauthorized
headers:
Region:
$ref: '#/components/headers/Region'
WWW-Authenticate:
description: Provides an example of the Authorization header.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthenticated
message: Data required to authenticate your request is missing or inaccurate. Ensure that your request follows the guidelines in our documentation.
fields:
- name: apikey
type: header
value: jaj3982k239dka328e
- name: signature
type: header
value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b
- name: timestamp
type: header
value: 198284729
- name: servertimestamp
type: server
value: 198284729
'403':
description: Forbidden
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: request_unauthorized
message: Your request could not be authorized.
'426':
description: Upgrade Required
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: upgrade_required
message: This service requires the use of TLS.
'429':
description: Too Many Requests
headers:
Rate-Limit-Day:
description: Reserved for future use. Optional header for request capacity per day.
schema:
type: number
Rate-Limit-Day-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the daily time window.
schema:
type: number
Rate-Limit-Day-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets.
schema:
type: number
Rate-Limit-Minute:
description: Reserved for future use. Optional header for request capacity per minute.
schema:
type: number
Rate-Limit-Minute-Remaining:
description: Optional header for the remaining capacity, as a percentage, for the per minute time window.
schema:
type: number
Rate-Limit-Minute-Reset:
description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets.
schema:
type: number
Rate-Limit-Reduction-Status:
description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.
schema:
type: string
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: too_many_requests
message: You have reached your capacity for this type of request.
'500':
description: Unknown Internal Error
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: unknown_internal_error
message: An internal server error has occurred.
'503':
description: Service Unavailable
headers:
Region:
$ref: '#/components/headers/Region'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
type: service_unavailable
message: This service is currently unavailable.
security:
- rapidAuth: []
components:
schemas:
Link:
type: object
properties:
method:
type: string
description: The request method used to access the link.
href:
type: string
description: The URL for the link. This can be absolute or relative.
expires:
type: string
description: If the link expires, this will be the UTC date the link will expire, in ISO 8601 format.
description: An individual link.
BedGroupConfiguration:
type: object
properties:
type:
type: string
description: The type of this bed configuration in the room.
size:
type: string
description: The size of this bed configuration in the room.
quantity:
type: number
description: The number of this bed configuration in the room.
description: An individual bed configuration.
Descriptions:
type: object
properties:
amenities:
type: string
description: Describes general building amenities at the property.
dining:
type: string
description: Describes dining accommodations at the property.
renovations:
type: string
description: Describes any recent room or property renovations.
national_ratings:
type: string
description: States the source of the property's star rating (such as a regional or national tourism agency) and any other ratings claimed.
business_amenities:
type: string
description: Describes any business-specific amenities at the property, e.g. conference rooms.
rooms:
type: string
description: Describes typical room amenities.
attractions:
type: string
description: Nearby attractions/areas, often including distances from the property.
location:
type: string
description: General location as entered by the property.
headline:
type: string
description: A headline description for the property.
general:
type: string
description: A general description of a vacation rental property.
description: Descriptions of a property.
PropertyManager:
type: object
properties:
name:
type: string
description: The name of the property manager.
links:
$ref: '#/components/schemas/PropertyManagerLinks'
description: Information about the property manager.
PropertyInactive:
type: object
properties:
property_id:
type: string
description: The property id of the inactive property
ErrorIndividual:
type: object
properties:
type:
type: string
description: The error type.
message:
type: string
description: A human readable message giving details about this error.
fields:
type: array
description: Details about the specific fields that had an error.
items:
$ref: '#/components/schemas/Field'
description: An individual error.
RentalAgreementLinks:
type: object
properties:
rental_agreement:
$ref: '#/components/schemas/Link'
description: A map of links, including link to get the rental agreement.
BedGroup:
type: object
properties:
id:
type: string
description: Unique identifier for a bed group.
description:
type: string
description: This is a display ready description of a bed configuration for this room.
configuration:
type: array
description: An array of bed configurations for this room.
items:
$ref: '#/components/schemas/BedGroupConfiguration'
description: An individual bed group.
AllInclusive:
type: object
properties:
all_rate_plans:
type: boolean
description: Indicates if all rate plans at the property provide all-inclusive amenities.
some_rate_plans:
type: boolean
description: Indicates if some, but not all, rate plans at the property provide all-inclusive amenities.
details:
type: string
description: Details about amenities and services included in the all-inclusive rates.
description: Information about the all-inclusive rate plans available at the property.
Chain:
type: object
properties:
id:
type: string
description: Chain id.
name:
type: string
description: Chain name.
brands:
type: object
additionalProperties:
$ref: '#/components/schemas/Brand'
description: Map of the chain's brands.
description: An individual chain.
Localized:
type: object
properties:
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: Keyed by the language, a map of links to the property’s localized address(es) based on the primary language(s) spoken in the property’s country. Only languages supported by the Rapid API are provided.
description: Container for localized address information.
VacationRentalDetails:
type: object
properties:
registry_number:
type: string
description: The property's registry number required by some jurisdictions.
private_host:
type: boolean
description: Indicates if a property has a private host.
property_manager:
$ref: '#/components/schemas/PropertyManager'
rental_agreement:
$ref: '#/components/schemas/RentalAgreement'
house_rules:
type: array
description: List of strings detailing house rules.
items:
type: string
enhanced_house_rules:
type: object
additionalProperties:
$ref: '#/components/schemas/EnhancedHouseRules'
description: Map of enhanced house rules.
example:
Children:
rule: Children allowed
additional_information:
- Children allowed under age 13.
- Multiple children must sleep on cots.
Pets:
rule: Pets allowed
additional_information:
- Pets must be kept on the balcony.
amenities:
$ref: '#/components/schemas/Amenity'
vrbo_srp_id:
type: string
description: The Vrbo srp needed for link-off.
listing_id:
type: string
description: The listing id for a Vrbo property.
listing_number:
type: string
description: The listing number for a Vrbo property.
listing_source:
type: string
description: The listing source.
listing_unit:
type: string
description: The specific unit.
ipm_name:
type: string
description: 'The name of the IPM used to build guest messaging to inform travelers of the name of the IPM who will charge
their card and/or send them a confirmation email.
'
unit_configurations:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/UnitConfiguration'
description: Map of the vacation rental unit configurations. The key value is the unit location.
example:
'1':
- type: TWIN_SINGLE_BED
description: Twin/Single bed(s) -
quantity: 1
- type: CHILD_BED
description: Child bed(s) -
quantity: 1
'2':
- type: QUEEN_BED
description: Queen bed(s) -
quantity: 1
Other1:
- type: CHILD_BED
description: Child bed(s) -
quantity: 3
free_text:
type: string
description: A free text description that could contain significantly unstructured information that could impact the booking and should be displayed to customers. This field could contain html break tags `
` that may make display challenging.
description: Details for vacation rental properties.
Ratings:
type: object
properties:
property:
$ref: '#/components/schemas/PropertyRating'
guest:
$ref: '#/components/schemas/GuestRating'
description: Various types of ratings for this property.
Statistic:
type: object
properties:
id:
type: string
description: The statistic definition ID for this statistic.
name:
type: string
description: Statistic name.
value:
type: string
description: Statistic value.
description: An individual statistic.
Dates:
type: object
properties:
added:
type: string
description: The UTC date the property’s content was added to EPS, in ISO 8601 format
updated:
type: string
description: The UTC date the property’s content was updated by EPS, in ISO 8601 format.
description: Dates about the property.
Preferred:
type: object
properties:
iata_airport_code:
type: string
description: The airport's IATA code.
description: The preferred airport of the property.
PropertyManagerLinks:
type: object
properties:
image:
$ref: '#/components/schemas/Link'
additionalProperties:
$ref: '#/components/schemas/Link'
description: A map of links, including link to get image of the property manager.
RoomContent:
type: object
properties:
id:
type: string
description: Unique identifier for a room type.
name:
type: string
description: Room type name.
descriptions:
$ref: '#/components/schemas/DescriptionsRoom'
amenities:
type: object
additionalProperties:
$ref: '#/components/schemas/Amenity'
description: Lists all of the amenities available in the room. See our [amenities reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known amenity ID and name values.
images:
type: array
description: The room's images. Contains all room images available.
items:
$ref: '#/components/schemas/Image'
bed_groups:
type: object
additionalProperties:
$ref: '#/components/schemas/BedGroup'
description: A map of the room's bed groups.
area:
$ref: '#/components/schemas/Area'
views:
type: object
additionalProperties:
$ref: '#/components/schemas/View'
description: A map of the room views. See our [view reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known room view ID and name values.
occupancy:
$ref: '#/components/schemas/Occupancy'
description: An individual room.
SpokenLanguage:
type: object
properties:
id:
type: string
description: The language code as a subset of BCP47 format.
name:
type: string
description: Spoken language name.
description: An individual spoken language.
Error:
type: object
properties:
type:
type: string
description: The error type.
message:
type: string
description: A human readable message giving details about this error.
fields:
type: array
description: Details about the specific fields that had an error.
items:
$ref: '#/components/schemas/Field'
errors:
type: array
description: An array of all the actual errors that occured.
items:
$ref: '#/components/schemas/ErrorIndividual'
description: The overall class of error that occured.
TravelCompanion:
type: string
description: The companion category for any travelers that accompanied this reviewer.
enum:
- family
- family_with_children
- partner
- self
- friends
- pet
RentalAgreement:
type: object
properties:
links:
$ref: '#/components/schemas/RentalAgreementLinks'
description: Information about a vacation rentals rental agreement.
Review:
type: object
properties:
verification_source:
type: string
description: Where this review has been verified from.
title:
type: string
description: Title of this review.
date_submitted:
type: string
description: When this review was made, in ISO 8601 format.
rating:
type: string
description: The rating for this property given by the reviewer. Returns a value between 1.0 and 5.0.
reviewer_name:
type: string
description: The name of the person who wrote this review.
trip_reason:
$ref: '#/components/schemas/TripReason'
travel_companion:
$ref: '#/components/schemas/TravelCompanion'
text:
type: string
description: The text of the review itself.
description: A review object for a property.
Location:
type: object
properties:
coordinates:
$ref: '#/components/schemas/Coordinates'
obfuscated_coordinates:
$ref: '#/components/schemas/Coordinates'
obfuscation_required:
type: boolean
description: 'When this field is true, the `obfuscated_coordinates` must be used to display approximate location
instead of the precise location of `coordinates`.
'
description: The property's location information.
Occupancy:
type: object
properties:
max_allowed:
$ref: '#/components/schemas/MaxAllowed'
age_categories:
type: object
additionalProperties:
$ref: '#/components/schemas/CategoryAge'
description: Map of the age categories used to determine the maximum children and adult occupancy.
description: Occupancy information.
GuestReviews:
type: object
properties:
verified:
type: object
properties:
recent:
type: array
description: A collection of the guest reviews which have been verified, in order, starting with the newest.
items:
$ref: '#/components/schemas/Review'
description: A property's verified guest reviews.
description: A property's guest reviews.
Fees:
type: object
properties:
mandatory:
type: string
description: Describes resort fees and other mandatory taxes or charges. May describe which services are covered by any fees, such as fitness centers or internet access.
optional:
type: string
description: Describes additional optional fees for items such as breakfast, wifi, parking, pets etc.
description: Information related to a property's fees.
UnitConfiguration:
type: object
properties:
type:
type: string
description: Bed type.
description:
type: string
description: A description of the bed(s) in requested language.
quantity:
type: integer
description: The number of beds of this size.
description: A room configuration.
PropertyRating:
type: object
properties:
rating:
type: string
description: The rating assigned to this property. Returns a value between 0.0 and 5.0. A value of 0.0 or a blank value indicates no rating is available.
type:
type: string
description: Returns a value of either "Star" or "Alternate". Star indicates the rating is provided by the property’s local star rating authority. Alternate indicates that the rating is an Expedia-assigned value; an official rating was not available.
description: Information about the property's rating.
RateContent:
type: object
properties:
id:
type: string
description: Unique identifier for a rate.
amenities:
type: object
additionalProperties:
$ref: '#/components/schemas/Amenity'
description: This lists all of the Amenities available with a specific rate, including value adds, such as breakfast. See our [amenities reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known amenity ID and name values.
special_offer_description:
type: string
description: A text description of any special offers for this rate.
description: An individual rate.
PaymentType:
type: object
properties:
id:
type: string
description: The identifier of the payment type.
name:
type: string
description: The name of the payment type.
description: An individual payment type.
Field:
type: object
properties:
name:
type: string
description: The field that had an error.
type:
type: string
description: The type of the field that had an error.
value:
type: string
description: The value of the field that had an error.
description: An individual field that had an error.
Address:
type: object
properties:
line_1:
type: string
description: Address line 1.
example: 123 Main St
line_2:
type: string
description: Address line 2.
example: Apt A
city:
type: string
description: City.
example: Springfield
state_province_code:
type: string
description: 2-letter or 3-letter state/province code for Australia, Canada and the USA.
example: MO
state_province_name:
type: string
description: Text name of the State/Province - more common for additional countries.
example: Missouri
postal_code:
type: string
description: Postal/zip code.
example: '65804'
country_code:
type: string
description: 2-letter country code, in ISO 3166-1 alpha-2 format.
example: US
obfuscation_required:
type: boolean
description: Flag to indicate whether a property address requires obfuscation before the property has been booked. If true, only the city, province, and country of the address can be shown to the customer.
example: false
localized:
$ref: '#/components/schemas/Localized'
description: Container for the property's address information.
GuestRating:
type: object
properties:
count:
type: number
description: A count of all of the guest review ratings which currently exist for this property.
overall:
type: string
description: The overall rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
cleanliness:
type: string
description: The cleanliness rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
service:
type: string
description: The rating of the staff's service for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
comfort:
type: string
description: The comfort rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
condition:
type: string
description: The rating for the property's condition, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
location:
type: string
description: The rating for how convinent the location of the property is, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
neighborhood:
type: string
description: The rating for how satisfying the neighborhood of the property is, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
quality:
type: string
description: The quality rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
value:
type: string
description: The rating for how much value the property provided for the cost of the stay, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
amenities:
type: string
description: The rating for the amenities provided by the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
recommendation_percent:
type: string
description: The percent of guests who recommend staying at this property.
description: Rating information provided by guests who stayed at this property.
Theme:
type: object
properties:
id:
type: string
description: Identifier for the theme.
name:
type: string
description: Theme name.
description: An individual theme.
Checkin:
type: object
properties:
24_hour:
type: string
description: Present if the property has 24-hour check-in.
begin_time:
type: string
description: The time at which a property begins to allow check-ins.
end_time:
type: string
description: The time at which a property stops allowing check-ins.
instructions:
type: string
description: The property's check-in policy.
special_instructions:
type: string
description: Any special instructions for checking into this property that may be specific to this property.
min_age:
type: number
description: The minimum age for a customer to be able to check-in at a property.
description: The property's check-in information.
Image:
type: object
properties:
hero_image:
type: boolean
description: Whether this image is a hero image or not.
category:
type: number
description: The category of the image.
caption:
type: string
description: The image caption.
links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
description: 'Contains urls for all of the image sizes available. Sizes may include: 70 px, 200px, 350 px, and 1,000 px'
description: An individual image. See our [image categories reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known caption and category values.
Policies:
type: object
properties:
know_before_you_go:
type: string
description: Description of information that may be helpful when planning a trip to this property.
description: Information about property policies that guests need to be aware of.
TripReason:
type: string
description: The reason category for this reviewer's trip.
enum:
- business
- leisure
- friends_and_family
- business_and_leisure
View:
type: object
properties:
id:
type: string
description: Identifier for the view.
name:
type: string
description: View name.
description: An individual view.
Brand:
type: object
properties:
id:
type: string
description: Brand id.
name:
type: string
description: Brand name.
description: An individual brand.
Attribute:
type: object
properties:
id:
type: string
description: The attribute definition ID for this attribute.
name:
type: string
description: Attribute name.
value:
type: string
description: Attribute value.
description: An individual attribute.
PropertyContent:
type: object
properties:
property_id:
type: string
description: Unique Expedia property ID.
name:
type: string
description: Property name.
address:
$ref: '#/components/schemas/Address'
ratings:
$ref: '#/components/schemas/Ratings'
location:
$ref: '#/components/schemas/Location'
phone:
type: string
description: The property's phone number.
fax:
type: string
description: The property's fax number.
category:
$ref: '#/components/schemas/CategoryProperty'
business_model:
$ref: '#/components/schemas/BusinessModel'
rank:
type: number
description: The property’s rank across all properties. This value sorts properties based on EPS transactional data and details about the property, with 1 indicating the best-performing property and others following in ascending numerical order.
checkin:
$ref: '#/components/schemas/Checkin'
checkout:
$ref: '#/components/schemas/Checkout'
fees:
$ref: '#/components/schemas/Fees'
policies:
$ref: '#/components/schemas/Policies'
attributes:
$ref: '#/components/schemas/Attributes'
amenities:
type: object
additionalProperties:
$ref: '#/components/schemas/Amenity'
description: Lists all of the amenities available for all guests at the property. See our [amenities reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known amenity ID and name values.
images:
type: array
description: Contains all property images available.
items:
$ref: '#/components/schemas/Image'
onsite_payments:
$ref: '#/components/schemas/OnsitePayments'
rooms:
type: object
additionalProperties:
$ref: '#/components/schemas/RoomContent'
description: Information about all of the rooms at the property.
rates:
type: object
additionalProperties:
$ref: '#/components/schemas/RateContent'
description: Additional information about the rates offered by the property. This should be used in conjunction with the pricing and other rate-related information in shopping.
dates:
$ref: '#/components/schemas/Dates'
descriptions:
$ref: '#/components/schemas/Descriptions'
statistics:
type: object
additionalProperties:
$ref: '#/components/schemas/Statistic'
description: Statistics of the property, such as number of floors. See our [statistics reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known statistics ID and name values.
airports:
$ref: '#/components/schemas/AssociatedAirports'
themes:
type: object
additionalProperties:
$ref: '#/components/schemas/Theme'
description: Themes that describe the property. See our [themes reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known theme ID and name values.
all_inclusive:
$ref: '#/components/schemas/AllInclusive'
tax_id:
type: string
description: Tax ID.
chain:
$ref: '#/components/schemas/Chain'
brand:
$ref: '#/components/schemas/Brand'
spoken_languages:
type: object
additionalProperties:
$ref: '#/components/schemas/SpokenLanguage'
description: Languages spoken at the property.
multi_unit:
type: boolean
description: Boolean value indicating if a property is a multi-unit property.
payment_registration_recommended:
type: boolean
description: Boolean value indicating if a property may require payment registration to process payments, even when using the property_collect Business Model. If true, then a property may not be successfully bookable without registering payments first.
vacation_rental_details:
$ref: '#/components/schemas/VacationRentalDetails'
supply_source:
type: string
description: The supply source of the property.
description: An individual property object in the map of property objects.
CategoryProperty:
type: object
properties:
id:
type: string
description: The ID of the property's category.
name:
type: string
description: The property's category.
description: The property's category. See our [property categories reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known category ID and name values.
Amenity:
type: object
properties:
id:
type: string
description: The amenity definition ID for this amenity.
name:
type: string
description: Amenity name.
value:
type: string
description: Amenity value.
categories:
type: array
description: 'This is an optional field and will be present only if the amenity falls into one or more of these amenity categories.
See the Amenity Categories section of the
[Content Reference Lists](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists)
for a list of values.
'
items:
type: string
description: An individual amenity.
Coordinates:
type: object
properties:
latitude:
type: number
description: The latitude of the property.
longitude:
type: number
description: The longitude of the property.
description: The coordinates of the property.
Area:
type: object
properties:
square_meters:
type: number
description: The room's area, measured in square meters.
square_feet:
type: number
description: The room's area, measured in square feet.
description: Information about the area of the room.
OnsitePayments:
type: object
properties:
currency:
type: string
description: The currency accepted at the property.
types:
type: object
additionalProperties:
$ref: '#/components/schemas/PaymentType'
description: The types of payments accepted at the property.
description: The property’s accepted forms of payments when onsite. See our [onsite payment types reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known payment type ID and name values.
DescriptionsRoom:
type: object
properties:
overview:
type: string
description: Provides an overview of a room.
description: Descriptions of a room.
EnhancedHouseRules:
type: object
properties:
rule:
type: string
description: Describes the house rule.
example: Children allowed.
additional_information:
type: array
description: List of strings detailing further information about the rule.
example:
- Children allowed ages 13-17
- Three children are possible if one is in a cot
items:
type: string
CategoryAge:
type: object
properties:
name:
type: string
description: Age category name.
minimum_age:
type: number
description: Age category minimum age.
description: An age category.
Attributes:
type: object
properties:
general:
type: object
additionalProperties:
$ref: '#/components/schemas/Attribute'
description: Lists all of the general attributes about the property.
pets:
type: object
additionalProperties:
$ref: '#/components/schemas/Attribute'
description: Lists all of the pet attributes about the property.
description: Attributes about the property. See our [attributes reference](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) for current known attribute ID and name values.
AssociatedAirports:
type: object
properties:
preferred:
$ref: '#/components/schemas/Preferred'
description: Airports related to the property.
Checkout:
type: object
properties:
time:
type: string
description: The time by which a guest must check out.
description: The property's check-out information.
BusinessModel:
type: object
properties:
expedia_collect:
type: boolean
description: Whether or not a payment for this property can be taken by Expedia at the time of booking.
property_collect:
type: boolean
description: Whether or not a payment for this property can be taken by the property upon arrival.
description: How and when the payment can be taken.
MaxAllowed:
type: object
properties:
total:
type: number
description: Total maximum occupancy allowed.
children:
type: number
description: Maximum number of children allowed.
adults:
type: number
description: Maximum number of adults allowed.
description: Maximum occupancy counts.
headers:
Region:
description: Optional header that provides information about where the request was processed.
style: simple
explode: false
schema:
type: string
example: us-west-2
securitySchemes:
Basic:
type: http
scheme: basic