Package-level declarations
Types
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.