Get
Constructors
Properties
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.
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.
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.
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.
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.
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.
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.
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.
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.
Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
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.
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
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.
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.
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.
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
Search for properties with a property rating less than or equal to the requested rating. The highest property rating value is 5.0.
Search for properties with a property rating greater than or equal to the requested rating. The lowest property rating value is 0.0.
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.
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.
Functions
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD)
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.
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
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.
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.
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.
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.
The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
Search for properties with a property rating less than or equal to the requested rating. The highest property rating value is 5.0.
Search for properties with a property rating greater than or equal to the requested rating. The lowest property rating value is 0.0.
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.
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.