Meal plan inclusions
Understand more about how meal plan inclusions are returned in the API.
How meal plan inclusions are returned in the API
Meal plans can be returned on different levels, which has an important impact on their meaning. They can be returned as a rate amenity, a property amenity, as content or, in some instances, as a value add promotion. For the full list of rate and property amenities see the content reference lists.
Rate plan amenities
Note: Rate amenities may also be seen in the content response. However, for the most up-to-date information regarding rate amenities, partners should take the meal inclusion and other rate amenities from the Shop response rather than the Content response.
In the content reference lists these are listed under amenities_rates.
Some common ones are:
- 1073742786 - Free breakfast
- 2194 - Breakfast for 2
- 2205 - Breakfast buffet
- 2206 - Half board
- 2111 - All-inclusive
Rate plan amenities can be seen in the Rapid Availability response. Meals are included for all guests in the booking unless there is an instruction stating otherwise. Instructions can be returned in the amenity name (for example, 'Breakfast for 2'), room type name, hotel description, or rate description. Refer to the Special value adds section below for further details.
"amenities": {
"1073742857": {
"id": "1073742857",
"name": "Breakfast for 1"
},
"1073742617": {
"id": "1073742617",
"name": "Disney park tickets"
},
"2192": {
"id": "2192",
"name": "Free WiFi"
}
},Rate plan amenities can also be seen in Rapid Itinerary Retrieve response:
"rate": {
"id": "384339493",
"merchant_of_record": "expedia",
"refundable": true,
"amenities": [
"2109",
"2192",
"1073742786"
],Property amenities
In the content reference lists these are listed under amenities_property.
The property amenities can be seen in the Rapid Content response:
"amenities": {
"2387": {
"id": "2387",
"name": "Tours/ticket assistance"
},
"4467": {
"id": "4467",
"name": "Beach towels"
},
"56": {
"id": "56",
"name": "Airport transportation (surcharge)"
},
"4003": {
"id": "4003",
"name": "Luggage storage"
},
"2001": {
"id": "2001",
"name": "Free breakfast"
},
"2386": {
"id": "2386",
"name": "Grocery/convenience store"
}
},The free breakfast (attribute 2001) property amenity means that a complimentary breakfast is included with all rooms and rate plans for the property. This is replicated at the rate level in the Rapid Shop response as attribute 1073742786 'free breakfast'.
Note: Unlike rate plan amenities which show what is included with the rate plan, property amenities show what is available at the property and are not necessarily free. E.g. attribute 361 'breakfast available (surcharge)'.
All-inclusive
A property may have some, or all, all-inclusive rate plans. These details are in the all_inclusive section of the Rapid Content response.
All rate plans are all-inclusive
If all_rate_plans: true then all rate plans for the property are all-inclusive, even if there is no rate plan amenity 'all-inclusive'.
"all_inclusive": {
"all_rate_plans": true,
"details": "This property is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply). <strong>Gratuities and taxes</strong>
Gratuities and taxes are included. Additional gratuities at guests' discretion are accepted. <strong>Food and beverages</strong><ul><li>All buffet and à la carte meals, snacks, and beverages included</li><li>In-room minibar (some restrictions)</li><li>Limited gourmet or à la carte dining</li></ul> <strong>Activities and facilities/equipment</strong>
All non-motorized water sports, land activities, and use of recreational facilities and equipment are included.
Water activities<ul><li>Snorkeling</li><li>Windsurfing</li></ul>
Land activities<ul><li>Bicycling</li><li>Fitness facilities</li><li>Tennis</li><li>Tennis lessons</li><li>Volleyball</li><li>Access to golf course</li></ul>
Lessons/classes/games <ul><li>Aerobics</li><li>Dancing</li><li>Language</li></ul> <strong>Kids' club</strong><ul><li>Supervised activities for children between 4 and 12 years old</li></ul> <strong>Not included</strong><ul><li>Golf green fees</li><li>Use of golf cart</li><li>Use of golf equipment</li><li>Motorized water sports</li><li>Scuba-diving certification</li><li>Tennis racquets</li><li>Premium food items</li><li>Premium/non-domestic alcoholic beverages</li><li>Childcare</li><li>Spa/beauty facilities and services</li></ul>",
"some_rate_plans": false
},)Other indicators that all rate plans are all-inclusive are 'all inclusive' in the property name. Expedia Group does not sell a property with 'all inclusive' in the property name unless all rate plans are all-inclusive for that property. Also, the property category in the Content response may show property category 8 'All-inclusive Property'. See a full list of property categories here.
Some rate plans are all-inclusive
If some_rate_plans: true then those rate plans which are all inclusive will have rate plan amenity 2111 'all-inclusive'. It will not have 'all inclusive' in the hotel name or the property category 'all-inclusive property'.
Restrictions for all-inclusive
Restrictions for all-inclusive, for example where alcoholic beverages are not included in the rate plan, can be seen in the details value of the all_inclusive response.
Example:
"all_inclusive": {
"all_rate_plans": false,
"details": "<em>All-inclusive</em> room rates at Solymar Naama Bay are available. These rates are higher because they include onsite food and beverages in the room rate (some restrictions may apply). <strong>Gratuities and taxes</strong>
Gratuities and taxes are included. Additional gratuities at guests' discretion are accepted. <strong>Food and beverages</strong><ul><li>Buffet meals, snacks, and select beverages included</li><li>Basic alcoholic beverages included</li><li>Dining availability limited at one or more venues</li></ul> <strong>Activities and facilities/equipment</strong>
Lessons/classes/games <ul><li>Dancing</li></ul> <strong>Entertainment</strong><ul><li>Onsite entertainment and activities</li></ul> <strong>Not included</strong><ul><li>Motorized water sports</li><li>Premium/non-domestic alcoholic beverages</li><li>Activities and services offered by independent operators</li></ul>",
"some_rate_plans": trueValue add promotions
Meal inclusion may also, in some instances, be seen in the Shop response as a value add promotion.
Example:
"promotions": {
"value_adds": {
"287248": {
"id": "287248",
"description": "Free dinner for 2 per day",
"category": "food_and_beverage",
"offer_type": "free",
"frequency": "per_day",
"person_count": 2
}
}
}Value add promotions can also be seen in Rapid Itinerary Retrieve response.
Example:
"rate": {
"id": "209136450",
"merchant_of_record": "expedia",
"refundable": true,
"amenities": [
"2192"
],
"promotions": {
"value_adds": {
"279553": {
"id": "279553",
"description": "Free continental breakfast for 2 per day",
"category": "food_and_beverage",
"offer_type": "free",
"frequency": "per_day",
"person_count": 2
}
}
},Special value adds
Rate plans that are part of a special offer may have rate-level and property-level content that includes additional information and restrictions on the offer. These are listed in the free text fields rates.special_offer_description, checkin.special_instructions, or policies.know_before_you_go which are returned in the Content response.
There are a variety of policies that could apply to value adds. Some examples include:
- Additional surcharges for some customers e.g. based on the number of actual travelers, traveler age, or bed-sharing set-up.
- No beverages included in free meal rate plans.
- Reservation is required to get the
breakfastLimitedtime e.g. breakfast is only available during certain hours or on particular days. - Nationality restricted.
- Special dining venue e.g. a restaurant not at the property.
- Special food type e.g. vegetarian only.
Example:
{
"12345": {
"property_id": "12345",
...
"checkin": {
"begin_time": "3:00 PM",
"end_time": "midnight",
"instructions": "<ul> <li>Extra-person charges may apply and vary depending on property policy</li><li>Government-issued photo identification and a credit card or cash deposit may be required at check-in for incidental charges</li><li>Special requests are subject to availability upon check-in and may incur additional charges; special requests cannot be guaranteed</li><li>This property accepts credit cards; cash is not accepted</li><li>Safety features at this property include a smoke detector</li><li>Please note that cultural norms and guest policies may differ by country and by property; the policies listed are provided by the property</li> </ul>",
"special_instructions": "This property doesn't offer after-hours check-in. Front desk staff will greet guests on arrival. For more details, please contact the property using the information on the booking confirmation. Additional fees apply to children 0 to 12 years old for breakfast. Breakfast is not included in the breakfast rate plans for children ages 6-12, and can be requested onsite for the listed child breakfast fee.",
"min_age": 18
},
...
"policies": {
"know_before_you_go": "<ul> <li>Up to 2 children 5 years old and younger stay free when occupying the parent or guardian's room, using existing bedding. </li><li>The Japanese Ministry of Health, Labour, and Welfare requires all international visitors to submit their passport number and nationality when registering at any lodging facility (inns, hotels, motels, etc. ). Additionally, lodging proprietors are required to photocopy passports for all registering guests and keep the photocopy on file. </li> </ul>"
},
...
"rates": {
"201510380": {
"id": "201510380",
"amenities": { ... },
"special_offer_description": "<strong>Stay for Breakfast</strong> Book a stay in this rate plan and receive breakfast for 2 adults and children under 12 years old registered in the same room. <em>Full details at check-in. Restrictions may apply.</em>"
}
}
}
}