+
+
+
+
+
+ Extracts the room booking ID from a URL string if it exists; otherwise, returns null.
Extracts the token parameter from a URL string if it exists; otherwise, returns null.
Extracts the transaction ID from a response object if it exists; otherwise, returns null.
Extracts the room booking ID from a URL string if it exists; otherwise, returns null.
Extracts the token parameter from a URL string if it exists; otherwise, returns null.
Extracts the transaction ID from a response object if it exists; otherwise, returns null.
Change details of a room. This link will be available in the retrieve response. Changes in smoking preference and special request will be passed along to the property and are not guaranteed.
a Response object with a body of type Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Room ID of a property.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
The request body is required, but only the fields that are being changed need to be passed in. Fields that are not being changed should not be included in the request body.
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. (optional)
The change call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * unknown_internal_error (optional)
Change details of a room. This link will be available in the retrieve response. Changes in smoking preference and special request will be passed along to the property and are not guaranteed.
Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Room ID of a property.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
The request body is required, but only the fields that are being changed need to be passed in. Fields that are not being changed should not be included in the request body.
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. (optional)
The change call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * unknown_internal_error (optional)
Commit a change of itinerary that may require additional payment or refund. This link will be available in the change response to confirm and complete the change transaction. If additional charges are due, a payment must be submitted with this request. Note that Two-Factor Authentication is not supported at this time.
a Response object with a body of type Nothing
IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Room ID of a property.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The change call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * unknown_internal_error (optional)
The request body is required if additional payment is necessary. The body can optionally contain the change_reference_id. (optional)
Commit a change of itinerary that may require additional payment or refund. This link will be available in the change response to confirm and complete the change transaction. If additional charges are due, a payment must be submitted with this request. Note that Two-Factor Authentication is not supported at this time.
Nothing
IP address of the customer, as captured by your integration. Send IPV4 addresses only.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Room ID of a property.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The change call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * unknown_internal_error (optional)
The request body is required if additional payment is necessary. The body can optionally contain the change_reference_id. (optional)
Cancel Held Booking This link will be available in a held booking response.
a Response object with a body of type Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The cancel call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test held booking. * service_unavailable * internal_server_error * post_stay_cancel (optional)
Cancel Held Booking This link will be available in a held booking response.
Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The cancel call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test held booking. * service_unavailable * internal_server_error * post_stay_cancel (optional)
Cancel a room. This link will be available in the retrieve response.
a Response object with a body of type Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Room ID of a property.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The cancel call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * unknown_internal_error * post_stay_cancel (optional)
Cancel a room. This link will be available in the retrieve response.
Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Room ID of a property.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The cancel call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * unknown_internal_error * post_stay_cancel (optional)
Get additional property room rates and availability Returns additional rates on available room types, using the parameters of the previous call. The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
a Response object with a body of type kotlin.collections.List
Expedia Property ID.
A hashed collection of query parameters. Used to maintain state across calls. This token is provided as part of the additional_rates link from the shop response, or the shop link on a sold_out price check response. It is also provided from the shop_for_change link on an itinerary retrieve.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Shop calls have a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * unknown_internal_error * no_availability * forbidden (optional)
Check-in date, in ISO 8601 format (YYYY-MM-DD)
Note: Only needed for hard change if desired check-in date is different than original booking. If specified must also specify checkout. (optional)
Check-out date, in ISO 8601 format (YYYY-MM-DD). Availability can be searched up to 500 days in advance of this date. Total length of stay cannot exceed 28 nights.
Note: Only needed for hard change if desired check-out date is different than original booking. If specified must also specify checkin.
(optional)
Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
Note: Optional parameter for use with hard change requests.
* refundable_damage_deposit - Excludes rates with refundable damage deposits from the response. (optional)
Single filter type. Send multiple instances of this parameter to request multiple filters.
Note: Optional parameter for use with hard change requests.
* refundable - Filters results to only show fully refundable rates. * expedia_collect - Filters results to only show rates where payment is collected by Expedia at the time of booking. These properties can be eligible for payments via Expedia Affiliate Collect(EAC). * property_collect - Filters results to only show rates where payment is collected by the property after booking. This can include rates that require a deposit by the property, dependent upon the deposit policies. (optional)
Modify the response by including types of responses that are not provided by default.
* sale_scenario.mobile_promotion - Enable the mobile_promotion flag under the sale_scenario section of the response. (optional)
Defines the requested occupancy for a single room. Each room must have at least 1 adult occupant.
Format: numberOfAdults[-firstChildAge[,nextChildAge]]
To request multiple rooms (of the same type), include one instance of occupancy for each room requested. Up to 8 rooms may be requested or booked at once.
Note: Only needed for hard change if desired occupancy is different than original booking.
Examples: * 2 adults, one 9-year-old and one 4-year-old would be represented by occupancy=2-9,4.
* A multi-room request to lodge an additional 2 adults would be represented by occupancy=2-9,4&occupancy=2 (optional)
Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. Note: Optional parameter for use with hard change requests.
Accepted values:
* member - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. * net_rates - Return net rates for each property. This feature must be enabled to request these rates. * cross_sell - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. (optional)
Provide the sales channel if you wish to override the sales_channel provided in the previous call. EPS dynamically provides the best content for optimal conversion on each sales channel.
Note: Must specify this value for hard change requests.
* website - Standard website accessed from the customer's computer * agent_tool - Your own agent tool used by your call center or retail store agent * mobile_app - An application installed on a phone or tablet device * mobile_web - A web browser application on a phone or tablet device * meta - Rates will be passed to and displayed on a 3rd party comparison website * cache - Rates will be used to populate a local cache (optional)
Provide the sales environment if you wish to override the sales_environment provided in the previous call. EPS dynamically provides the best content for optimal conversion. If you have a sales environment that is not currently supported in this list, please contact our support team.
Note: Must specify this value for hard change requests.
* hotel_package - Standard website accessed from the customer's computer * hotel_only - Your own agent tool used by your call center or retail store agent * loyalty - An application installed on a phone or tablet device (optional)
Get additional property room rates and availability Returns additional rates on available room types, using the parameters of the previous call. The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
kotlin.collections.List
Expedia Property ID.
A hashed collection of query parameters. Used to maintain state across calls. This token is provided as part of the additional_rates link from the shop response, or the shop link on a sold_out price check response. It is also provided from the shop_for_change link on an itinerary retrieve.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Shop calls have a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * unknown_internal_error * no_availability * forbidden (optional)
Check-in date, in ISO 8601 format (YYYY-MM-DD)
Note: Only needed for hard change if desired check-in date is different than original booking. If specified must also specify checkout. (optional)
Check-out date, in ISO 8601 format (YYYY-MM-DD). Availability can be searched up to 500 days in advance of this date. Total length of stay cannot exceed 28 nights.
Note: Only needed for hard change if desired check-out date is different than original booking. If specified must also specify checkin.
(optional)
Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
Note: Optional parameter for use with hard change requests.
* refundable_damage_deposit - Excludes rates with refundable damage deposits from the response. (optional)
Single filter type. Send multiple instances of this parameter to request multiple filters.
Note: Optional parameter for use with hard change requests.
* refundable - Filters results to only show fully refundable rates. * expedia_collect - Filters results to only show rates where payment is collected by Expedia at the time of booking. These properties can be eligible for payments via Expedia Affiliate Collect(EAC). * property_collect - Filters results to only show rates where payment is collected by the property after booking. This can include rates that require a deposit by the property, dependent upon the deposit policies. (optional)
Modify the response by including types of responses that are not provided by default.
* sale_scenario.mobile_promotion - Enable the mobile_promotion flag under the sale_scenario section of the response. (optional)
Defines the requested occupancy for a single room. Each room must have at least 1 adult occupant.
Format: numberOfAdults[-firstChildAge[,nextChildAge]]
To request multiple rooms (of the same type), include one instance of occupancy for each room requested. Up to 8 rooms may be requested or booked at once.
Note: Only needed for hard change if desired occupancy is different than original booking.
Examples: * 2 adults, one 9-year-old and one 4-year-old would be represented by occupancy=2-9,4.
* A multi-room request to lodge an additional 2 adults would be represented by occupancy=2-9,4&occupancy=2 (optional)
Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. Note: Optional parameter for use with hard change requests.
Accepted values:
* member - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. * net_rates - Return net rates for each property. This feature must be enabled to request these rates. * cross_sell - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. (optional)
Provide the sales channel if you wish to override the sales_channel provided in the previous call. EPS dynamically provides the best content for optimal conversion on each sales channel.
Note: Must specify this value for hard change requests.
* website - Standard website accessed from the customer's computer * agent_tool - Your own agent tool used by your call center or retail store agent * mobile_app - An application installed on a phone or tablet device * mobile_web - A web browser application on a phone or tablet device * meta - Rates will be passed to and displayed on a 3rd party comparison website * cache - Rates will be used to populate a local cache (optional)
Provide the sales environment if you wish to override the sales_environment provided in the previous call. EPS dynamically provides the best content for optimal conversion. If you have a sales environment that is not currently supported in this list, please contact our support team.
Note: Must specify this value for hard change requests.
* hotel_package - Standard website accessed from the customer's computer * hotel_only - Your own agent tool used by your call center or retail store agent * loyalty - An application installed on a phone or tablet device (optional)
Get property room rates and availability Returns rates on available room types for specified properties (maximum of 250 properties per request). The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * Multiple rooms of the same type may be requested by including multiple instances of the occupancy parameter. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
a Response object with a body of type kotlin.collections.List
Check-in date, in ISO 8601 format (YYYY-MM-DD)
Check-out date, in ISO 8601 format (YYYY-MM-DD). Availability can be searched up to 500 days in advance of this date. Total length of stay cannot exceed 28 nights.
Requested currency for the rates, in ISO 4217 format
Currency Options: https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options
The country code of the traveler's point of sale, in ISO 3166-1 alpha-2 format. This should represent the country where the shopping transaction is taking place.
For more information see: https://www.iso.org/obp/ui/#search/code/
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/
Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
Defines the requested occupancy for a single room. Each room must have at least 1 adult occupant.
Format: numberOfAdults[-firstChildAge[,nextChildAge]]
To request multiple rooms (of the same type), include one instance of occupancy for each room requested. Up to 8 rooms may be requested or booked at once.
Examples: * 2 adults, one 9-year-old and one 4-year-old would be represented by occupancy=2-9,4.
* A multi-room request to lodge an additional 2 adults would be represented by occupancy=2-9,4&occupancy=2
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized.
The value must be between 1 and 250.
You must provide the sales channel for the display of rates. EPS dynamically provides the best content for optimal conversion on each sales channel. If you have a sales channel that is not currently supported in this list, please contact our support team.
* website - Standard website accessed from the customer's computer * agent_tool - Your own agent tool used by your call center or retail store agent * mobile_app - An application installed on a phone or tablet device * mobile_web - A web browser application on a phone or tablet device * meta - Rates will be passed to and displayed on a 3rd party comparison website * cache - Rates will be used to populate a local cache
You must provide the sales environment in which rates will be sold. EPS dynamically provides the best content for optimal conversion. If you have a sales environment that is not currently supported in this list, please contact our support team.
* hotel_package - Use when selling the hotel with a transport product, e.g. flight & hotel. * hotel_only - Use when selling the hotel as an individual product. * loyalty - Use when you are selling the hotel as part of a loyalty program and the price is converted to points.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Shop calls have a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * unknown_internal_error (optional)
Single amenity category. Send multiple instances of this parameter to request rates that match multiple amenity categories.
See the Amenity Categories section of the Content Reference Lists for a list of values. (optional)
Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
* refundable_damage_deposit - Excludes rates with refundable damage deposits from the response. (optional)
Single filter type. Send multiple instances of this parameter to request multiple filters.
* refundable - Filters results to only show fully refundable rates. * expedia_collect - Filters results to only show rates where payment is collected by Expedia at the time of booking. These properties can be eligible for payments via Expedia Affiliate Collect(EAC). * property_collect - Filters results to only show rates where payment is collected by the property after booking. This can include rates that require a deposit by the property, dependent upon the deposit policies. (optional)
Modify the response by including types of responses that are not provided by default.
* unavailable_reason - When a property is unavailable for an actionable reason, return a response with that reason - See Unavailable Reason Codes for possible values. * sale_scenario.mobile_promotion - Enable the mobile_promotion flag under the room.rate.sale_scenario section of the response. * rooms.rates.marketing_fee_incentives - When a rate has a marketing fee incentive applied, the response will include the marketing_fee_incentives array if this flag is provided in the request. (optional)
Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. Accepted values:
* member - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. * net_rates - Return net rates for each property. This feature must be enabled to request these rates. * cross_sell - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. (optional)
This parameter is to specify the travel purpose of the booking. This may impact available rate plans, pricing, or tax calculations. * leisure * business (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Get property room rates and availability Returns rates on available room types for specified properties (maximum of 250 properties per request). The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * Multiple rooms of the same type may be requested by including multiple instances of the occupancy parameter. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
kotlin.collections.List
Check-in date, in ISO 8601 format (YYYY-MM-DD)
Check-out date, in ISO 8601 format (YYYY-MM-DD). Availability can be searched up to 500 days in advance of this date. Total length of stay cannot exceed 28 nights.
Requested currency for the rates, in ISO 4217 format
Currency Options: https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options
The country code of the traveler's point of sale, in ISO 3166-1 alpha-2 format. This should represent the country where the shopping transaction is taking place.
For more information see: https://www.iso.org/obp/ui/#search/code/
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/
Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
Defines the requested occupancy for a single room. Each room must have at least 1 adult occupant.
Format: numberOfAdults[-firstChildAge[,nextChildAge]]
To request multiple rooms (of the same type), include one instance of occupancy for each room requested. Up to 8 rooms may be requested or booked at once.
Examples: * 2 adults, one 9-year-old and one 4-year-old would be represented by occupancy=2-9,4.
* A multi-room request to lodge an additional 2 adults would be represented by occupancy=2-9,4&occupancy=2
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized.
The value must be between 1 and 250.
You must provide the sales channel for the display of rates. EPS dynamically provides the best content for optimal conversion on each sales channel. If you have a sales channel that is not currently supported in this list, please contact our support team.
* website - Standard website accessed from the customer's computer * agent_tool - Your own agent tool used by your call center or retail store agent * mobile_app - An application installed on a phone or tablet device * mobile_web - A web browser application on a phone or tablet device * meta - Rates will be passed to and displayed on a 3rd party comparison website * cache - Rates will be used to populate a local cache
You must provide the sales environment in which rates will be sold. EPS dynamically provides the best content for optimal conversion. If you have a sales environment that is not currently supported in this list, please contact our support team.
* hotel_package - Use when selling the hotel with a transport product, e.g. flight & hotel. * hotel_only - Use when selling the hotel as an individual product. * loyalty - Use when you are selling the hotel as part of a loyalty program and the price is converted to points.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Shop calls have a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * unknown_internal_error (optional)
Single amenity category. Send multiple instances of this parameter to request rates that match multiple amenity categories.
See the Amenity Categories section of the Content Reference Lists for a list of values. (optional)
Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
* refundable_damage_deposit - Excludes rates with refundable damage deposits from the response. (optional)
Single filter type. Send multiple instances of this parameter to request multiple filters.
* refundable - Filters results to only show fully refundable rates. * expedia_collect - Filters results to only show rates where payment is collected by Expedia at the time of booking. These properties can be eligible for payments via Expedia Affiliate Collect(EAC). * property_collect - Filters results to only show rates where payment is collected by the property after booking. This can include rates that require a deposit by the property, dependent upon the deposit policies. (optional)
Modify the response by including types of responses that are not provided by default.
* unavailable_reason - When a property is unavailable for an actionable reason, return a response with that reason - See Unavailable Reason Codes for possible values. * sale_scenario.mobile_promotion - Enable the mobile_promotion flag under the room.rate.sale_scenario section of the response. * rooms.rates.marketing_fee_incentives - When a rate has a marketing fee incentive applied, the response will include the marketing_fee_incentives array if this flag is provided in the request. (optional)
Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. Accepted values:
* member - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. * net_rates - Return net rates for each property. This feature must be enabled to request these rates. * cross_sell - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. (optional)
This parameter is to specify the travel purpose of the booking. This may impact available rate plans, pricing, or tax calculations. * leisure * business (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Get a calendar of availability dates for properties. This is currently a Vrbo property only feature. Returns availability information for the specified properties (maximum of 25 properties per request). The response includes per day information about the property's availability, information about if check-in or check-out is available for the day, and information regarding the stay constraints.
a Response object with a body of type kotlin.collections.List
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
The first day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD), up to 500 days in the future from the current date.
The last day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD). This must be 365 days or less from the start_date.
Shop calls have a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * unknown_internal_error (optional)
Get a calendar of availability dates for properties. This is currently a Vrbo property only feature. Returns availability information for the specified properties (maximum of 25 properties per request). The response includes per day information about the property's availability, information about if check-in or check-out is available for the day, and information regarding the stay constraints.
kotlin.collections.List
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
The first day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD), up to 500 days in the future from the current date.
The last day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD). This must be 365 days or less from the start_date.
Shop calls have a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * unknown_internal_error (optional)
Chain Reference 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.
a Response object with a body of type kotlin.collections.Map
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Chain Reference 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.
kotlin.collections.Map
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Inactive Properties 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.
a Response object with a body of type kotlin.collections.List
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. (optional)
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) (optional)
Only used for requesting additional pages of data. Provided by the next URL in the Link response header. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Inactive Properties 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.
kotlin.collections.List
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. (optional)
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) (optional)
Only used for requesting additional pages of data. Provided by the next URL in the Link response header. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Get Accepted Payment Types - EPS MOR Only Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking.
a Response object with a body of type PaymentOption
Expedia Property ID.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Get Accepted Payment Types - EPS MOR Only Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking.
PaymentOption
Expedia Property ID.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Property Catalog File 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.
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: * property_id * name * address * ratings * location * phone * fax * category * rank * business_model * dates * statistics * chain * brand * supply_source
Example of a JSONL file with 2 properties: `` {\"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\"} {\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return a Response object with a body of type Link
Property Catalog File 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.
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: * property_id * name * address * ratings * location * phone * fax * category * rank * business_model * dates * statistics * chain * brand * supply_source
Example of a JSONL file with 2 properties: `` {\"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\"} {\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return Link
Property Content File 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.
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.
Example of a JSONL file with 2 properties: `` {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return a Response object with a body of type Link
Property Content File 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.
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.
Example of a JSONL file with 2 properties: `` {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return Link
Property Content 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.
a Response object with a body of type kotlin.collections.Map
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/
Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information.
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. (optional)
Search to include properties that have the requested all_inclusive values equal to true. If this parameter is not supplied, all all_inclusive scenarios are included. This parameter can be supplied multiple times with different values, which will include properties that match any of the requested scenarios. * all_rate_plans - Return properties where all_inclusive.all_rate_plans is true. * some_rate_plans = Return properties where all_inclusive.some_rate_plans is true. (optional)
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. (optional)
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. (optional)
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. (optional)
Search for properties with the requested business model enabled. This parameter can be supplied multiple times with different values, which will return all properties that match any of the requested business models. The value must be lower case. * expedia_collect - Return only properties where the payment is collected by Expedia. * property_collect - Return only properties where the payment is collected at the property. (optional)
Search to include properties that have the requested category ID. 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. (optional)
Search to exclude properties that do not have the requested category ID. 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. (optional)
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. (optional)
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. (optional)
Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Each time this parameter is specified will add to the list of fields and associated objects returned in the response. All values and field names are lower case. The values property_ids and catalog will continue to behave as specified below for backwards compatibility. All other top level field names will add the specified field to the list of fields returned in the response. See the response schema for a full list of top level field names. Additionally, the field property_id will always be returned regardless of what include values are passed.
Possible values: * property_ids - DEPRECATED - Please use property_id which matches the response field name. * catalog - Include all property catalog fields. See Property Catalog File endpoint for a list of fields. * property_id - Passing in the value property_id and no other values will limit the response to only property_id. Not necessary to include in combination with other field name values, as it will always be returned. * All field names found at the top level of the property content response are now valid values for inclusion. (optional)
Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit properties will be included. * true - Include only properties that are multi-unit. * false - Do not include properties that are multi-unit. (optional)
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. (optional)
Search for properties with a property rating less than or equal to the requested rating. The highest property rating value is 5.0. (optional)
Search for properties with a property rating greater than or equal to the requested rating. The lowest property rating value is 0.0. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Property Content 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.
kotlin.collections.Map
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/
Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information.
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. (optional)
Search to include properties that have the requested all_inclusive values equal to true. If this parameter is not supplied, all all_inclusive scenarios are included. This parameter can be supplied multiple times with different values, which will include properties that match any of the requested scenarios. * all_rate_plans - Return properties where all_inclusive.all_rate_plans is true. * some_rate_plans = Return properties where all_inclusive.some_rate_plans is true. (optional)
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. (optional)
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. (optional)
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. (optional)
Search for properties with the requested business model enabled. This parameter can be supplied multiple times with different values, which will return all properties that match any of the requested business models. The value must be lower case. * expedia_collect - Return only properties where the payment is collected by Expedia. * property_collect - Return only properties where the payment is collected at the property. (optional)
Search to include properties that have the requested category ID. 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. (optional)
Search to exclude properties that do not have the requested category ID. 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. (optional)
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. (optional)
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. (optional)
Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) (optional)
Each time this parameter is specified will add to the list of fields and associated objects returned in the response. All values and field names are lower case. The values property_ids and catalog will continue to behave as specified below for backwards compatibility. All other top level field names will add the specified field to the list of fields returned in the response. See the response schema for a full list of top level field names. Additionally, the field property_id will always be returned regardless of what include values are passed.
Possible values: * property_ids - DEPRECATED - Please use property_id which matches the response field name. * catalog - Include all property catalog fields. See Property Catalog File endpoint for a list of fields. * property_id - Passing in the value property_id and no other values will limit the response to only property_id. Not necessary to include in combination with other field name values, as it will always be returned. * All field names found at the top level of the property content response are now valid values for inclusion. (optional)
Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit properties will be included. * true - Include only properties that are multi-unit. * false - Do not include properties that are multi-unit. (optional)
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. (optional)
Search for properties with a property rating less than or equal to the requested rating. The highest property rating value is 5.0. (optional)
Search for properties with a property rating greater than or equal to the requested rating. The lowest property rating value is 0.0. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Property Guest Reviews 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 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.
a Response object with a body of type GuestReviews
Expedia Property ID.
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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Property Guest Reviews 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 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.
GuestReviews
Expedia Property ID.
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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Region Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object.
a Response object with a body of type Region
ID of the region to retrieve.
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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
Options for which content to return in the response. This parameter can be supplied multiple times with different values. The value must be lower case. * details - Include the metadata, coordinates and full hierarchy of the region. * property_ids - Include the list of property IDs within the bounding polygon of the region. * property_ids_expanded - Include the list of property IDs within the bounding polygon of the region and property IDs from the surrounding area if minimal properties are within the region.
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Options for which supply source you would like returned in the geography 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)
Region Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object.
Region
ID of the region to retrieve.
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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
Options for which content to return in the response. This parameter can be supplied multiple times with different values. The value must be lower case. * details - Include the metadata, coordinates and full hierarchy of the region. * property_ids - Include the list of property IDs within the bounding polygon of the region. * property_ids_expanded - Include the list of property IDs within the bounding polygon of the region and property IDs from the surrounding area if minimal properties are within the region.
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Options for which supply source you would like returned in the geography 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)
Regions Returns the geographic definition and property mappings of regions matching the specified parameters.
To request all regions in the world, omit the ancestor query parameter. To request all regions in a specific continent, country or other level, specify the ID of that region as the ancestor. Refer to the list of top level regions.
The response is a paginated list of regions. See the Link header in the 200 response section.
a Response object with a body of type kotlin.collections.List
Options for which content to return in the response. This parameter can be supplied multiple times with different values. The standard and details options cannot be requested together. The value must be lower case. * standard - Include the metadata and basic hierarchy of each region. * details - Include the metadata, coordinates and full hierarchy of each region. * property_ids - Include the list of property IDs within the bounding polygon of each region. * property_ids_expanded - Include the list of property IDs within the bounding polygon of each region and property IDs from the surrounding area if minimal properties are within the region.
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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
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. (optional)
Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of top level regions. (optional)
Filter the results to regions that intersect with a specified area.
The area may be defined in one of two ways: * radius,region_id * radius,latitude,longitude Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
Due to the number of results, unless point_of_interest is specified as the only type, regions of type point_of_interest will not be included in a request that filters to an area.
An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
&type=airport&limit=3&area=50,37.227924,-93.310036 (optional)
Filter the results to a specified ISO 3166-1 alpha-2 country code. For more information see: https://www.iso.org/obp/ui/#search/code/ (optional)
Filter the results down to only the ISO 3166-2 country subdivision. (optional)
Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. (optional)
Limit the number of results returned. Using the area parameter will impose a max value of 100 for this whether specified or not. (optional)
Options for which supply source you would like returned in the geography 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)
Filter the results to a specified region type. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Regions Returns the geographic definition and property mappings of regions matching the specified parameters.
To request all regions in the world, omit the ancestor query parameter. To request all regions in a specific continent, country or other level, specify the ID of that region as the ancestor. Refer to the list of top level regions.
The response is a paginated list of regions. See the Link header in the 200 response section.
kotlin.collections.List
Options for which content to return in the response. This parameter can be supplied multiple times with different values. The standard and details options cannot be requested together. The value must be lower case. * standard - Include the metadata and basic hierarchy of each region. * details - Include the metadata, coordinates and full hierarchy of each region. * property_ids - Include the list of property IDs within the bounding polygon of each region. * property_ids_expanded - Include the list of property IDs within the bounding polygon of each region and property IDs from the surrounding area if minimal properties are within the region.
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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options
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. (optional)
Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of top level regions. (optional)
Filter the results to regions that intersect with a specified area.
The area may be defined in one of two ways: * radius,region_id * radius,latitude,longitude Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
Due to the number of results, unless point_of_interest is specified as the only type, regions of type point_of_interest will not be included in a request that filters to an area.
An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
&type=airport&limit=3&area=50,37.227924,-93.310036 (optional)
Filter the results to a specified ISO 3166-1 alpha-2 country code. For more information see: https://www.iso.org/obp/ui/#search/code/ (optional)
Filter the results down to only the ISO 3166-2 country subdivision. (optional)
Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. (optional)
Limit the number of results returned. Using the area parameter will impose a max value of 100 for this whether specified or not. (optional)
Options for which supply source you would like returned in the geography 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)
Filter the results to a specified region type. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Retrieve Booking This API call returns itinerary details and links to resume or cancel the booking. There are two methods to retrieve a booking: * Using the link included in the original Book response, example: https://api.ean.com/v3/itineraries/8955599932111?token=QldfCGlcUA4GXVlSAQ4W * Using the email of the booking. If the email contains special characters, they must be encoded to successfully retrieve the booking. Example: https://api.ean.com/v3/itineraries/8955599932111?email=customer@email.com Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive an error when trying to retrieve an itinerary that was successfully created, please wait a few minutes before trying to retrieve the itinerary again.
a Response object with a body of type Itinerary
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
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. (optional)
The retrieve call has a test header that can be used to return set responses. Passing standard in the Test header will retrieve a test booking, and passing any of the errors listed below will return a stubbed error response that you can use to test your error handling code. Additionally, refer to the Test Request documentation for more details on how these header values are used. * standard - Requires valid test booking. * service_unavailable * internal_server_error (optional)
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed. (optional)
Email associated with the booking. Special characters in the local part or domain should be encoded. (Email is required if the token is not provided the request)
(optional)
Options for which information to return in the response. The value must be lower case. * history - Include itinerary history, showing details of the changes made to this itinerary (optional)
Retrieve Booking This API call returns itinerary details and links to resume or cancel the booking. There are two methods to retrieve a booking: * Using the link included in the original Book response, example: https://api.ean.com/v3/itineraries/8955599932111?token=QldfCGlcUA4GXVlSAQ4W * Using the email of the booking. If the email contains special characters, they must be encoded to successfully retrieve the booking. Example: https://api.ean.com/v3/itineraries/8955599932111?email=customer@email.com Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive an error when trying to retrieve an itinerary that was successfully created, please wait a few minutes before trying to retrieve the itinerary again.
Itinerary
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
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. (optional)
The retrieve call has a test header that can be used to return set responses. Passing standard in the Test header will retrieve a test booking, and passing any of the errors listed below will return a stubbed error response that you can use to test your error handling code. Additionally, refer to the Test Request documentation for more details on how these header values are used. * standard - Requires valid test booking. * service_unavailable * internal_server_error (optional)
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed. (optional)
Email associated with the booking. Special characters in the local part or domain should be encoded. (Email is required if the token is not provided the request)
(optional)
Options for which information to return in the response. The value must be lower case. * history - Include itinerary history, showing details of the changes made to this itinerary (optional)
Search for and retrieve Bookings with Affiliate Reference Id This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to find an itinerary that was successfully created, please wait a few minutes before trying to search for the itinerary again.
a Response object with a body of type kotlin.collections.List
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
The affilliate reference id value. This field supports a maximum of 28 characters.
Email associated with the booking. Special characters in the local part or domain should be encoded.
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. (optional)
The retrieve call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * internal_server_error (optional)
Options for which information to return in the response. The value must be lower case. * history - Include itinerary history, showing details of the changes made to this itinerary (optional)
Search for and retrieve Bookings with Affiliate Reference Id This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to find an itinerary that was successfully created, please wait a few minutes before trying to search for the itinerary again.
kotlin.collections.List
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
The affilliate reference id value. This field supports a maximum of 28 characters.
Email associated with the booking. Special characters in the local part or domain should be encoded.
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. (optional)
The retrieve call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test booking. * service_unavailable * internal_server_error (optional)
Options for which information to return in the response. The value must be lower case. * history - Include itinerary history, showing details of the changes made to this itinerary (optional)
Change details of a room. This link will be available in the retrieve response. Changes in smoking preference and special request will be passed along to the property and are not guaranteed.
Change details of a room. This link will be available in the retrieve response. Changes in smoking preference and special request will be passed along to the property and are not guaranteed.
Commit a change of itinerary that may require additional payment or refund. This link will be available in the change response to confirm and complete the change transaction. If additional charges are due, a payment must be submitted with this request. Note that Two-Factor Authentication is not supported at this time.
Commit a change of itinerary that may require additional payment or refund. This link will be available in the change response to confirm and complete the change transaction. If additional charges are due, a payment must be submitted with this request. Note that Two-Factor Authentication is not supported at this time.
Cancel Held Booking This link will be available in a held booking response.
Cancel Held Booking This link will be available in a held booking response.
Cancel a room. This link will be available in the retrieve response.
Cancel a room. This link will be available in the retrieve response.
Get additional property room rates and availability Returns additional rates on available room types, using the parameters of the previous call. The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
Get additional property room rates and availability Returns additional rates on available room types, using the parameters of the previous call. The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
Get property room rates and availability Returns rates on available room types for specified properties (maximum of 250 properties per request). The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * Multiple rooms of the same type may be requested by including multiple instances of the occupancy parameter. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
Get property room rates and availability Returns rates on available room types for specified properties (maximum of 250 properties per request). The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. Note: If there are no available rooms, the response will be an empty array. * Multiple rooms of the same type may be requested by including multiple instances of the occupancy parameter. * The nightly array includes each individual night's charges. When the total price includes fees, charges, or adjustments that are not divided by night, these amounts will be included in the stay rate array, which details charges applied to the entire stay (each check-in).
Get a calendar of availability dates for properties. This is currently a Vrbo property only feature. Returns availability information for the specified properties (maximum of 25 properties per request). The response includes per day information about the property's availability, information about if check-in or check-out is available for the day, and information regarding the stay constraints.
Get a calendar of availability dates for properties. This is currently a Vrbo property only feature. Returns availability information for the specified properties (maximum of 25 properties per request). The response includes per day information about the property's availability, information about if check-in or check-out is available for the day, and information regarding the stay constraints.
Chain Reference 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.
Chain Reference 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.
Inactive Properties 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.
Inactive Properties 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.
Get Accepted Payment Types - EPS MOR Only Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking.
Get Accepted Payment Types - EPS MOR Only Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking.
Property Catalog File 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.
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: * property_id * name * address * ratings * location * phone * fax * category * rank * business_model * dates * statistics * chain * brand * supply_source
Example of a JSONL file with 2 properties: `` {\"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\"} {\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return Link
Property Catalog File 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.
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: * property_id * name * address * ratings * location * phone * fax * category * rank * business_model * dates * statistics * chain * brand * supply_source
Example of a JSONL file with 2 properties: `` {\"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\"} {\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return a Response object with a body of type Link
Property Content 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.
Property Content File 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.
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.
Example of a JSONL file with 2 properties: `` {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return Link
Property Content File 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.
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.
Example of a JSONL file with 2 properties: `` {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} {\"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\":\"<p>You'll be asked to pay the following charges at the hotel:</p> <ul><li>Deposit: USD 50 per day</li><li>Resort fee: USD 29.12 per accommodation, per night</li></ul> The hotel resort fee includes:<ul><li>Fitness center access</li><li>Internet access</li><li>Phone calls</li><li>Additional inclusions</li></ul> <p>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. </p>\",\"optional\":\"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)</li> <li>Airport shuttle fee: USD 350 per vehicle (one way)</li> <li>Rollaway bed fee: USD 175 per night</li>\"},\"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. </li><li>Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>Only registered guests are allowed in the guestrooms. </li> <li>Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation. </li> </ul>\"},\"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\":\"<strong>2 Twin Beds</strong><br />269-sq-foot (25-sq-meter) room with mountain views<br /><br /><b>Internet</b> - Free WiFi <br /> <b>Entertainment</b> - Flat-screen TV with cable channels<br /><b>Food & Drink</b> - Refrigerator, coffee/tea maker, room service, and free bottled water<br /><b>Sleep</b> - Premium bedding <br /><b>Bathroom</b> - Private bathroom, shower, bathrobes, and free toiletries<br /><b>Practical</b> - Safe and desk; cribs/infant beds available on request<br /><b>Comfort</b> - Climate-controlled air conditioning and daily housekeeping<br />Non-Smoking<br />\"},\"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\":\"<strong>Breakfast for 2</strong> - Rate includes the following:\\r\\n<ul><li>Accommodations as selected</li>\\r\\n<li>Breakfast in hotel restaurant for up to 2 adults and children 12 years old and under registered in the same room</li>\\r\\n</ul><em>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.</em>\\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: <ul><li>Fitness facilities</li></ul>\",\"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. <br /><br /> Distances are displayed to the nearest 0.1 mile and kilometer. <p>Sogo Department Store - 0.7 km / 0.4 mi <br />National Museum of Natural Science - 1.1 km / 0.7 mi <br />Shr-Hwa International Tower - 1.4 km / 0.8 mi <br />Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi <br />Taichung Metropolitan Opera House - 1.7 km / 1 mi <br />Tiger City Mall - 1.8 km / 1.1 mi <br />Maple Garden Park - 1.9 km / 1.2 mi <br />National Museum of Fine Arts - 2.1 km / 1.3 mi <br />Feng Chia University - 2.4 km / 1.5 mi <br />Bao An Temple - 2.5 km / 1.6 mi <br />Fengjia Night Market - 2.5 km / 1.6 mi <br />Zhonghua Night Market - 2.7 km / 1.7 mi <br />Chonglun Park - 2.9 km / 1.8 mi <br />Wan He Temple - 2.9 km / 1.8 mi <br />Chungyo Department Store - 3.1 km / 1.9 mi <br /></p><p>The nearest airports are:<br />Taichung (RMQ) - 12 km / 7.5 mi<br />Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi<br />Taipei (TSA-Songshan) - 135.5 km / 84.2 mi<br /></p><p></p>\",\"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\":\"<p>This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). </p><p><strong>Activities and facilities/equipment</strong><br />Land activities<ul><li>Fitness facilities</li></ul><br />Lessons/classes/games <ul><li>Pilates</li><li>Yoga</li></ul></p><p><strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li><li>Onsite live performances</li></ul></p>\"},\"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\"} `` @param language 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/ Language Options: https://developers.expediagroup.com/docs/rapid/resources/reference/language-options @param supplySource 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. @param customerSessionId 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. (optional) @param billingTerms 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. (optional) @param paymentTerms 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. (optional) @param partnerPointOfSale 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. (optional) @param platformName 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. (optional) @throws ExpediaGroupApiErrorException @return a Response object with a body of type Link
Property Content 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.
Property Guest Reviews 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 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.
Property Guest Reviews 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 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.
Region Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object.
Regions Returns the geographic definition and property mappings of regions matching the specified parameters.
To request all regions in the world, omit the ancestor query parameter. To request all regions in a specific continent, country or other level, specify the ID of that region as the ancestor. Refer to the list of top level regions.
The response is a paginated list of regions. See the Link header in the 200 response section.
Regions Returns the geographic definition and property mappings of regions matching the specified parameters.
To request all regions in the world, omit the ancestor query parameter. To request all regions in a specific continent, country or other level, specify the ID of that region as the ancestor. Refer to the list of top level regions.
The response is a paginated list of regions. See the Link header in the 200 response section.
Region Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object.
Search for and retrieve Bookings with Affiliate Reference Id This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to find an itinerary that was successfully created, please wait a few minutes before trying to search for the itinerary again.
Retrieve Booking This API call returns itinerary details and links to resume or cancel the booking. There are two methods to retrieve a booking: * Using the link included in the original Book response, example: https://api.ean.com/v3/itineraries/8955599932111?token=QldfCGlcUA4GXVlSAQ4W * Using the email of the booking. If the email contains special characters, they must be encoded to successfully retrieve the booking. Example: https://api.ean.com/v3/itineraries/8955599932111?email=customer@email.com Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive an error when trying to retrieve an itinerary that was successfully created, please wait a few minutes before trying to retrieve the itinerary again.
Retrieve Booking This API call returns itinerary details and links to resume or cancel the booking. There are two methods to retrieve a booking: * Using the link included in the original Book response, example: https://api.ean.com/v3/itineraries/8955599932111?token=QldfCGlcUA4GXVlSAQ4W * Using the email of the booking. If the email contains special characters, they must be encoded to successfully retrieve the booking. Example: https://api.ean.com/v3/itineraries/8955599932111?email=customer@email.com Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive an error when trying to retrieve an itinerary that was successfully created, please wait a few minutes before trying to retrieve the itinerary again.
Search for and retrieve Bookings with Affiliate Reference Id This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to find an itinerary that was successfully created, please wait a few minutes before trying to search for the itinerary again.
Properties within Polygon Returns the properties within an custom polygon that represents a multi-city area or smaller. The coordinates of the polygon should be in GeoJSON format and the polygon must conform to the following restrictions: * Polygon size - diagonal distance of the polygon must be less than 500km * Polygon type - only single polygons are supported * Number of coordinates - must be <= 2000
Properties within Polygon Returns the properties within an custom polygon that represents a multi-city area or smaller. The coordinates of the polygon should be in GeoJSON format and the polygon must conform to the following restrictions: * Polygon size - diagonal distance of the polygon must be less than 500km * Polygon type - only single polygons are supported * Number of coordinates - must be <= 2000
Create Booking This link will be available in the Price Check response or in the register payments response when Two-Factor Authentication is used. It returns an itinerary id and links to retrieve reservation details, cancel a held booking, resume a held booking or complete payment session. Please note that depending on the state of the booking, the response will contain only the applicable link(s).
Create Booking This link will be available in the Price Check response or in the register payments response when Two-Factor Authentication is used. It returns an itinerary id and links to retrieve reservation details, cancel a held booking, resume a held booking or complete payment session. Please note that depending on the state of the booking, the response will contain only the applicable link(s).
Register Payments This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the Price Check response if payment registration is required. It returns a payment session ID and a link to create a booking. This will be the first step in the booking flow only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. Learn more with our PSD2 Overview
Register Payments This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the Price Check response if payment registration is required. It returns a payment session ID and a link to create a booking. This will be the first step in the booking flow only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. Learn more with our PSD2 Overview
Price-Check Confirms the price returned by the Property Availability response. Use this API to verify a previously-selected rate is still valid before booking. If the price is matched, the response returns a link to request a booking. If the price has changed, the response returns new price details and a booking link for the new price. If the rate is no longer available, the response will return a new Property Availability request link to search again for different rates. In the event of a price change, go back to Property Availability and book the property at the new price or return to additional rates for the property.
Price-Check Confirms the price returned by the Property Availability response. Use this API to verify a previously-selected rate is still valid before booking. If the price is matched, the response returns a link to request a booking. If the price has changed, the response returns new price details and a booking link for the new price. If the rate is no longer available, the response will return a new Property Availability request link to search again for different rates. In the event of a price change, go back to Property Availability and book the property at the new price or return to additional rates for the property.
Complete Payment Session This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the booking response only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. It should be called after Two-Factor Authentication has been completed by the customer in order to finalize the payment and complete the booking or hold attempt. Learn more with our PSD2 Overview
Complete Payment Session This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the booking response only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. It should be called after Two-Factor Authentication has been completed by the customer in order to finalize the payment and complete the booking or hold attempt. Learn more with our PSD2 Overview
Resume Booking This link will be available in the booking response after creating a held booking.
Resume Booking This link will be available in the booking response after creating a held booking.
Request Test Notification This request triggers a test notification according to the specified event_type. All event types supported by the Notifications API are available to test.
Request Test Notification This request triggers a test notification according to the specified event_type. All event types supported by the Notifications API are available to test.
Request Undelivered Notifications Use this API to fetch undelivered notifications. Up to 25 notifications are returned with each call. Each undelivered notification will be returned only once.
Request Undelivered Notifications Use this API to fetch undelivered notifications. Up to 25 notifications are returned with each call. Each undelivered notification will be returned only once.
Properties within Polygon Returns the properties within an custom polygon that represents a multi-city area or smaller. The coordinates of the polygon should be in GeoJSON format and the polygon must conform to the following restrictions: * Polygon size - diagonal distance of the polygon must be less than 500km * Polygon type - only single polygons are supported * Number of coordinates - must be <= 2000
a Response object with a body of type kotlin.collections.Map
Options for which content to return in the response. The value must be lower case. * property_ids - Include the property IDs.
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Options for which supply source you would like returned in the geography 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)
Properties within Polygon Returns the properties within an custom polygon that represents a multi-city area or smaller. The coordinates of the polygon should be in GeoJSON format and the polygon must conform to the following restrictions: * Polygon size - diagonal distance of the polygon must be less than 500km * Polygon type - only single polygons are supported * Number of coordinates - must be <= 2000
kotlin.collections.Map
Options for which content to return in the response. The value must be lower case. * property_ids - Include the property IDs.
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. (optional)
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Options for which supply source you would like returned in the geography 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. * expedia - Standard Expedia supply. * vrbo - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See Vacation Rentals for more information. (optional)
Create Booking This link will be available in the Price Check response or in the register payments response when Two-Factor Authentication is used. It returns an itinerary id and links to retrieve reservation details, cancel a held booking, resume a held booking or complete payment session. Please note that depending on the state of the booking, the response will contain only the applicable link(s).
a Response object with a body of type ItineraryCreation
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The book call has a test header that can be used to return set responses with the following keywords:
* standard * complete_payment_session * service_unavailable * internal_server_error * price_mismatch * cc_declined * rooms_unavailable (optional)
Create Booking This link will be available in the Price Check response or in the register payments response when Two-Factor Authentication is used. It returns an itinerary id and links to retrieve reservation details, cancel a held booking, resume a held booking or complete payment session. Please note that depending on the state of the booking, the response will contain only the applicable link(s).
ItineraryCreation
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The book call has a test header that can be used to return set responses with the following keywords:
* standard * complete_payment_session * service_unavailable * internal_server_error * price_mismatch * cc_declined * rooms_unavailable (optional)
Register Payments This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the Price Check response if payment registration is required. It returns a payment session ID and a link to create a booking. This will be the first step in the booking flow only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. Learn more with our PSD2 Overview
a Response object with a body of type PaymentSessions
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The book call has a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * internal_server_error (optional)
Register Payments This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the Price Check response if payment registration is required. It returns a payment session ID and a link to create a booking. This will be the first step in the booking flow only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. Learn more with our PSD2 Overview
PaymentSessions
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The book call has a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * internal_server_error (optional)
Price-Check Confirms the price returned by the Property Availability response. Use this API to verify a previously-selected rate is still valid before booking. If the price is matched, the response returns a link to request a booking. If the price has changed, the response returns new price details and a booking link for the new price. If the rate is no longer available, the response will return a new Property Availability request link to search again for different rates. In the event of a price change, go back to Property Availability and book the property at the new price or return to additional rates for the property.
a Response object with a body of type RoomPriceCheck
Expedia Property ID.
Room ID of a property.
Rate ID of a room.
A hashed collection of query parameters. Used to maintain state across calls. This token is provided as part of the price check link from the shop response.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Price check calls have a test header that can be used to return set responses with the following keywords: * available * price_changed * sold_out * service_unavailable * unknown_internal_error (optional)
Price-Check Confirms the price returned by the Property Availability response. Use this API to verify a previously-selected rate is still valid before booking. If the price is matched, the response returns a link to request a booking. If the price has changed, the response returns new price details and a booking link for the new price. If the rate is no longer available, the response will return a new Property Availability request link to search again for different rates. In the event of a price change, go back to Property Availability and book the property at the new price or return to additional rates for the property.
RoomPriceCheck
Expedia Property ID.
Room ID of a property.
Rate ID of a room.
A hashed collection of query parameters. Used to maintain state across calls. This token is provided as part of the price check link from the shop response.
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics. (optional)
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. (optional)
Price check calls have a test header that can be used to return set responses with the following keywords: * available * price_changed * sold_out * service_unavailable * unknown_internal_error (optional)
Complete Payment Session This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the booking response only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. It should be called after Two-Factor Authentication has been completed by the customer in order to finalize the payment and complete the booking or hold attempt. Learn more with our PSD2 Overview
a Response object with a body of type CompletePaymentSession
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The payment-sessions call has a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * internal_server_error (optional)
Complete Payment Session This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
This link will be available in the booking response only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. It should be called after Two-Factor Authentication has been completed by the customer in order to finalize the payment and complete the booking or hold attempt. Learn more with our PSD2 Overview
CompletePaymentSession
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The payment-sessions call has a test header that can be used to return set responses with the following keywords:
* standard * service_unavailable * internal_server_error (optional)
Resume Booking This link will be available in the booking response after creating a held booking.
a Response object with a body of type Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The resume call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test held booking. * service_unavailable - Returns the HTTP 202 response caused by partial service unavailablity. * internal_server_error (optional)
Resume Booking This link will be available in the booking response after creating a held booking.
Nothing
IP address of the customer, as captured by your integration.
Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
Also used for fraud recovery and other important analytics.
This parameter is used only to prefix the token value - no ID value is used.
Provided as part of the link object and used to maintain state across calls. This simplifies each subsequent call by limiting the amount of information required at each step and reduces the potential for errors. Token values cannot be viewed or changed.
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. (optional)
The resume call has a test header that can be used to return set responses with the following keywords:
* standard - Requires valid test held booking. * service_unavailable - Returns the HTTP 202 response caused by partial service unavailablity. * internal_server_error (optional)
Request Test Notification This request triggers a test notification according to the specified event_type. All event types supported by the Notifications API are available to test.
a Response object with a body of type Nothing
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Request Test Notification This request triggers a test notification according to the specified event_type. All event types supported by the Notifications API are available to test.
Nothing
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Request Undelivered Notifications Use this API to fetch undelivered notifications. Up to 25 notifications are returned with each call. Each undelivered notification will be returned only once.
a Response object with a body of type kotlin.collections.List
Undeliverable notifications are returned when this parameter is set to true.
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. (optional)
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. (optional)
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. (optional)
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. (optional)
Request Undelivered Notifications Use this API to fetch undelivered notifications. Up to 25 notifications are returned with each call. Each undelivered notification will be returned only once.
kotlin.collections.List
Undeliverable notifications are returned when this parameter is set to true.
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. (optional)
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. (optional)
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. (optional)
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. (optional)
A list of the constraint violations that occurred
An exception to be thrown when a constraint on some property has been violated.
The constraint violation message
An entity to represent a constraint violation of a property.
An entity to represent a constraint violation of a property.
An exception to be thrown when a constraint on some property has been violated.
Address line 1.
Address line 2.
City.
2-letter or 3-letter state/province code for Australia, Canada and the USA.
Text name of the State/Province - more common for additional countries.
Postal/zip code.
2-letter country code, in ISO 3166-1 alpha-2 format.
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.
2-letter country code, in ISO 3166-1 alpha-2 format.
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.
2-letter or 3-letter state/province code for Australia, Canada and the USA.
Text name of the State/Province - more common for additional countries.
Container for the property's address information.
Address line 1.
Address line 2.
City.
2-letter or 3-letter state/province code for Australia, Canada and the USA.
Text name of the State/Province - more common for additional countries.
Postal/zip code.
2-letter country code, in ISO 3166-1 alpha-2 format.
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.
First line of street address.
Second line of street address.
Third line of street address.
City where address is located.
State or province code of address, if applicable.
Postal code of address, if applicable.
Country code, in two-letter ISO 3166-1 alpha-2 format.
Country code, in two-letter ISO 3166-1 alpha-2 format.
State or province code of address, if applicable.
First line of street address.
Second line of street address.
Third line of street address.
City where address is located.
State or province code of address, if applicable.
Postal code of address, if applicable.
Country code, in two-letter ISO 3166-1 alpha-2 format.
value The amount of the adjustment.
The type of the adjustment.
The currency of the adjustment.
Any price adjustments associated with this itinerary.
value The amount of the adjustment.
The type of the adjustment.
The currency of the adjustment.
Indicates if all rate plans at the property provide all-inclusive amenities.
Indicates if some, but not all, rate plans at the property provide all-inclusive amenities.
Details about amenities and services included in the all-inclusive rates.
Indicates if all rate plans at the property provide all-inclusive amenities.
Details about amenities and services included in the all-inclusive rates.
Indicates if some, but not all, rate plans at the property provide all-inclusive amenities.
Information about the all-inclusive rate plans available at the property.
Indicates if all rate plans at the property provide all-inclusive amenities.
Indicates if some, but not all, rate plans at the property provide all-inclusive amenities.
Details about amenities and services included in the all-inclusive rates.
The amenity definition ID for this amenity.
Amenity name.
value Amenity value.
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 for a list of values.
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 for a list of values.
An individual amenity.
The amenity definition ID for this amenity.
Amenity name.
value Amenity value.
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 for a list of values.
The monetary amount.
value The value of the amount object. Decimal point inline with correct precision.
Currency of the amount object.
A region ancestor.
Id of ancestor region.
Region type of ancestor region.
The room's area, measured in square meters.
The room's area, measured in square feet.
The room's area, measured in square feet.
The room's area, measured in square meters.
Information about the area of the room.
The room's area, measured in square meters.
The room's area, measured in square feet.
Lists all of the general attributes about the property.
Lists all of the pet attributes about the property.
Lists all of the general attributes about the property.
Attributes about the property. See our attributes reference for current known attribute ID and name values.
Lists all of the general attributes about the property.
Lists all of the pet attributes about the property.
A map of links, including links to confirm pricing and availability for the selected rate.
Unique identifier for a bed group.
This is a display ready description of a bed configuration for this room.
The bed configuration for a given room. This array can be empty for the related bed group.
The bed configuration for a given room. This array can be empty for the related bed group.
This is a display ready description of a bed configuration for this room.
Unique identifier for a bed group.
This is a display ready description of a bed configuration for this room.
The bed configuration for a given room. This array can be empty for the related bed group.
The type of this bed configuration in the room.
The size of this bed configuration in the room.
The number of this bed configuration in the room.
The size of this bed configuration in the room.
The number of this bed configuration in the room.
An individual bed configuration.
The type of this bed configuration in the room.
The size of this bed configuration in the room.
The number of this bed configuration in the room.
An array of bed configurations for this room.
This is a display ready description of a bed configuration for this room.
An individual bed group.
Unique identifier for a bed group.
This is a display ready description of a bed configuration for this room.
An array of bed configurations for this room.
Customer's country code, in two-letter ISO 3166-1 alpha-2 format. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
First line of customer's street address. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Second line of customer's street address. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Third line of customer's street address. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's city. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's state or province code. Mandatory for AU, CA and US. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's postal code. Mandatory for CA, GB, and US. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's country code, in two-letter ISO 3166-1 alpha-2 format. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's postal code. Mandatory for CA, GB, and US. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's state or province code. Mandatory for AU, CA and US. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's country code, in two-letter ISO 3166-1 alpha-2 format. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
First line of customer's street address. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Second line of customer's street address. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Third line of customer's street address. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's city. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's state or province code. Mandatory for AU, CA and US. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
Customer's postal code. Mandatory for CA, GB, and US. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded. Only ISO-8859-1 compliant characters are allowed.
First/given name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last/family name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last/family name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First/given name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First/given name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last/family name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First/given name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last/family name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last/family name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First/given name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First/given name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last/family name of the payment type account holder. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First/given name of the payment type account holder.
Last/family name of the payment type account holder.
Last/family name of the payment type account holder.
First/given name of the payment type account holder.
First/given name of the payment type account holder.
Last/family name of the payment type account holder.
Type of bounding polygon.
Whether or not a payment for this property can be taken by Expedia at the time of booking.
Whether or not a payment for this property can be taken by the property upon arrival.
Whether or not a payment for this property can be taken by Expedia at the time of booking.
Whether or not a payment for this property can be taken by the property upon arrival.
How and when the payment can be taken.
Whether or not a payment for this property can be taken by Expedia at the time of booking.
Whether or not a payment for this property can be taken by the property upon arrival.
Currency of the amount object.
Effective date and time of cancellation penalty in extended ISO 8601 format, with ±hh:mm timezone offset
End date and time of cancellation penalty in extended ISO 8601 format, with ±hh:mm timezone offset
The monetary amount of the penalty.
Number of nights charged for as penalty.
Percentage of total booking charged for as penalty. A thirty percent penalty would be returned as 30%
Percentage of total booking charged for as penalty. A thirty percent penalty would be returned as 30%
Currency of the amount object.
Effective date and time of cancellation penalty in extended ISO 8601 format, with ±hh:mm timezone offset
End date and time of cancellation penalty in extended ISO 8601 format, with ±hh:mm timezone offset
The monetary amount of the penalty.
Number of nights charged for as penalty.
Percentage of total booking charged for as penalty. A thirty percent penalty would be returned as 30%
The amount of the refund on cancelling the itinerary.
The currency of the refund amount.
The refund information for cancelling the itinerary.
The amount of the refund on cancelling the itinerary.
The currency of the refund amount.
Brand name for the accepted credit or debit card. Use this value to determine which cards to display on your checkout page.
The country in which the payment will be processed.
The country in which the payment will be processed.
Brand name for the accepted credit or debit card. Use this value to determine which cards to display on your checkout page.
The country in which the payment will be processed.
Age category name.
Age category minimum age.
An age category.
Age category name.
Age category minimum age.
The ID of the property's category.
The property's category.
The property's category. See our property categories reference for current known category ID and name values.
The ID of the property's category.
The property's category.
The general category that this value add promotion falls into. Values: FOOD_AND_BEVERAGE,ENTERTAINMENT,SERVICE,ACTIVITY,CREDIT
The general category that this value add promotion falls into. Values: FOOD_AND_BEVERAGE,ENTERTAINMENT,SERVICE,ACTIVITY,CREDIT
The general category that this value add promotion falls into. Values: FOOD_AND_BEVERAGE,ENTERTAINMENT,SERVICE,ACTIVITY,CREDIT
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
First name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Specify if the guest would prefer a smoking room. This field is only a request and the property is not guaranteed to honor it, it will not override any non-smoking policies by the hotel.
Special requests to send to hotel (not guaranteed). Do not use this field to communicate B2B customer service requests or pass any sensitive personal or financial information (PII). Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A loyalty identifier for a hotel loyalty program associated with this room guest.
Last name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A loyalty identifier for a hotel loyalty program associated with this room guest.
Specify if the guest would prefer a smoking room. This field is only a request and the property is not guaranteed to honor it, it will not override any non-smoking policies by the hotel.
Special requests to send to hotel (not guaranteed). Do not use this field to communicate B2B customer service requests or pass any sensitive personal or financial information (PII). Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Specify if the guest would prefer a smoking room. This field is only a request and the property is not guaranteed to honor it, it will not override any non-smoking policies by the hotel.
Special requests to send to hotel (not guaranteed). Do not use this field to communicate B2B customer service requests or pass any sensitive personal or financial information (PII). Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A loyalty identifier for a hotel loyalty program associated with this room guest.
An object representing a charge. Information about the charge is provided in both the billable currency and the request currency.
An object representing a charge. Information about the charge is provided in both the billable currency and the request currency.
24hour Present if the property has 24-hour check-in.
The time at which a property begins to allow check-ins.
The time at which a property stops allowing check-ins.
The property's check-in policy.
Any special instructions for checking into this property that may be specific to this property.
The minimum age for a customer to be able to check-in at a property.
The time at which a property begins to allow check-ins.
The time at which a property stops allowing check-ins.
The minimum age for a customer to be able to check-in at a property.
Any special instructions for checking into this property that may be specific to this property.
The property's check-in information.
24hour Present if the property has 24-hour check-in.
The time at which a property begins to allow check-ins.
The time at which a property stops allowing check-ins.
The property's check-in policy.
Any special instructions for checking into this property that may be specific to this property.
The minimum age for a customer to be able to check-in at a property.
The property's check-out information.
The time by which a guest must check out.
Your optional identifier for the change being executed. Only unique per itinerary. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Your optional identifier for the change being executed. Only unique per itinerary. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Your optional identifier for the change being executed. Only unique per itinerary. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A map of links, including links to retrieve a booking, resume a held booking, or cancel a held booking.
The itinerary id.
The payment session response.
The itinerary id.
The expedia confirmation id.
property The property confirmation id.
The confirmation ids.
The expedia confirmation id.
property The property confirmation id.
Contains urls for links to initiate conversations via EPS.
Center Longitude.
Center Latitude.
Center Longitude.
Center Latitude.
The latitude of the property.
The longitude of the property.
The coordinates of the property.
The latitude of the property.
The longitude of the property.
First name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Specify if the guest would prefer a smoking room. This field is only a request and the property is not guaranteed to honor it, it will not override any non-smoking policies by the hotel.
Special requests to send to hotel (not guaranteed). Do not use this field to communicate B2B customer service requests or pass any sensitive personal or financial information (PII). Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A loyalty identifier for a hotel loyalty program associated with this room guest.
Last name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A loyalty identifier for a hotel loyalty program associated with this room guest.
Specify if the guest would prefer a smoking room. This field is only a request and the property is not guaranteed to honor it, it will not override any non-smoking policies by the hotel.
Special requests to send to hotel (not guaranteed). Do not use this field to communicate B2B customer service requests or pass any sensitive personal or financial information (PII). Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
First name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Last name of room guest. Max 60 characters. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Specify if the guest would prefer a smoking room. This field is only a request and the property is not guaranteed to honor it, it will not override any non-smoking policies by the hotel.
Special requests to send to hotel (not guaranteed). Do not use this field to communicate B2B customer service requests or pass any sensitive personal or financial information (PII). Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
A loyalty identifier for a hotel loyalty program associated with this room guest.
Email address for the customer. Must adhere to standard RFC 822 email format. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Your unique reference value. This field supports from 3 to a maximum of 28 characters and is required to be unique (if provided). Entering special characters (\"<\", \">\", \"(\", \")\", and \"&\") in this field will result in the request being rejected.
Flag for placing a booking on hold. The booking will be released if the resume link is not followed within the hold period. Please refer to our Hold and Resume documentation.
Required if payment information prior to booking was not submitted. If register payments was called prior to this call, do not submit payment information again.
Field that stores up to 256 characters of additional metadata with the itinerary. Will be returned on all retrieve responses for this itinerary. The data must be in the format 'key1:value|key2:value|key3:value'. Other Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The customer's taxpayer identification number that is provided by the government to nationals or resident aliens. This number should be collected from individuals that pay taxes or participate in activities that provide revenue for one or more tax types. Note: This value is only needed from Brazilian and Indian customers.
Custom traveler handling instructions for the hotel. Do not include PCI sensitive data, such as credit card numbers, in this field.
Field that stores up to 256 characters of additional metadata with the itinerary. Will be returned on all retrieve responses for this itinerary. The data must be in the format 'key1:value|key2:value|key3:value'. Other Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Your unique reference value. This field supports from 3 to a maximum of 28 characters and is required to be unique (if provided). Entering special characters (\"<\", \">\", \"(\", \")\", and \"&\") in this field will result in the request being rejected.
Required if payment information prior to booking was not submitted. If register payments was called prior to this call, do not submit payment information again.
The customer's taxpayer identification number that is provided by the government to nationals or resident aliens. This number should be collected from individuals that pay taxes or participate in activities that provide revenue for one or more tax types. Note: This value is only needed from Brazilian and Indian customers.
Custom traveler handling instructions for the hotel. Do not include PCI sensitive data, such as credit card numbers, in this field.
Email address for the customer. Must adhere to standard RFC 822 email format. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
Your unique reference value. This field supports from 3 to a maximum of 28 characters and is required to be unique (if provided). Entering special characters (\"<\", \">\", \"(\", \")\", and \"&\") in this field will result in the request being rejected.
Flag for placing a booking on hold. The booking will be released if the resume link is not followed within the hold period. Please refer to our Hold and Resume documentation.
Required if payment information prior to booking was not submitted. If register payments was called prior to this call, do not submit payment information again.
Field that stores up to 256 characters of additional metadata with the itinerary. Will be returned on all retrieve responses for this itinerary. The data must be in the format 'key1:value|key2:value|key3:value'. Other Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The customer's taxpayer identification number that is provided by the government to nationals or resident aliens. This number should be collected from individuals that pay taxes or participate in activities that provide revenue for one or more tax types. Note: This value is only needed from Brazilian and Indian customers.
Custom traveler handling instructions for the hotel. Do not include PCI sensitive data, such as credit card numbers, in this field.
Name of the merchant to use during 3rd party authorization for PSD2.
Display name of payment option.
The UTC date the property’s content was updated by EPS, in ISO 8601 format.
Dates about the property.
The UTC date the property’s content was added to EPS, in ISO 8601 format
The UTC date the property’s content was updated by EPS, in ISO 8601 format.
Date associated to the provided information.
True if the property is available on the date.
Enumeration indicating the capability of check-in on the date. CHECKIN_VALID: The associated date is valid for check in. CHECKIN_INVALID: Generic or Unknown reason for being not being a valid day for check in. CHECKIN_INVALID_DUE_TO_BEING_IN_PAST: The associated date is not valid for check in due to being in the past. CHECKIN_INVALID_DUE_TO_MIN_PRIOR_NOTIFICATION: The associated date is not valid for check in because checking in on this date would not meet the owner's minimum prior notification requirements. CHECKIN_INVALID_DUE_TO_MAX_FUTURE_BOOKING: The associated date is not valid for check in because it is too far in the future. CHECKIN_INVALID_DUE_TO_NOT_AVAILABLE: The associated date is not valid for check in because it is not available (ie. the date is already reserved). CHECKIN_INVALID_DUE_TO_NON_CHANGEOVER_DAY_OF_WEEK: The associated date is not valid for check in because it falls on a day of the week that check in is prohibited. CHECKIN_INVALID_DUE_TO_CHANGEOVER_EXCLUSION: The associated date is not valid for check in because check in was prohibited on that specific date. CHECKIN_INVALID_DUE_TO_MIN_STAY_NOT_ACHIEVABLE: The associated date is not valid for check in because checking in on this date does not satisfy the minimum stay duration. CHECKIN_INVALID_DUE_TO_NO_VALID_CHECKOUT_WITHIN_CONSTRAINTS: The associated date is not valid for check in because there is not an associated check out date that would allow the stay to satisfy stay constraints.
Enumeration indicating the capability of check-out on the date. CHECKOUT_VALID: The associated date is valid for check out. CHECKOUT_INVALID: The checkout validity value is invalid or unknown. CHECKOUT_INVALID_DUE_TO_NON_CHANGEOVER_DAY_OF_WEEK: The associated date is not valid for check out because it falls on a day of the week that check out is prohibited. CHECKOUT_INVALID_DUE_TO_CHANGEOVER_EXCLUSION: The associated date is not valid for check out because check out was prohibited on that specific date.
True if the property is available on the date.
Enumeration indicating the capability of check-in on the date. CHECKIN_VALID: The associated date is valid for check in. CHECKIN_INVALID: Generic or Unknown reason for being not being a valid day for check in. CHECKIN_INVALID_DUE_TO_BEING_IN_PAST: The associated date is not valid for check in due to being in the past. CHECKIN_INVALID_DUE_TO_MIN_PRIOR_NOTIFICATION: The associated date is not valid for check in because checking in on this date would not meet the owner's minimum prior notification requirements. CHECKIN_INVALID_DUE_TO_MAX_FUTURE_BOOKING: The associated date is not valid for check in because it is too far in the future. CHECKIN_INVALID_DUE_TO_NOT_AVAILABLE: The associated date is not valid for check in because it is not available (ie. the date is already reserved). CHECKIN_INVALID_DUE_TO_NON_CHANGEOVER_DAY_OF_WEEK: The associated date is not valid for check in because it falls on a day of the week that check in is prohibited. CHECKIN_INVALID_DUE_TO_CHANGEOVER_EXCLUSION: The associated date is not valid for check in because check in was prohibited on that specific date. CHECKIN_INVALID_DUE_TO_MIN_STAY_NOT_ACHIEVABLE: The associated date is not valid for check in because checking in on this date does not satisfy the minimum stay duration. CHECKIN_INVALID_DUE_TO_NO_VALID_CHECKOUT_WITHIN_CONSTRAINTS: The associated date is not valid for check in because there is not an associated check out date that would allow the stay to satisfy stay constraints.
Enumeration indicating the capability of check-out on the date. CHECKOUT_VALID: The associated date is valid for check out. CHECKOUT_INVALID: The checkout validity value is invalid or unknown. CHECKOUT_INVALID_DUE_TO_NON_CHANGEOVER_DAY_OF_WEEK: The associated date is not valid for check out because it falls on a day of the week that check out is prohibited. CHECKOUT_INVALID_DUE_TO_CHANGEOVER_EXCLUSION: The associated date is not valid for check out because check out was prohibited on that specific date.
Date associated to the provided information.
True if the property is available on the date.
Enumeration indicating the capability of check-in on the date. CHECKIN_VALID: The associated date is valid for check in. CHECKIN_INVALID: Generic or Unknown reason for being not being a valid day for check in. CHECKIN_INVALID_DUE_TO_BEING_IN_PAST: The associated date is not valid for check in due to being in the past. CHECKIN_INVALID_DUE_TO_MIN_PRIOR_NOTIFICATION: The associated date is not valid for check in because checking in on this date would not meet the owner's minimum prior notification requirements. CHECKIN_INVALID_DUE_TO_MAX_FUTURE_BOOKING: The associated date is not valid for check in because it is too far in the future. CHECKIN_INVALID_DUE_TO_NOT_AVAILABLE: The associated date is not valid for check in because it is not available (ie. the date is already reserved). CHECKIN_INVALID_DUE_TO_NON_CHANGEOVER_DAY_OF_WEEK: The associated date is not valid for check in because it falls on a day of the week that check in is prohibited. CHECKIN_INVALID_DUE_TO_CHANGEOVER_EXCLUSION: The associated date is not valid for check in because check in was prohibited on that specific date. CHECKIN_INVALID_DUE_TO_MIN_STAY_NOT_ACHIEVABLE: The associated date is not valid for check in because checking in on this date does not satisfy the minimum stay duration. CHECKIN_INVALID_DUE_TO_NO_VALID_CHECKOUT_WITHIN_CONSTRAINTS: The associated date is not valid for check in because there is not an associated check out date that would allow the stay to satisfy stay constraints.
Enumeration indicating the capability of check-out on the date. CHECKOUT_VALID: The associated date is valid for check out. CHECKOUT_INVALID: The checkout validity value is invalid or unknown. CHECKOUT_INVALID_DUE_TO_NON_CHANGEOVER_DAY_OF_WEEK: The associated date is not valid for check out because it falls on a day of the week that check out is prohibited. CHECKOUT_INVALID_DUE_TO_CHANGEOVER_EXCLUSION: The associated date is not valid for check out because check out was prohibited on that specific date.
The deal that applies to this rate.
Unique identifier for the deal.
The description for the deal.
The currency of the deposit.
value The amount required as deposit.
The due date/time of the deposit.
The deposit policy associated with the itinerary.
The currency of the deposit.
value The amount required as deposit.
The due date/time of the deposit.
A deposit policy associated with the rate.
value The amount that must be paid as a deposit.
The due date in ISO 8601 format.
The currency for the deposit amount.
Provides an overview of a room.
Descriptions of a room.
Provides an overview of a room.
Describes general building amenities at the property.
Describes dining accommodations at the property.
Describes any recent room or property renovations.
States the source of the property's star rating (such as a regional or national tourism agency) and any other ratings claimed.
Describes any business-specific amenities at the property, e.g. conference rooms.
Describes typical room amenities.
Nearby attractions/areas, often including distances from the property.
General location as entered by the property.
A headline description for the property.
A general description of a vacation rental property.
Describes general building amenities at the property.
Nearby attractions/areas, often including distances from the property.
Describes any business-specific amenities at the property, e.g. conference rooms.
A general description of a vacation rental property.
States the source of the property's star rating (such as a regional or national tourism agency) and any other ratings claimed.
Describes any recent room or property renovations.
Descriptions of a property.
Describes general building amenities at the property.
Describes dining accommodations at the property.
Describes any recent room or property renovations.
States the source of the property's star rating (such as a regional or national tourism agency) and any other ratings claimed.
Describes any business-specific amenities at the property, e.g. conference rooms.
Describes typical room amenities.
Nearby attractions/areas, often including distances from the property.
General location as entered by the property.
A headline description for the property.
A general description of a vacation rental property.
Describes the house rule.
List of strings detailing further information about the rule.
List of strings detailing further information about the rule.
Describes the house rule.
List of strings detailing further information about the rule.
The error type.
A human readable message giving details about this error.
Details about the specific fields that had an error.
A human readable message giving details about this error.
An individual error.
The error type.
A human readable message giving details about this error.
Details about the specific fields that had an error.
The error type.
A human readable message giving details about this error.
Details about the specific fields that had an error.
An array of all the actual errors that occured.
An array of all the actual errors that occured.
A human readable message giving details about this error.
The overall class of error that occured.
The error type.
A human readable message giving details about this error.
Details about the specific fields that had an error.
An array of all the actual errors that occured.
The date and time when new essential information is available for retrieval, in extended ISO 8601 format, with ±hh:mm timezone offset.
The date and time when new essential information is available for retrieval, in extended ISO 8601 format, with ±hh:mm timezone offset.
Essential information, including the supply contact information and any other essential information.
The date and time when new essential information is available for retrieval, in extended ISO 8601 format, with ±hh:mm timezone offset.
The name of the essential item.
The instructions for use of the essential item.
A map of additional information that needs to be conveyed to customer.
An array of images needed for the essential item.
A map of additional information that needs to be conveyed to customer.
The instructions for use of the essential item.
The name of the essential item.
The instructions for use of the essential item.
A map of additional information that needs to be conveyed to customer.
An array of images needed for the essential item.
The fees collected by the property. The values for each type of fee are the total for that type. Mandatory fees are collected by the property at check-in or check-out. Resort fees are charged for amenities and extras and collected by the property at check-in or check-out. Mandatory taxes are taxes collected by the property at check-in or check-out.
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.
Describes additional optional fees for items such as breakfast, wifi, parking, pets etc.
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.
Describes additional optional fees for items such as breakfast, wifi, parking, pets etc.
Information related to a property's fees.
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.
Describes additional optional fees for items such as breakfast, wifi, parking, pets etc.
An individual field that had an error.
The field that had an error.
The type of the field that had an error.
value The value of the field that had an error.
The frequency of when this applies. Values: UNKNOWN,PER_NIGHT,PER_DAY,PER_STAY,PER_WEEK,ROUND_TRIP,ONE_WAY
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
A count of all of the guest review ratings which currently exist for this property.
The overall rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The cleanliness rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The rating of the staff's service for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The comfort rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The rating for the property's condition, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
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.
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.
The quality rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
value 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.
The rating for the amenities provided by the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The percent of guests who recommend staying at this property.
The rating for the amenities provided by the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The cleanliness rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The comfort rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The rating for the property's condition, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
A count of all of the guest review ratings which currently exist for this property.
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.
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.
The overall rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The quality rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The percent of guests who recommend staying at this property.
The rating of the staff's service for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
Rating information provided by guests who stayed at this property.
A count of all of the guest review ratings which currently exist for this property.
The overall rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The cleanliness rating for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The rating of the staff's service for the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The comfort rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The rating for the property's condition, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
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.
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.
The quality rating of the rooms, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
value 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.
The rating for the amenities provided by the property, averaged from all guest reviews. Returns a value between 1.0 and 5.0.
The percent of guests who recommend staying at this property.
A collection of the guest reviews which have been verified, in order, starting with the newest.
A property's verified guest reviews.
A collection of the guest reviews which have been verified, in order, starting with the newest.
Whether this image is a hero image or not.
The category of the image.
The image caption.
Contains urls for all of the image sizes available. Sizes may include: 70 px, 200px, 350 px, and 1,000 px
An individual image. See our image categories reference for current known caption and category values.
Whether this image is a hero image or not.
The category of the image.
The image caption.
Contains urls for all of the image sizes available. Sizes may include: 70 px, 200px, 350 px, and 1,000 px
A map of links, including links to retrieve a booking, resume a held booking, cancel a held booking, or complete a payment session if a challenge is used.
The itinerary id.
The challenge config that is required to perform payment challenge. This field will be available when payment challenge is needed.
The challenge config that is required to perform payment challenge. This field will be available when payment challenge is needed.
The book response.
The itinerary id.
The challenge config that is required to perform payment challenge. This field will be available when payment challenge is needed.
Values: ADJUSTMENT,COUPON
Values: ADJUSTMENT,COUPON
Values: ADJUSTMENT,COUPON
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Itinerary history id for particular change.
Date and time in UTC of the change event, in extended ISO 8601 format.
An agent user id number associated with a modification.
An agent user id number associated with a modification.
Date and time in UTC of the change event, in extended ISO 8601 format.
An itinerary history change event, representing a charge or refund made to the itinerary and not a specific room.
Itinerary history id for particular change.
Date and time in UTC of the change event, in extended ISO 8601 format.
An agent user id number associated with a modification.
A map of links, including links to resume or cancel a held booking. This is only included for held bookings.
The itinerary id.
The property id.
Email address for the customer.
The creation date/time of the booking.
Your unique reference value. This field supports from 3 to a maximum of 28 characters.
Field that stores up to 256 characters of additional metadata with the itinerary, uniqueness is not required.
Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler.
An array of rooms each containing an array of room history events.
Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler. Values: LEISURE,BUSINESS,UNSPECIFIED
Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler. Values: LEISURE,BUSINESS,UNSPECIFIED
Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler. Values: LEISURE,BUSINESS,UNSPECIFIED
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Field that stores up to 256 characters of additional metadata with the itinerary, uniqueness is not required.
Your unique reference value. This field supports from 3 to a maximum of 28 characters.
The creation date/time of the booking.
An array of rooms each containing an array of room history events.
Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler.
The itinerary object.
The itinerary id.
The property id.
Email address for the customer.
The creation date/time of the booking.
Your unique reference value. This field supports from 3 to a maximum of 28 characters.
Field that stores up to 256 characters of additional metadata with the itinerary, uniqueness is not required.
Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler.
An array of rooms each containing an array of room history events.
If the link expires, this will be the UTC date the link will expire, in ISO 8601 format.
An individual link.
The request method used to access the link.
The URL for the link. This can be absolute or relative.
If the link expires, this will be the UTC date the link will expire, in ISO 8601 format.
Container for localized address information.
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.
When this field is true, the obfuscated_coordinates must be used to display approximate location instead of the precise location of coordinates.
When this field is true, the obfuscated_coordinates must be used to display approximate location instead of the precise location of coordinates.
The property's location information.
When this field is true, the obfuscated_coordinates must be used to display approximate location instead of the precise location of coordinates.
The source of the incentive. This can be used to differentiate between incentives in the case that more than one incentive applies to a particular rate.
The first stay date with the incentive applied in ISO 8601 format.
The last stay date with the incentive applied in ISO 8601 format.
An object representing one incentive source and the stay dates relevant to that particular incentive.
The source of the incentive. This can be used to differentiate between incentives in the case that more than one incentive applies to a particular rate.
The first stay date with the incentive applied in ISO 8601 format.
The last stay date with the incentive applied in ISO 8601 format.
Total maximum occupancy allowed.
Maximum number of children allowed.
Maximum number of adults allowed.
Maximum occupancy counts.
Total maximum occupancy allowed.
Maximum number of children allowed.
Maximum number of adults allowed.
expedia - Payment is taken by Expedia. * property - Payment is taken by the property. Values: EXPEDIA,PROPERTY
expedia - Payment is taken by Expedia. * property - Payment is taken by the property. Values: EXPEDIA,PROPERTY
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format.
An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format.
An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format.
An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format.
An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format.
An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format.
The price breakout type. * base_rate - The room rate without any taxes and fees applied. * tax_and_service_fee - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * extra_person_fee - A per night fee that is charged by a hotel for additional adults over the nightly rate. This fee is included as part of the total. * property_fee - The property fee surcharge type must be displayed beginning on the initial hotel room selection page, immediately after your hotel search results page. This placement is required by the U.S. Federal Trade Commission (FTC). Display this surcharge as \"Property Fee\" on your room selection page, as described above, and in all subsequent price breakdowns for the following Points of Sale: * US * Canada * Brazil * LATAM * sales_tax - Taxes that must be displayed by certain jurisdictional laws. Ensure that you capture these values and display as \"Taxes\". * adjustment - This is the amount that the individual night have been adjusted/discounted. * recovery_charges_and_fees - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * traveler_service_fee - Fee charged by Vrbo to support use of online tools, services and functions on its platform which enable guest self service. May be displayed as 'Traveler Service Fee' or 'Service Fee' any time fees are broken out for display on partner sites. Values: BASE_RATE,TAX_AND_SERVICE_FEE,EXTRA_PERSON_FEE,PROPERTY_FEE,SALES_TAX,ADJUSTMENT,RECOVERY_CHARGES_AND_FEES,TRAVELER_SERVICE_FEE
The price breakout type. * base_rate - The room rate without any taxes and fees applied. * tax_and_service_fee - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * extra_person_fee - A per night fee that is charged by a hotel for additional adults over the nightly rate. This fee is included as part of the total. * property_fee - The property fee surcharge type must be displayed beginning on the initial hotel room selection page, immediately after your hotel search results page. This placement is required by the U.S. Federal Trade Commission (FTC). Display this surcharge as \"Property Fee\" on your room selection page, as described above, and in all subsequent price breakdowns for the following Points of Sale: * US * Canada * Brazil * LATAM * sales_tax - Taxes that must be displayed by certain jurisdictional laws. Ensure that you capture these values and display as \"Taxes\". * adjustment - This is the amount that the individual night have been adjusted/discounted. * recovery_charges_and_fees - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * traveler_service_fee - Fee charged by Vrbo to support use of online tools, services and functions on its platform which enable guest self service. May be displayed as 'Traveler Service Fee' or 'Service Fee' any time fees are broken out for display on partner sites. Values: BASE_RATE,TAX_AND_SERVICE_FEE,EXTRA_PERSON_FEE,PROPERTY_FEE,SALES_TAX,ADJUSTMENT,RECOVERY_CHARGES_AND_FEES,TRAVELER_SERVICE_FEE
The price breakout type. * base_rate - The room rate without any taxes and fees applied. * tax_and_service_fee - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * extra_person_fee - A per night fee that is charged by a hotel for additional adults over the nightly rate. This fee is included as part of the total. * property_fee - The property fee surcharge type must be displayed beginning on the initial hotel room selection page, immediately after your hotel search results page. This placement is required by the U.S. Federal Trade Commission (FTC). Display this surcharge as \"Property Fee\" on your room selection page, as described above, and in all subsequent price breakdowns for the following Points of Sale: * US * Canada * Brazil * LATAM * sales_tax - Taxes that must be displayed by certain jurisdictional laws. Ensure that you capture these values and display as \"Taxes\". * adjustment - This is the amount that the individual night have been adjusted/discounted. * recovery_charges_and_fees - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * traveler_service_fee - Fee charged by Vrbo to support use of online tools, services and functions on its platform which enable guest self service. May be displayed as 'Traveler Service Fee' or 'Service Fee' any time fees are broken out for display on partner sites. Values: BASE_RATE,TAX_AND_SERVICE_FEE,EXTRA_PERSON_FEE,PROPERTY_FEE,SALES_TAX,ADJUSTMENT,RECOVERY_CHARGES_AND_FEES,TRAVELER_SERVICE_FEE
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
value The value of the amount object. Decimal point inline with correct precision.
Currency of the amount object.
value The value of the amount object. Decimal point inline with correct precision.
Currency of the amount object.
Start date of nonrefundable date range in ISO 8601 format.
End date of nonrefundable date range in ISO 8601 format.
Start date of nonrefundable date range in ISO 8601 format.
End date of nonrefundable date range in ISO 8601 format.
Unique identifier for each message
An indication of what event caused the notification. This value can be used for message handling and routing. Refer to the list of event types for more information.
Timestamp of the event notification, in UTC
The Itinerary ID of the affected booking
The customer e-mail address associated with the affected itinerary
Description of event notification
The Affiliate Reference ID of the affected booking
The Affiliate Reference ID of the affected booking
An indication of what event caused the notification. This value can be used for message handling and routing. Refer to the list of event types for more information.
A notification.
Unique identifier for each message
An indication of what event caused the notification. This value can be used for message handling and routing. Refer to the list of event types for more information.
Timestamp of the event notification, in UTC
The Itinerary ID of the affected booking
The customer e-mail address associated with the affected itinerary
Description of event notification
The Affiliate Reference ID of the affected booking
Map of the age categories used to determine the maximum children and adult occupancy.
Map of the age categories used to determine the maximum children and adult occupancy.
Occupancy information.
Map of the age categories used to determine the maximum children and adult occupancy.
The type of offer this value add promotion is. Values: BUY_ONE_GET_ONE_FREE,CREDIT,DISCOUNT,FREE,VOUCHER
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
The currency accepted at the property.
The types of payments accepted at the property.
The types of payments accepted at the property.
The property’s accepted forms of payments when onsite. See our onsite payment types reference for current known payment type ID and name values.
The currency accepted at the property.
The types of payments accepted at the property.
Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment.
Card number. Required for credit card transactions.
CVV/CSV code from the back of the customer's card. Required for credit card transactions.
Two-digit month the credit card will expire. Required for credit card transactions.
Year the credit card will expire. Required for credit card transactions.
Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Two-digit month the credit card will expire. Required for credit card transactions.
Year the credit card will expire. Required for credit card transactions.
CVV/CSV code from the back of the customer's card. Required for credit card transactions.
Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment.
Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment.
Card number. Required for credit card transactions.
CVV/CSV code from the back of the customer's card. Required for credit card transactions.
Two-digit month the credit card will expire. Required for credit card transactions.
Year the credit card will expire. Required for credit card transactions.
Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required.
Card number. Required for credit card transactions.
CVV/CSV code from the back of the customer's card. Required for credit card transactions.
Two-digit month the credit card will expire. Required for credit card transactions.
Year the credit card will expire. Required for credit card transactions.
Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Two-digit month the credit card will expire. Required for credit card transactions.
Year the credit card will expire. Required for credit card transactions.
CVV/CSV code from the back of the customer's card. Required for credit card transactions.
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required.
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required.
Card number. Required for credit card transactions.
CVV/CSV code from the back of the customer's card. Required for credit card transactions.
Two-digit month the credit card will expire. Required for credit card transactions.
Year the credit card will expire. Required for credit card transactions.
Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required. Values: CORPORATE_CARD,CUSTOMER_CARD,VIRTUAL_CARD,AFFILIATE_COLLECT
Mechanism used by the cardholder to authenticate to the merchant. Values: GUEST,OWN_CREDENTIALS,FEDERATED_ID,ISSUER_CREDENTIALS,THIRD_PARTY_AUTHENTICATION,FIDO_AUTHENTICATION
Mechanism used by the cardholder to authenticate to the merchant. Values: GUEST,OWN_CREDENTIALS,FEDERATED_ID,ISSUER_CREDENTIALS,THIRD_PARTY_AUTHENTICATION,FIDO_AUTHENTICATION
Returns a representation of an immutable list of all enum entries, in the order they're declared.
Mechanism used by the cardholder to authenticate to the merchant. Values: GUEST,OWN_CREDENTIALS,FEDERATED_ID,ISSUER_CREDENTIALS,THIRD_PARTY_AUTHENTICATION,FIDO_AUTHENTICATION
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Mechanism used by the cardholder to authenticate to the merchant.
Date and time in UTC of the cardholder authentication, in extended ISO 8601 format.
Date the cardholder opened the account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Date the cardholder’s account with the merchant was last changed, including Billing or Shipping address, new payment account, or new user(s) added, in ISO 8601 format (YYYY-MM-DD).
Date the cardholder’s account with the merchant had a password change or account reset, in ISO 8601 format (YYYY-MM-DD).
Number of add card attempts in the last 24 hours.
Number of purchases with this cardholder's account during the previous six months.
Number of purchases with this cardholder's account during the previous six months.
Number of add card attempts in the last 24 hours.
Mechanism used by the cardholder to authenticate to the merchant.
Date and time in UTC of the cardholder authentication, in extended ISO 8601 format.
Date the cardholder’s account with the merchant was last changed, including Billing or Shipping address, new payment account, or new user(s) added, in ISO 8601 format (YYYY-MM-DD).
Date the cardholder opened the account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Date the cardholder’s account with the merchant had a password change or account reset, in ISO 8601 format (YYYY-MM-DD).
Mechanism used by the cardholder to authenticate to the merchant.
Date and time in UTC of the cardholder authentication, in extended ISO 8601 format.
Date the cardholder opened the account with the merchant, in ISO 8601 format (YYYY-MM-DD).
Date the cardholder’s account with the merchant was last changed, including Billing or Shipping address, new payment account, or new user(s) added, in ISO 8601 format (YYYY-MM-DD).
Date the cardholder’s account with the merchant had a password change or account reset, in ISO 8601 format (YYYY-MM-DD).
Number of add card attempts in the last 24 hours.
Number of purchases with this cardholder's account during the previous six months.
Mechanism used by the cardholder to authenticate to the merchant. Values: GUEST,OWN_CREDENTIALS,FEDERATED_ID,ISSUER_CREDENTIALS,THIRD_PARTY_AUTHENTICATION,FIDO_AUTHENTICATION
The version of the EgPayments.js library.
The customer's browser accept header that was used in the booking request.
Encoded browser metadata, provided by the EgPayments.js library.
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen
Fully qualified URL of merchant website or customer care site.
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen Values: EXTRA_SMALL,SMALL,MEDIUM,LARGE,FULL_SCREEN
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen Values: EXTRA_SMALL,SMALL,MEDIUM,LARGE,FULL_SCREEN
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen Values: EXTRA_SMALL,SMALL,MEDIUM,LARGE,FULL_SCREEN
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
The customer's browser accept header that was used in the booking request.
Encoded browser metadata, provided by the EgPayments.js library.
Fully qualified URL of merchant website or customer care site.
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen
The version of the EgPayments.js library.
The customer's browser accept header that was used in the booking request.
Encoded browser metadata, provided by the EgPayments.js library.
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen
Fully qualified URL of merchant website or customer care site.
The preferred window size that needs to be displayed to the customer. Following are the possible values of this field: * extra_small: 250 x 400 * small: 390 x 400 * medium: 600 x 400 * large: 500 x 600 * full_screen: Full screen Values: EXTRA_SMALL,SMALL,MEDIUM,LARGE,FULL_SCREEN
The registered payment session ID.
A base64 encoded object which contains configuration needed to perform device fingerprinting. It is used in conjunction with the provided Javascript library for PSD2.
A base64 encoded object which contains configuration needed to perform device fingerprinting. It is used in conjunction with the provided Javascript library for PSD2.
The registered payment session ID.
The payment registration response.
The registered payment session ID.
A base64 encoded object which contains configuration needed to perform device fingerprinting. It is used in conjunction with the provided Javascript library for PSD2.
The identifier of the payment type.
The name of the payment type.
The numerical portion of the country code from the phone number. Do not include the leading '+' character. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The remaining digits of the phone number. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The area code of the phone number. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The area code of the phone number. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The numerical portion of the country code from the phone number. Do not include the leading '+' character. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The entire phone number must be represented across the three fields in this object. The entire phone number should not exceed 25 characters.
The numerical portion of the country code from the phone number. Do not include the leading '+' character. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The remaining digits of the phone number. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The area code of the phone number. Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered in this field will be re-encoded.
The numerical portion of the country code from the phone number. Do not include the leading '+' character.
The entire phone number must be represented across the three fields in this object.
The numerical portion of the country code from the phone number. Do not include the leading '+' character.
The area code of the phone number.
The remaining digits of the phone number.
Description of information that may be helpful when planning a trip to this property.
Information about property policies that guests need to be aware of.
Description of information that may be helpful when planning a trip to this property.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
The preferred airport of the property.
The airport's IATA code.
Array of arrays of amount objects. Each sub-array of amount objects represents a single night's charges.
Array of amount objects. Details any charges that apply to the entire stay (not divided per-night). Any per-room adjustments are applied to the base_rate amount within this object.
Array of arrays of amount objects. Each sub-array of amount objects represents a single night's charges.
The pricing information object.
Array of arrays of amount objects. Each sub-array of amount objects represents a single night's charges.
Array of amount objects. Details any charges that apply to the entire stay (not divided per-night). Any per-room adjustments are applied to the base_rate amount within this object.
Promotions provided by the property that add value to the stay, but don’t affect the booking price (i.e., ski lift tickets or premium wifi).
Promotions provided by the property that add value to the stay, but don’t affect the booking price (i.e., ski lift tickets or premium wifi).
Promotions that apply to the booked room.
Promotions provided by the property that add value to the stay, but don’t affect the booking price (i.e., ski lift tickets or premium wifi).
A collection of value adds that apply to this rate.
A collection of value adds that apply to this rate.
Available promotions that apply to this rate.
A collection of value adds that apply to this rate.
The geometry type. The only supported type is Polygon
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
GeoJSON geometry
The geometry type. The only supported type is Polygon
An array of linear ring coordinate arrays that combine to make up a single Polygon in geojson format. If there is more than one linear ring at this level, the first is the outer boundary and the remaining linear rings are interior rings or holes.
Array of objects containing room information.
Array of objects containing room information.
The rooms and rates for a property.
Array of objects containing room information.
A map of links, including links to request additional rates. Note that the recommendations feature has been retired and will return an error if the link is followed.
Array of objects containing room information.
Array of objects containing room information.
Array of objects containing room information.
Expedia property ID.
Unique Expedia property ID.
Property name.
The property's phone number.
The property's fax number.
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.
Lists all of the amenities available for all guests at the property. See our amenities reference for current known amenity ID and name values.
Contains all property images available.
Information about all of the rooms at the property.
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.
Statistics of the property, such as number of floors. See our statistics reference for current known statistics ID and name values.
Themes that describe the property. See our themes reference for current known theme ID and name values.
Tax ID.
Languages spoken at the property.
Boolean value indicating if a property is a multi-unit property.
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.
The supply source of the property.
Lists all of the amenities available for all guests at the property. See our amenities reference for current known amenity ID and name values.
Boolean value indicating if a property is a multi-unit property.
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.
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.
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.
Information about all of the rooms at the property.
Languages spoken at the property.
Statistics of the property, such as number of floors. See our statistics reference for current known statistics ID and name values.
Themes that describe the property. See our themes reference for current known theme ID and name values.
An individual property object in the map of property objects.
Unique Expedia property ID.
Property name.
The property's phone number.
The property's fax number.
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.
Lists all of the amenities available for all guests at the property. See our amenities reference for current known amenity ID and name values.
Contains all property images available.
Information about all of the rooms at the property.
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.
Statistics of the property, such as number of floors. See our statistics reference for current known statistics ID and name values.
Themes that describe the property. See our themes reference for current known theme ID and name values.
Tax ID.
Languages spoken at the property.
Boolean value indicating if a property is a multi-unit property.
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.
The supply source of the property.
Unique Expedia property ID.
A property object.
Unique Expedia property ID.
The property id of the inactive property
The name of the property manager.
Information about the property manager.
The name of the property manager.
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.
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.
Information about the property's rating.
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.
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.
Response with a property that has no available rates for the given request parameters, but include=unavailable_reason was requested.
Helps determine which type of property response is returned. Values: AVAILABLE,PARTIALLY_UNAVAILABLE
Helps determine which type of property response is returned. Values: AVAILABLE,PARTIALLY_UNAVAILABLE
Helps determine which type of property response is returned. Values: AVAILABLE,PARTIALLY_UNAVAILABLE
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Expedia property ID.
Helps determine which type of property response is returned.
A score to sort properties where the higher the value the better. It can be used to:
* Sort the properties on the response
* Sort properties across multiple responses in parallel searches for large regions
Unique identifier for a rate.
This lists all of the Amenities available with a specific rate, including value adds, such as breakfast. See our amenities reference for current known amenity ID and name values.
A text description of any special offers for this rate.
This lists all of the Amenities available with a specific rate, including value adds, such as breakfast. See our amenities reference for current known amenity ID and name values.
A text description of any special offers for this rate.
An individual rate.
Unique identifier for a rate.
This lists all of the Amenities available with a specific rate, including value adds, such as breakfast. See our amenities reference for current known amenity ID and name values.
A text description of any special offers for this rate.
The id of the rate.
The cancel penalties associated with the itinerary.
The cancel penalties associated with the itinerary.
The rate information associated with the itinerary.
The id of the rate.
The cancel penalties associated with the itinerary.
The id of the rate.
Indicates whether the itinerary is refundable or not.
The cancel penalties associated with the itinerary.
A list of date exceptions. Dates within these ranges provide no refund on cancellation, regardless of cancel penalty windows. Nonrefundable range begins at 00:00:00 on the start date, and ends at 23:59:59 on the end date, in the local time zone of the property.
The cancel penalties associated with the itinerary.
A list of date exceptions. Dates within these ranges provide no refund on cancellation, regardless of cancel penalty windows. Nonrefundable range begins at 00:00:00 on the start date, and ends at 23:59:59 on the end date, in the local time zone of the property.
Indicates whether the itinerary is refundable or not.
The rate information associated with the itinerary.
The id of the rate.
Indicates whether the itinerary is refundable or not.
The cancel penalties associated with the itinerary.
A list of date exceptions. Dates within these ranges provide no refund on cancellation, regardless of cancel penalty windows. Nonrefundable range begins at 00:00:00 on the start date, and ends at 23:59:59 on the end date, in the local time zone of the property.
A map of links, including a link to request payment options.
Unique Identifier for a rate.
The number of bookable rooms remaining with this rate in EPS inventory. Use this value to create rules for urgency messaging to alert users to low availability on busy travel dates or at popular properties. If the value returns as 2147483647 (max int value), the actual value could not be determined. Ensure your urgency messaging ignores such instances when returned.
Indicates if the rate is fully refundable at the time of booking. Cancel penalties may still apply. Please refer to the cancel penalties section for reference.
Indicates if a \"Member Only Deal\" is available for this rate.
Room amenities.
A map of the room's bed groups.
Array of cancel_penalty objects containing cancel penalty information.
An array of stay date ranges within this check-in / check-out range that are not refundable. Stay dates within these ranges provide no refund on cancellation, regardless of cancel penalty windows. The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01, and a check-out date of 2023-09-06, this would be a 5 night stay. A nonrefundable_date_range with start: 2023-09-02 and end: 2023-09-03 would mean 2 of the nights are nonrefundable. The 1st night is refundable, the 2nd and 3rd nights are nonrefundable, and the 4th and 5th nights are refundable, subject to cancel_penalties restrictions.
An array of stay date ranges within this check-in / check-out range that have an incentive applied. The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01, and a check-out date of 2023-09-06, this would be a 5 night stay. A marketing_fee_incentive with start: 2023-09-02 and end: 2023-09-03 would mean 2 of the nights have an incentive applied. The 1st night is not part of the incentive, the 2nd and 3rd nights are part of the incentive, and the 4th and 5th nights are not part of the incentive.
A map of room information by occupancy.
Array of deposits for the rate.
The number of bookable rooms remaining with this rate in EPS inventory. Use this value to create rules for urgency messaging to alert users to low availability on busy travel dates or at popular properties. If the value returns as 2147483647 (max int value), the actual value could not be determined. Ensure your urgency messaging ignores such instances when returned.
A map of the room's bed groups.
Array of cancel_penalty objects containing cancel penalty information.
An array of stay date ranges within this check-in / check-out range that have an incentive applied. The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01, and a check-out date of 2023-09-06, this would be a 5 night stay. A marketing_fee_incentive with start: 2023-09-02 and end: 2023-09-03 would mean 2 of the nights have an incentive applied. The 1st night is not part of the incentive, the 2nd and 3rd nights are part of the incentive, and the 4th and 5th nights are not part of the incentive.
Indicates if a \"Member Only Deal\" is available for this rate.
An array of stay date ranges within this check-in / check-out range that are not refundable. Stay dates within these ranges provide no refund on cancellation, regardless of cancel penalty windows. The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01, and a check-out date of 2023-09-06, this would be a 5 night stay. A nonrefundable_date_range with start: 2023-09-02 and end: 2023-09-03 would mean 2 of the nights are nonrefundable. The 1st night is refundable, the 2nd and 3rd nights are nonrefundable, and the 4th and 5th nights are refundable, subject to cancel_penalties restrictions.
A map of room information by occupancy.
Indicates if the rate is fully refundable at the time of booking. Cancel penalties may still apply. Please refer to the cancel penalties section for reference.
A rate.
Unique Identifier for a rate.
The number of bookable rooms remaining with this rate in EPS inventory. Use this value to create rules for urgency messaging to alert users to low availability on busy travel dates or at popular properties. If the value returns as 2147483647 (max int value), the actual value could not be determined. Ensure your urgency messaging ignores such instances when returned.
Indicates if the rate is fully refundable at the time of booking. Cancel penalties may still apply. Please refer to the cancel penalties section for reference.
Indicates if a \"Member Only Deal\" is available for this rate.
Room amenities.
A map of the room's bed groups.
Array of cancel_penalty objects containing cancel penalty information.
An array of stay date ranges within this check-in / check-out range that are not refundable. Stay dates within these ranges provide no refund on cancellation, regardless of cancel penalty windows. The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01, and a check-out date of 2023-09-06, this would be a 5 night stay. A nonrefundable_date_range with start: 2023-09-02 and end: 2023-09-03 would mean 2 of the nights are nonrefundable. The 1st night is refundable, the 2nd and 3rd nights are nonrefundable, and the 4th and 5th nights are refundable, subject to cancel_penalties restrictions.
An array of stay date ranges within this check-in / check-out range that have an incentive applied. The stay dates are determined by the would be check-in of that night. With a check-in date of 2023-09-01, and a check-out date of 2023-09-06, this would be a 5 night stay. A marketing_fee_incentive with start: 2023-09-02 and end: 2023-09-03 would mean 2 of the nights have an incentive applied. The 1st night is not part of the incentive, the 2nd and 3rd nights are part of the incentive, and the 4th and 5th nights are not part of the incentive.
A map of room information by occupancy.
Array of deposits for the rate.
Region Id.
Region type.
Region name.
Full region name.
Specific information about the region e.g. whether it covers surrounding areas for a city. Only present when relevant for a region. See our region descriptors reference for current known descriptor values.
3-character IATA airport code.
3-character IATA airport metropolitan code of the metropolitan airport area.
Region country code (ISO 3166-1 alpha-2).
Region country subdivision code (ISO 3166-2).
A map of region types to a sorted array of region ids with a touristic association to the region.
An array of the region's ancestors.
A map of region types to an array of region ids. The region ids are direct descendants of the region.
An array of associated property ids for the region.
An array of associated property ids within an expanded radius for the region.
A list of regional categories.
A list of regional tags.
A map of region types to a sorted array of region ids with a touristic association to the region.
Region country subdivision code (ISO 3166-2).
A map of region types to an array of region ids. The region ids are direct descendants of the region.
Specific information about the region e.g. whether it covers surrounding areas for a city. Only present when relevant for a region. See our region descriptors reference for current known descriptor values.
3-character IATA airport metropolitan code of the metropolitan airport area.
An array of associated property ids within an expanded radius for the region.
An array of associated property ids for the region.
Region Id.
Region type.
Region name.
Full region name.
Specific information about the region e.g. whether it covers surrounding areas for a city. Only present when relevant for a region. See our region descriptors reference for current known descriptor values.
3-character IATA airport code.
3-character IATA airport metropolitan code of the metropolitan airport area.
Region country code (ISO 3166-1 alpha-2).
Region country subdivision code (ISO 3166-2).
A map of region types to a sorted array of region ids with a touristic association to the region.
An array of the region's ancestors.
A map of region types to an array of region ids. The region ids are direct descendants of the region.
An array of associated property ids for the region.
An array of associated property ids within an expanded radius for the region.
A list of regional categories.
A list of regional tags.
A map of links, including link to get the rental agreement.
Information about a vacation rentals rental agreement.
Where this review has been verified from.
Title of this review.
When this review was made, in ISO 8601 format.
The rating for this property given by the reviewer. Returns a value between 1.0 and 5.0.
The name of the person who wrote this review.
The text of the review itself.
When this review was made, in ISO 8601 format.
The name of the person who wrote this review.
Where this review has been verified from.
A review object for a property.
Where this review has been verified from.
Title of this review.
When this review was made, in ISO 8601 format.
The rating for this property given by the reviewer. Returns a value between 1.0 and 5.0.
The name of the person who wrote this review.
The text of the review itself.
Unique Identifier for a room type.
Name of the room type.
Array of objects containing rate information.
The room information.
Unique Identifier for a room type.
Name of the room type.
Array of objects containing rate information.
Unique identifier for a room type.
Room type name.
Lists all of the amenities available in the room. See our amenities reference for current known amenity ID and name values.
The room's images. Contains all room images available.
A map of the room's bed groups.
A map of the room views. See our view reference for current known room view ID and name values.
Lists all of the amenities available in the room. See our amenities reference for current known amenity ID and name values.
A map of the room views. See our view reference for current known room view ID and name values.
An individual room.
Unique identifier for a room type.
Room type name.
Lists all of the amenities available in the room. See our amenities reference for current known amenity ID and name values.
The room's images. Contains all room images available.
A map of the room's bed groups.
A map of the room views. See our view reference for current known room view ID and name values.
The source of the event. If voyager_agent, agent_id will be supplied. Values: RAPID_API,VOYAGER_AGENT,OTHER
The source of the event. If voyager_agent, agent_id will be supplied. Values: RAPID_API,VOYAGER_AGENT,OTHER
The source of the event. If voyager_agent, agent_id will be supplied. Values: RAPID_API,VOYAGER_AGENT,OTHER
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Type type of event associated with this history item such as modified or canceled. Values: CREATED,MODIFIED,CANCELED
Type type of event associated with this history item such as modified or canceled. Values: CREATED,MODIFIED,CANCELED
Type type of event associated with this history item such as modified or canceled. Values: CREATED,MODIFIED,CANCELED
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Room history id for particular change.
Date and time in UTC of the change event, in extended ISO 8601 format.
Type type of event associated with this history item such as modified or canceled.
The source of the event. If voyager_agent, agent_id will be supplied.
Optional identifier provided during changes via Rapid.
An agent user id number associated with a modification.
The room id.
Unique identifier for a bed type.
The check-in date of the itinerary.
The check-out date of the itinerary.
The number of adults staying in the room.
The ages of children for the room.
The first name of the main guest staying in the room.
The last name of the main guest staying in the room.
Any special request info associated with the room.
Indicates if the room is smoking or non-smoking.
A loyalty identifier for a hotel loyalty program associated with this room guest.
An agent user id number associated with a modification.
Optional identifier provided during changes via Rapid.
The source of the event. If voyager_agent, agent_id will be supplied.
Date and time in UTC of the change event, in extended ISO 8601 format.
Type type of event associated with this history item such as modified or canceled.
The last name of the main guest staying in the room.
The first name of the main guest staying in the room.
A loyalty identifier for a hotel loyalty program associated with this room guest.
The number of adults staying in the room.
Any special request info associated with the room.
A room history event, representing a change made to a specific room.
Room history id for particular change.
Date and time in UTC of the change event, in extended ISO 8601 format.
Type type of event associated with this history item such as modified or canceled.
The source of the event. If voyager_agent, agent_id will be supplied.
Optional identifier provided during changes via Rapid.
An agent user id number associated with a modification.
The room id.
Unique identifier for a bed type.
The check-in date of the itinerary.
The check-out date of the itinerary.
The number of adults staying in the room.
The ages of children for the room.
The first name of the main guest staying in the room.
The last name of the main guest staying in the room.
Any special request info associated with the room.
Indicates if the room is smoking or non-smoking.
A loyalty identifier for a hotel loyalty program associated with this room guest.
The source of the event. If voyager_agent, agent_id will be supplied. Values: RAPID_API,VOYAGER_AGENT,OTHER
Type type of event associated with this history item such as modified or canceled. Values: CREATED,MODIFIED,CANCELED
A map of links - * cancel - Cancel the booking for this room * change - A PUT call to modify the details of the booking for this room (soft change) * shop_for_change - Shop for rates to evaluate for possible rebooking. This shop call will show the estimated financial impact of the change.
Current parameters supported in shop for change: checkin, checkout, occupancy See: #get-/properties/-property_id-/availability
The room id.
Unique identifier for a bed type.
The check-in date of the itinerary.
The check-out date of the itinerary.
The number of adults staying in the room.
The ages of children for the room.
The first name of the main guest staying in the room.
The last name of the main guest staying in the room.
Any special request info associated with the room.
Indicates if the room is smoking or non-smoking.
A loyalty identifier for a hotel loyalty program associated with this room guest.
The last name of the main guest staying in the room.
The first name of the main guest staying in the room.
A loyalty identifier for a hotel loyalty program associated with this room guest.
The number of adults staying in the room.
Any special request info associated with the room.
The room information.
The room id.
Unique identifier for a bed type.
The check-in date of the itinerary.
The check-out date of the itinerary.
The number of adults staying in the room.
The ages of children for the room.
The first name of the main guest staying in the room.
The last name of the main guest staying in the room.
Any special request info associated with the room.
Indicates if the room is smoking or non-smoking.
A loyalty identifier for a hotel loyalty program associated with this room guest.
A map of links, including links to continue booking this rate or to shop for additional rates. If this rate is still available for booking then a book link will be present if PSD2 is not a requirement for you or a payment_session link will be present if PSD2 is a requirement for you.
A map of room information by occupancy.
Array of deposits.
A map of room information by occupancy.
The price check response.
A map of room information by occupancy.
Array of deposits.
package If true, this rate has been provided to be bundled with car, air, etc. and displayed as a total package price. If shopping in a cross-sell scenario and using the cross-sell rate option, this indicates that the rate is a package rate available to be sold as an add-on to an existing itinerary.
If true, this rate has a \"Member Only Deal\" discount applied to the rate. Partners must be enabled to receive \"Member Only Deals\". If interested, partners should speak to their account representatives. This parameter can be used to merchandise if a \"Member Only Deal\" has been applied, which will help drive loyalty. In addition, it can be used by OTA's to create an opaque, but public shopping experience. This value will always be false for requests where the sales_environment is equal to \"hotel_package\".
If true, this rate is a corporate negotiated rate. These rates provide additional value adds (e.g. free breakfast, free wifi, discount) and same-day cancellation.
If true, this rate is an EPS Optimized Distribution rate. These rates are procured exclusively for EPS distribution and may contain benefits such as larger marketing fee, less restrictive cancellation policies, additional value adds, or unique availability.
If true, this rate has an associated mobile promotion which can be advertised as a special mobile only deal. This will only be present when include=sale_scenario.mobile_promotion is passed as a request parameter.
If true, this rate is a corporate negotiated rate. These rates provide additional value adds (e.g. free breakfast, free wifi, discount) and same-day cancellation.
If true, this rate is an EPS Optimized Distribution rate. These rates are procured exclusively for EPS distribution and may contain benefits such as larger marketing fee, less restrictive cancellation policies, additional value adds, or unique availability.
If true, this rate has a \"Member Only Deal\" discount applied to the rate. Partners must be enabled to receive \"Member Only Deals\". If interested, partners should speak to their account representatives. This parameter can be used to merchandise if a \"Member Only Deal\" has been applied, which will help drive loyalty. In addition, it can be used by OTA's to create an opaque, but public shopping experience. This value will always be false for requests where the sales_environment is equal to \"hotel_package\".
If true, this rate has an associated mobile promotion which can be advertised as a special mobile only deal. This will only be present when include=sale_scenario.mobile_promotion is passed as a request parameter.
Provides the special scenarios that need to be taken into account when using this rate.
package If true, this rate has been provided to be bundled with car, air, etc. and displayed as a total package price. If shopping in a cross-sell scenario and using the cross-sell rate option, this indicates that the rate is a package rate available to be sold as an add-on to an existing itinerary.
If true, this rate has a \"Member Only Deal\" discount applied to the rate. Partners must be enabled to receive \"Member Only Deals\". If interested, partners should speak to their account representatives. This parameter can be used to merchandise if a \"Member Only Deal\" has been applied, which will help drive loyalty. In addition, it can be used by OTA's to create an opaque, but public shopping experience. This value will always be false for requests where the sales_environment is equal to \"hotel_package\".
If true, this rate is a corporate negotiated rate. These rates provide additional value adds (e.g. free breakfast, free wifi, discount) and same-day cancellation.
If true, this rate is an EPS Optimized Distribution rate. These rates are procured exclusively for EPS distribution and may contain benefits such as larger marketing fee, less restrictive cancellation policies, additional value adds, or unique availability.
If true, this rate has an associated mobile promotion which can be advertised as a special mobile only deal. This will only be present when include=sale_scenario.mobile_promotion is passed as a request parameter.
The language code as a subset of BCP47 format.
Spoken language name.
The booking status of the room. Values: PENDING,BOOKED,CANCELED
The booking status of the room. Values: PENDING,BOOKED,CANCELED
The booking status of the room. Values: PENDING,BOOKED,CANCELED
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
The minimum number of days for a stay.
The maximum number of days for a stay.
The minimum number of days for a stay.
The maximum number of days for a stay.
The price breakout type. Values: BASE_RATE,TAX_AND_SERVICE_FEE,EXTRA_PERSON_FEE,PROPERTY_FEE,SALES_TAX,ADJUSTMENT,RECOVERY_CHARGES_AND_FEES,TRAVELER_SERVICE_FEE
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
value The value of the amount object. Decimal point inline with correct precision.
Currency of the amount object.
The contact name.
Email address for the contact.
The supply contact information. Note that full details may not be displayed until a short time prior to checkin.
The contact name.
Email address for the contact.
The event type for which the test notification is requested.
The event type for which the test notification is requested.
The event type for which the test notification is requested.
Cryptographic element used to indicate Authentication was successfully performed
Electronic Commerce Indicator. The ECI is used in payer authentication to indicate the level of security used when the cardholder provided payment information to the merchant. Its value corresponds to the authentication result and the characteristics of the merchant checkout process. Each card network, e.g., Visa, MasterCard, JCB, has specific rules around the appropriate values and use of the ECI.
Indicates what version of 3DS was used to authenticate the user.
Directory Server Transaction Id. Returned during authentication and is used as an additional parameter to validate that transaction was authenticated.
set only if PAResStatus value is received in the authentication response
set this only if PAResStatus value is received in the authentication response if Authentication was Frictionless → AuthenticationResponse.PAResStatus, if Authentication was a successful challenge → \"C\" (This is the directory response for challenge)
String used by both Visa and MasterCard which identifies a specific transaction on the Directory This string value should remain consistent throughout a transaction's history.
Used in some scenarios for 3DS 1.0.
Only received for Mastercard transactions, else can be null. 0 - Non-SecureCode transaction, bypassed by the Merchant 1 - Merchant-Only SecureCode transaction 2 - Fully authenticated SecureCode transaction
Directory Server Transaction Id. Returned during authentication and is used as an additional parameter to validate that transaction was authenticated.
Electronic Commerce Indicator. The ECI is used in payer authentication to indicate the level of security used when the cardholder provided payment information to the merchant. Its value corresponds to the authentication result and the characteristics of the merchant checkout process. Each card network, e.g., Visa, MasterCard, JCB, has specific rules around the appropriate values and use of the ECI.
set only if PAResStatus value is received in the authentication response
Indicates what version of 3DS was used to authenticate the user.
Only received for Mastercard transactions, else can be null. 0 - Non-SecureCode transaction, bypassed by the Merchant 1 - Merchant-Only SecureCode transaction 2 - Fully authenticated SecureCode transaction
set this only if PAResStatus value is received in the authentication response if Authentication was Frictionless → AuthenticationResponse.PAResStatus, if Authentication was a successful challenge → \"C\" (This is the directory response for challenge)
Cryptographic element used to indicate Authentication was successfully performed
Electronic Commerce Indicator. The ECI is used in payer authentication to indicate the level of security used when the cardholder provided payment information to the merchant. Its value corresponds to the authentication result and the characteristics of the merchant checkout process. Each card network, e.g., Visa, MasterCard, JCB, has specific rules around the appropriate values and use of the ECI.
Indicates what version of 3DS was used to authenticate the user.
Directory Server Transaction Id. Returned during authentication and is used as an additional parameter to validate that transaction was authenticated.
set only if PAResStatus value is received in the authentication response
set this only if PAResStatus value is received in the authentication response if Authentication was Frictionless → AuthenticationResponse.PAResStatus, if Authentication was a successful challenge → \"C\" (This is the directory response for challenge)
String used by both Visa and MasterCard which identifies a specific transaction on the Directory This string value should remain consistent throughout a transaction's history.
Used in some scenarios for 3DS 1.0.
Only received for Mastercard transactions, else can be null. 0 - Non-SecureCode transaction, bypassed by the Merchant 1 - Merchant-Only SecureCode transaction 2 - Fully authenticated SecureCode transaction
The total price of charges, given various critera. * inclusive - provides the total price including taxes and fees. This does not include hotel collected fees such as resort, mandatory taxes, and mandatory fees. * exclusive - provides the total price excluding taxes and fees. * inclusive_strikethrough - provides the tax inclusive total price with any hotel funded discounts added back. Can be used to merchandise the savings due to a discount. * strikethrough - provides the tax exclusive total price with any hotel funded discounts added back. Can be used to merchandise the savings due to a discount. * marketing_fee - provides the potential owed earnings per transaction. * gross_profit - provides the estimated gross profit per transaction. * minimum_selling_price - provides the minimum selling price. * property_fees - provides the total of the fees collected by the property.
First line of customer's street address.
Second line of customer's street address.
Third line of customer's street address.
Customer's city.
Customer's state or province code.
Customer's postal code.
Customer's country code, in two-letter ISO 3166-1 alpha-2 format.
Customer's country code, in two-letter ISO 3166-1 alpha-2 format.
Customer's state or province code.
The trader address.
First line of customer's street address.
Second line of customer's street address.
Third line of customer's street address.
Customer's city.
Customer's state or province code.
Customer's postal code.
Customer's country code, in two-letter ISO 3166-1 alpha-2 format.
The trader contact message.
The trader name.
Name of the register where the trader is registered, and is related to the business_register_number
NOTE: See our Digital Services Act information on Developer Hub.
Business registration number
NOTE: See our Digital Services Act information on Developer Hub.
Certification that the trader has confirmed their commitment to only offer products or services that comply with the applicable rules of Union law.
NOTE: See our Digital Services Act information on Developer Hub.
The trader right to withdraw message.
The trader email address.
The trader phone number.
Name of the register where the trader is registered, and is related to the business_register_number
NOTE: See our Digital Services Act information on Developer Hub.
Business registration number
NOTE: See our Digital Services Act information on Developer Hub.
The trader right to withdraw message.
Certification that the trader has confirmed their commitment to only offer products or services that comply with the applicable rules of Union law.
NOTE: See our Digital Services Act information on Developer Hub.
Information of the professional entity that sells the property inventory or related services.
The trader contact message.
The trader name.
Name of the register where the trader is registered, and is related to the business_register_number
NOTE: See our Digital Services Act information on Developer Hub.
Business registration number
NOTE: See our Digital Services Act information on Developer Hub.
Certification that the trader has confirmed their commitment to only offer products or services that comply with the applicable rules of Union law.
NOTE: See our Digital Services Act information on Developer Hub.
The trader right to withdraw message.
The trader email address.
The trader phone number.
The url linking to the full text terms and conditions.
An array of traders.
The url linking to the full text terms and conditions.
The professional entity or entities that sells the property inventory or related services.
The url linking to the full text terms and conditions.
An array of traders.
The companion category for any travelers that accompanied this reviewer. Values: FAMILY,FAMILY_WITH_CHILDREN,PARTNER,SELF,FRIENDS,PET
The companion category for any travelers that accompanied this reviewer. Values: FAMILY,FAMILY_WITH_CHILDREN,PARTNER,SELF,FRIENDS,PET
The companion category for any travelers that accompanied this reviewer. Values: FAMILY,FAMILY_WITH_CHILDREN,PARTNER,SELF,FRIENDS,PET
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
The reason category for this reviewer's trip. Values: BUSINESS,LEISURE,FRIENDS_AND_FAMILY,BUSINESS_AND_LEISURE
The reason category for this reviewer's trip. Values: BUSINESS,LEISURE,FRIENDS_AND_FAMILY,BUSINESS_AND_LEISURE
The reason category for this reviewer's trip. Values: BUSINESS,LEISURE,FRIENDS_AND_FAMILY,BUSINESS_AND_LEISURE
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration. Values: ADULTS_EXCEED_THRESHOLD,CHILDREN_EXCEED_THRESHOLD,INFANTS_EXCEED_THRESHOLD,MINIMUM_CHILD_AGE,MAXIMUM_OCCUPANCY,CHECKIN_NOT_ALLOWED,CHECKOUT_NOT_ALLOWED,MINIMUM_STAY,MAXIMUM_STAY,RESTRICTED_DATES,SAME_DAY_RESTRICTIONS,MAXIMUM_ROOMS,CHILDREN_NOT_SUPPORTED,MINIMUM_ADVANCE_PURCHASE,MAXIMUM_ADVANCE_PURCHASE,PARTIAL_INVENTORY_AVAILABLE,NO_INVENTORY_AVAILABLE
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration. Values: ADULTS_EXCEED_THRESHOLD,CHILDREN_EXCEED_THRESHOLD,INFANTS_EXCEED_THRESHOLD,MINIMUM_CHILD_AGE,MAXIMUM_OCCUPANCY,CHECKIN_NOT_ALLOWED,CHECKOUT_NOT_ALLOWED,MINIMUM_STAY,MAXIMUM_STAY,RESTRICTED_DATES,SAME_DAY_RESTRICTIONS,MAXIMUM_ROOMS,CHILDREN_NOT_SUPPORTED,MINIMUM_ADVANCE_PURCHASE,MAXIMUM_ADVANCE_PURCHASE,PARTIAL_INVENTORY_AVAILABLE,NO_INVENTORY_AVAILABLE
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration. Values: ADULTS_EXCEED_THRESHOLD,CHILDREN_EXCEED_THRESHOLD,INFANTS_EXCEED_THRESHOLD,MINIMUM_CHILD_AGE,MAXIMUM_OCCUPANCY,CHECKIN_NOT_ALLOWED,CHECKOUT_NOT_ALLOWED,MINIMUM_STAY,MAXIMUM_STAY,RESTRICTED_DATES,SAME_DAY_RESTRICTIONS,MAXIMUM_ROOMS,CHILDREN_NOT_SUPPORTED,MINIMUM_ADVANCE_PURCHASE,MAXIMUM_ADVANCE_PURCHASE,PARTIAL_INVENTORY_AVAILABLE,NO_INVENTORY_AVAILABLE
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
Returns an array containing the constants of this enum type, in the order they're declared.
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
if this enum type has no constant with the specified name
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration.
data An associated value that provides helpful information for some codes. Not present for all codes.
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration.
An unavailable reason that suggests ways that the request could be modified to locate available rooms and rates.
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration.
data An associated value that provides helpful information for some codes. Not present for all codes.
The code representing the reason. * adults_exceed_threshold - Number of adults requested exceeds room threshold. data will contain the maximum value. * children_exceed_threshold - Number of children requested exceeds room threshold. data will contain the maximum value. * infants_exceed_threshold - Number of infants requested exceeds room threshold. data will contain the maximum value. * minimum_child_age - Child age requested is less than the minimum age specified for the room. data will contain the minimum value. * maximum_occupancy - Number of occupants exceed the specified room limit. data will contain the maximum value. * checkin_not_allowed - Check-in not allowed for this stay date. * checkout_not_allowed - Check-out not allowed for this stay date. * minimum_stay - Length of stay is less than minimum. data will contain the minimum value. * maximum_stay - Length of stay is greater than maximum. data will contain the maximum value. * restricted_stay_lengths - Some stay lengths are not available for this check-in date. data will contain the allowed lengths separated by pipe |. eg. 3|5|6 * same_day_restrictions - Room is not available due to same day booking restrictions. * maximum_rooms - Room count exceeds provider limit. data will contain the maximum value. * children_not_supported - The property is restricted to adults only. * minimum_advance_purchase - Minimum Advance Purchase requirement not met. data will contain the minimum value. * maximum_advance_purchase - Maximum Advance Purchase requirement not met. data will contain the maximum value. * partial_inventory_available - Some of the dates have no inventory available for the specified duration. data will contain the unavailable dates separated by pipe |. eg. 2023-10-21|2023-10-23 * no_inventory_available - No inventory is available for the specified duration. Values: ADULTS_EXCEED_THRESHOLD,CHILDREN_EXCEED_THRESHOLD,INFANTS_EXCEED_THRESHOLD,MINIMUM_CHILD_AGE,MAXIMUM_OCCUPANCY,CHECKIN_NOT_ALLOWED,CHECKOUT_NOT_ALLOWED,MINIMUM_STAY,MAXIMUM_STAY,RESTRICTED_DATES,SAME_DAY_RESTRICTIONS,MAXIMUM_ROOMS,CHILDREN_NOT_SUPPORTED,MINIMUM_ADVANCE_PURCHASE,MAXIMUM_ADVANCE_PURCHASE,PARTIAL_INVENTORY_AVAILABLE,NO_INVENTORY_AVAILABLE
Bed type.
A description of the bed(s) in requested language.
The number of beds of this size.
A description of the bed(s) in requested language.
A room configuration.
Bed type.
A description of the bed(s) in requested language.
The number of beds of this size.
The property's registry number required by some jurisdictions.
Indicates if a property has a private host.
List of strings detailing house rules.
Map of enhanced house rules.
The Vrbo srp needed for link-off.
The listing id for a Vrbo property.
The listing number for a Vrbo property.
The listing source.
The specific unit.
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.
Map of the vacation rental unit configurations. The key value is the unit location.
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 <br> that may make display challenging.
Map of enhanced house rules.
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 <br> that may make display challenging.
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.
The listing number for a Vrbo property.
Indicates if a property has a private host.
The property's registry number required by some jurisdictions.
Map of the vacation rental unit configurations. The key value is the unit location.
Details for vacation rental properties.
The property's registry number required by some jurisdictions.
Indicates if a property has a private host.
List of strings detailing house rules.
Map of enhanced house rules.
The Vrbo srp needed for link-off.
The listing id for a Vrbo property.
The listing number for a Vrbo property.
The listing source.
The specific unit.
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.
Map of the vacation rental unit configurations. The key value is the unit location.
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 <br> that may make display challenging.
Unique identifier for the value add promotion.
A localized description of the value add promotion.
Indicates how many guests the value add promotion applies to.
A localized description of the value add promotion.
Indicates how many guests the value add promotion applies to.
An individual value add.
Unique identifier for the value add promotion.
A localized description of the value add promotion.
Indicates how many guests the value add promotion applies to.
Any price adjustments associated with this itinerary.
This option will be returned if a booking can be made using Expedia Affiliate Collect.
Information about the all-inclusive rate plans available at the property.
Airports related to the property.
Attributes about the property. See our attributes reference for current known attribute ID and name values.
A map of links, including links to confirm pricing and availability for the selected rate.
An individual bed configuration.
How and when the payment can be taken.
The refund information for cancelling the itinerary.
An age category.
The property's category. See our property categories reference for current known category ID and name values.
The general category that this value add promotion falls into. Values: FOOD_AND_BEVERAGE,ENTERTAINMENT,SERVICE,ACTIVITY,CREDIT
An object representing a charge. Information about the charge is provided in both the billable currency and the request currency.
The payment session response.
A map of links, including links to retrieve a booking, resume a held booking, or cancel a held booking.
The confirmation ids.
Details about initiating conversations.
The coordinates of the property.
The deposit policy associated with the itinerary.
Descriptions of a property.
Descriptions of a room.
An individual error.
Essential information, including the supply contact information and any other essential information.
The fees collected by the property. The values for each type of fee are the total for that type. Mandatory fees are collected by the property at check-in or check-out. Resort fees are charged for amenities and extras and collected by the property at check-in or check-out. Mandatory taxes are taxes collected by the property at check-in or check-out.
Rating information provided by guests who stayed at this property.
A property's guest reviews.
A property's verified guest reviews.
An individual image. See our image categories reference for current known caption and category values.
The book response.
A map of links, including links to retrieve a booking, resume a held booking, cancel a held booking, or complete a payment session if a challenge is used.
An itinerary history change event, representing a charge or refund made to the itinerary and not a specific room.
A map of links, including links to resume or cancel a held booking. This is only included for held bookings.
An object representing one incentive source and the stay dates relevant to that particular incentive.
Maximum occupancy counts.
The price breakout type. * base_rate - The room rate without any taxes and fees applied. * tax_and_service_fee - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * extra_person_fee - A per night fee that is charged by a hotel for additional adults over the nightly rate. This fee is included as part of the total. * property_fee - The property fee surcharge type must be displayed beginning on the initial hotel room selection page, immediately after your hotel search results page. This placement is required by the U.S. Federal Trade Commission (FTC). Display this surcharge as \"Property Fee\" on your room selection page, as described above, and in all subsequent price breakdowns for the following Points of Sale: * US * Canada * Brazil * LATAM * sales_tax - Taxes that must be displayed by certain jurisdictional laws. Ensure that you capture these values and display as \"Taxes\". * adjustment - This is the amount that the individual night have been adjusted/discounted. * recovery_charges_and_fees - Tax recovery charges, service fees, and taxes. Ensure that you capture these values and display as: \"Taxes and Fees\" * traveler_service_fee - Fee charged by Vrbo to support use of online tools, services and functions on its platform which enable guest self service. May be displayed as 'Traveler Service Fee' or 'Service Fee' any time fees are broken out for display on partner sites. Values: BASE_RATE,TAX_AND_SERVICE_FEE,EXTRA_PERSON_FEE,PROPERTY_FEE,SALES_TAX,ADJUSTMENT,RECOVERY_CHARGES_AND_FEES,TRAVELER_SERVICE_FEE
A notification.
The property’s accepted forms of payments when onsite. See our onsite payment types reference for current known payment type ID and name values.
The payment option response.
The payment registration response.
A map of links, including links to create a booking.
An individual payment type.
The entire phone number must be represented across the three fields in this object. The entire phone number should not exceed 25 characters.
The pricing information object.
Available promotions that apply to this rate.
Promotions that apply to the booked room.
GeoJSON geometry
The rooms and rates for a property.
A map of links, including links to request additional rates. Note that the recommendations feature has been retired and will return an error if the link is followed.
An individual property object in the map of property objects.
A property object.
Information about the property manager.
A map of links, including link to get image of the property manager.
Information about the property's rating.
Response with a property that has no available rates for the given request parameters, but include=unavailable_reason was requested.
An individual rate.
The rate information associated with the itinerary.
The rate information associated with the itinerary.
Information about a vacation rentals rental agreement.
A map of links, including link to get the rental agreement.
The room information.
An individual room.
A room history event, representing a change made to a specific room.
The room information.
A map of links - * cancel - Cancel the booking for this room * change - A PUT call to modify the details of the booking for this room (soft change) * shop_for_change - Shop for rates to evaluate for possible rebooking. This shop call will show the estimated financial impact of the change.
Current parameters supported in shop for change: checkin, checkout, occupancy See: #get-/properties/-property_id-/availability
The price check response.
A map of links, including links to continue booking this rate or to shop for additional rates. If this rate is still available for booking then a book link will be present if PSD2 is not a requirement for you or a payment_session link will be present if PSD2 is a requirement for you.
Provides the special scenarios that need to be taken into account when using this rate.
An individual spoken language.
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
The booking status of the room. Values: PENDING,BOOKED,CANCELED
Indicates the status of the rate. If the rate is still available then available will be returned. If the rate is no longer available at that price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. Values: AVAILABLE,PRICE_CHANGED,SOLD_OUT
The supply contact information. Note that full details may not be displayed until a short time prior to checkin.
The total price of charges, given various critera. * inclusive - provides the total price including taxes and fees. This does not include hotel collected fees such as resort, mandatory taxes, and mandatory fees. * exclusive - provides the total price excluding taxes and fees. * inclusive_strikethrough - provides the tax inclusive total price with any hotel funded discounts added back. Can be used to merchandise the savings due to a discount. * strikethrough - provides the tax exclusive total price with any hotel funded discounts added back. Can be used to merchandise the savings due to a discount. * marketing_fee - provides the potential owed earnings per transaction. * gross_profit - provides the estimated gross profit per transaction. * minimum_selling_price - provides the minimum selling price. * property_fees - provides the total of the fees collected by the property.
The trader address.
Information of the professional entity that sells the property inventory or related services.
The professional entity or entities that sells the property inventory or related services.
The companion category for any travelers that accompanied this reviewer. Values: FAMILY,FAMILY_WITH_CHILDREN,PARTNER,SELF,FRIENDS,PET
The reason category for this reviewer's trip. Values: BUSINESS,LEISURE,FRIENDS_AND_FAMILY,BUSINESS_AND_LEISURE
An unavailable reason that suggests ways that the request could be modified to locate available rooms and rates.
A room configuration.
Details for vacation rental properties.