swagger: "2.0" info: title: Rapid description: EPS Rapid V2.1 version: "2.1" host: api.ean.com basePath: /2.1 schemes: - https produces: - application/json tags: - name: Content description: "This section outlines the API calls available to you to access EPS's property content." - name: Geography description: "The EPS Geography API provides geography content for over 550,000 regions around the world." - name: Shopping description: "The EPS shopping APIs provide you with access to live rates & availability for over 350,000 properties globally." - name: Booking description: "The primary itinerary method of the Booking API creates a reservation for the selected hotel, room, rate and occupancy." - name: Manage Bookings description: "Retrieve existing itineraries or cancel existing rooms." - name: Recommendations description: "Get recommended properties" paths: /properties/content: get: summary: "Property Content" operationId: "getPropertyContent" tags: - Content description: | Returns content for the requested active EPS properties in the requested language. The response includes property-level, room-level and rate-level information. Request 1 to 250 properties at a time.
The response is a JSON map where the key is the property ID and the value is the property object itself. parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/language" - $ref: "#/parameters/propertyIdQueryRequired" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/PropertyContent" 400: $ref: "#/responses/PropertyContent400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/PropertyContent404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /files/properties/catalog: get: summary: "Property Catalog File" operationId: "getPropertyCatalogFile" tags: - Content description: | Returns a link to download the master list of EPS’s active properties. The catalog file is currently only available in English. 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
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"},"ratings":{"property":{"rating":"3.5","type":"Star"},"tripadvisor":{"rating":"4.5","count":16,"links":{"rating_image":{"method":"GET","href":"http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png"}}}},"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"}} {"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"},"ratings":{"property":{"rating":"3.5","type":"Star"},"tripadvisor":{"rating":"4.5","count":16,"links":{"rating_image":{"method":"GET","href":"http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png"}}}},"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"}} ``` parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/language" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/PropertyCatalogFile" 400: $ref: "#/responses/PropertyCatalogFile400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/File404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /files/properties/content: get: summary: "Property Content File" operationId: "getPropertyContentFile" tags: - Content description: | Returns a link to download all content for all of EPS’s active properties in the requested language. The response includes property-level, room-level and rate-level information.
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"},"ratings":{"property":{"rating":"3.5","type":"Star"},"tripadvisor":{"rating":"4.5","count":16,"links":{"rating_image":{"method":"GET","href":"http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png"}}}},"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":{"begin_time":"3:00 PM","end_time":"11:00 PM","instructions":"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />","special_instructions":"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.","min_age":"18"},"checkout":{"time":"11:00 AM"},"fees":{"mandatory":"

You'll be asked to pay the following charges at the hotel:

The hotel resort fee includes:

We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.

","optional":"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)
  • Airport shuttle fee: USD 350 per vehicle (one way)
  • Rollaway bed fee: USD 175 per night
  • "},"policies":{"know_before_you_go":"Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation.
  • Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding.
  • Only registered guests are allowed in the guestrooms.
  • Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
  • "},"attributes":{"general":{"2549":{"id":2549,"name":"No elevators"},"3357":{"id":3357,"name":"Caters to adults only"}},"pets":{"51":{"id":51,"name":"Pets allowed"},"2809":{"id":2809,"name":"Dogs only"}}},"amenities":{"1234":{"id":1234,"name":"Test Amenity"}},"images":[{"caption":"Featured Image","hero_image":true,"category":3,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"onsite_payments":{"currency":"USD","types":{"171":{"id":171,"name":"American Express"}}},"rooms":{"224829":{"id":"224829","name":"Single Room","descriptions":{"overview":"2 Twin Beds
    269-sq-foot (25-sq-meter) room with mountain views

    Internet - Free WiFi
    Entertainment - Flat-screen TV with cable channels
    Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
    Sleep - Premium bedding
    Bathroom - Private bathroom, shower, bathrobes, and free toiletries
    Practical - Safe and desk; cribs/infant beds available on request
    Comfort - Climate-controlled air conditioning and daily housekeeping
    Non-Smoking
    "},"amenities":{"1234":{"id":1234,"name":"Test Amenity"}},"images":[{"hero_image":true,"category":21001,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"bed_groups":{"5fe010529211bd68e8056ea6b8852f648027621e":{"id":"5fe010529211bd68e8056ea6b8852f648027621e","description":"1 King Bed","configuration":[{"type":"KingBed","size":"King","quantity":1}]}}}},"rates":{"333abc":{"id":"333abc","amenities":{"1234":{"id":1234,"name":"Test Amenity"}}}},"dates":{"added":"1998-07-19T05:00:00.000Z","updated":"2018-03-22T07:23:14.000Z"},"descriptions":{"amenities":"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.","dining":"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.","renovations":"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ","national_ratings":"For the benefit of our customers, we have provided a rating based on our rating system.","business_amenities":"Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.","rooms":"Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.","attractions":"Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.

    Distances are displayed to the nearest 0.1 mile and kilometer.

    Sogo Department Store - 0.7 km / 0.4 mi
    National Museum of Natural Science - 1.1 km / 0.7 mi
    Shr-Hwa International Tower - 1.4 km / 0.8 mi
    Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
    Taichung Metropolitan Opera House - 1.7 km / 1 mi
    Tiger City Mall - 1.8 km / 1.1 mi
    Maple Garden Park - 1.9 km / 1.2 mi
    National Museum of Fine Arts - 2.1 km / 1.3 mi
    Feng Chia University - 2.4 km / 1.5 mi
    Bao An Temple - 2.5 km / 1.6 mi
    Fengjia Night Market - 2.5 km / 1.6 mi
    Zhonghua Night Market - 2.7 km / 1.7 mi
    Chonglun Park - 2.9 km / 1.8 mi
    Wan He Temple - 2.9 km / 1.8 mi
    Chungyo Department Store - 3.1 km / 1.9 mi

    The nearest airports are:
    Taichung (RMQ) - 12 km / 7.5 mi
    Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
    Taipei (TSA-Songshan) - 135.5 km / 84.2 mi

    ","location":"This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science."},"airports":{"preferred":{"iata_airport_code":"SGF","distance":{"value":4.9,"unit":"km"}}},"registry_number":"1350K014A0088300"} {"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"},"ratings":{"property":{"rating":"3.5","type":"Star"},"tripadvisor":{"rating":"4.5","count":16,"links":{"rating_image":{"method":"GET","href":"http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png"}}}},"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},"checkin":{"begin_time":"3:00 PM","end_time":"11:00 PM","instructions":"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />","special_instructions":"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.","min_age":"18"},"checkout":{"time":"11:00 AM"},"fees":{"mandatory":"

    You'll be asked to pay the following charges at the hotel:

    The hotel resort fee includes:

    We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.

    ","optional":"Fee for in-room wireless Internet: USD 15 per hour (rates may vary)
  • Airport shuttle fee: USD 350 per vehicle (one way)
  • Rollaway bed fee: USD 175 per night
  • "},"policies":{"know_before_you_go":"Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation.
  • Children 11 years old and younger stay free when occupying the parent or guardian's room, using existing bedding.
  • Only registered guests are allowed in the guestrooms.
  • Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
  • "},"attributes":{"general":{"2549":{"id":2549,"name":"No elevators"},"3357":{"id":3357,"name":"Caters to adults only"}},"pets":{"51":{"id":51,"name":"Pets allowed"},"2809":{"id":2809,"name":"Dogs only"}}},"amenities":{"1234":{"id":1234,"name":"Test Amenity"}},"images":[{"caption":"Featured Image","hero_image":true,"category":3,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"onsite_payments":{"currency":"USD","types":{"171":{"id":171,"name":"American Express"}}},"rooms":{"224829":{"id":"224829","name":"Single Room","descriptions":{"overview":"2 Twin Beds
    269-sq-foot (25-sq-meter) room with mountain views

    Internet - Free WiFi
    Entertainment - Flat-screen TV with cable channels
    Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
    Sleep - Premium bedding
    Bathroom - Private bathroom, shower, bathrobes, and free toiletries
    Practical - Safe and desk; cribs/infant beds available on request
    Comfort - Climate-controlled air conditioning and daily housekeeping
    Non-Smoking
    "},"amenities":{"1234":{"id":1234,"name":"Test Amenity"}},"images":[{"hero_image":true,"category":21001,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"bed_groups":{"5fe010529211bd68e8056ea6b8852f648027621e":{"id":"5fe010529211bd68e8056ea6b8852f648027621e","description":"1 King Bed","configuration":[{"type":"KingBed","size":"King","quantity":1}]}}}},"rates":{"333abc":{"id":"333abc","amenities":{"1234":{"id":1234,"name":"Test Amenity"}}}},"dates":{"added":"1998-07-20T05:00:00.000Z","updated":"2018-03-22T13:33:17.000Z"},"descriptions":{"amenities":"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.","dining":"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.","renovations":"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ","national_ratings":"For the benefit of our customers, we have provided a rating based on our rating system.","business_amenities":"Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite.","rooms":"Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks.","attractions":"Distances are calculated in a straight line from the property's location to the point of interest or attraction, and may not reflect actual travel distance.

    Distances are displayed to the nearest 0.1 mile and kilometer.

    Sogo Department Store - 0.7 km / 0.4 mi
    National Museum of Natural Science - 1.1 km / 0.7 mi
    Shr-Hwa International Tower - 1.4 km / 0.8 mi
    Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
    Taichung Metropolitan Opera House - 1.7 km / 1 mi
    Tiger City Mall - 1.8 km / 1.1 mi
    Maple Garden Park - 1.9 km / 1.2 mi
    National Museum of Fine Arts - 2.1 km / 1.3 mi
    Feng Chia University - 2.4 km / 1.5 mi
    Bao An Temple - 2.5 km / 1.6 mi
    Fengjia Night Market - 2.5 km / 1.6 mi
    Zhonghua Night Market - 2.7 km / 1.7 mi
    Chonglun Park - 2.9 km / 1.8 mi
    Wan He Temple - 2.9 km / 1.8 mi
    Chungyo Department Store - 3.1 km / 1.9 mi

    The nearest airports are:
    Taichung (RMQ) - 12 km / 7.5 mi
    Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
    Taipei (TSA-Songshan) - 135.5 km / 84.2 mi

    ","location":"This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science."},"airports":{"preferred":{"iata_airport_code":"SGF","distance":{"value":7.3,"unit":"km"}}},"registry_number":"2350K014A089723"} ``` parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/language" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/PropertyContentFile" 400: $ref: "#/responses/PropertyContentFile400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/File404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /regions/{region_id}/descendants: get: summary: "Region Descendants" tags: - Geography description: | Returns the geographic definition and property mappings of all hierarchical descendants for the requested Region ID. To request all regions in the world, specify the Region ID of 0 (zero). To request all regions in a specific continent, country or other level, specify the Region ID of that region. Refer to the list of [top level regions](https://developer.expediapartnersolutions.com/reference/geography-reference-lists-2-2/).
    The response is a JSON stream of a map, where the key is a region type and the value is another map. That additional map contains the Region ID as the key, and the region object as the value. Neither map has any order.
    The response can be very large. We recommend saving the streamed response to a file on disk rather than keeping the whole response in memory. parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/regionDescendantsId" - $ref: "#/parameters/language" - $ref: "#/parameters/regionDescendantsInclude" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/RegionDescendants" 400: $ref: "#/responses/RegionDescendants400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/RegionDescendants404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /regions/{region_id}: get: summary: "Region" tags: - Geography description: | Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object. parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/regionId" - $ref: "#/parameters/language" - $ref: "#/parameters/regionInclude" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/Region" 400: $ref: "#/responses/Region400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/Region404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /airports: get: tags: - "Geography" summary: "Airports" description: | Returns the geographic definition and property mappings of all airports in our geography system. The response is a map in JSON format, where the key is the IATA airport code and the airport object is the value. The map has no order. parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/language" - $ref: "#/parameters/airportsInclude" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/Airports" 400: $ref: "#/responses/Airport400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /airports/{iata_airport_code}: get: tags: - "Geography" summary: "Airport" description: | Returns the geographic definition and property mappings for the requested IATA airport code. The response is a single JSON formatted airport object. parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/language" - $ref: "#/parameters/airportsInclude" - $ref: "#/parameters/iataAirportCode" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/Airport" 400: $ref: "#/responses/Airport400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/Airport404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /properties/availability: get: summary: "Get property room rates and availability" description: | 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. * 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). tags: - Shopping parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/availabilityTestHeader" - $ref: "#/parameters/checkin" - $ref: "#/parameters/checkout" - $ref: "#/parameters/currency" - $ref: "#/parameters/language" - $ref: "#/parameters/country_code" - $ref: "#/parameters/occupancy" - $ref: "#/parameters/propertyIdQueryRequired" - $ref: "#/parameters/sales_channel" - $ref: "#/parameters/sales_environment" - $ref: "#/parameters/sort_type" - $ref: "#/parameters/filter" - $ref: "#/parameters/include" - $ref: "#/parameters/rate_option" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/PropertyAvailability" 400: $ref: "#/responses/PropertyAvailability400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/PropertyAvailability404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /properties/availability/{property_id}/rooms/{room_id}/rates/{rate_id}/price-check: get: description: | Confirms the price returned by the Shop 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 shop request link to search again for different rates. In the event of a price change, go back to shop and book the property at the new price or return to additional rates for the property. summary: Get Current Price for Pre-Booking tags: - Shopping parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/priceCheckTestHeader" - $ref: "#/parameters/propertyId" - $ref: "#/parameters/roomId" - $ref: "#/parameters/rateId" - $ref: "#/parameters/priceCheckToken" responses: 200: $ref: "#/responses/RoomPriceCheck" 400: $ref: "#/responses/BadRequestInvalidInput400Error" 409: $ref: "#/responses/PriceChanged409" 410: $ref: "#/responses/PriceCheckSoldOut410Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" /properties/{property_id}/payment-options: get: description: | Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking. summary: Get Accepted Payment Types - EPS MOR Only tags: - Shopping parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/propertyId" - $ref: "#/parameters/token" - $ref: "#/parameters/user_agent" responses: 200: $ref: "#/responses/PaymentOptions" 400: $ref: '#/responses/BadRequestInvalidInput400Error' 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /properties/{property_id}/deposit-policies: get: description: | This link will be available in the shop response when rates require a deposit. It returns the amounts and dates for when any deposits are due. Deposit information is obtained by making a deposit-policies API call using this link. summary: Get Deposit Policy tags: - Shopping parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/depositPoliciesTestHeader" - $ref: "#/parameters/propertyId" - $ref: "#/parameters/token" responses: 200: $ref: "#/responses/DepositPolicies" 400: $ref: "#/responses/BadRequestInvalidInput400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /properties/{property_id}/recommendations: get: description: | Calculates recommended alternative properties based on the reference property id. Returns a sorted list of recommended properties; the first property in the response is the "strongest recommendation". For each property, rate and availability information is returned similar to the "Get property room rates and availability" call in the existing Rapid Shop API. summary: "Get recommendations" tags: - Recommendations parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/reference_property_id" - $ref: "#/parameters/recommendation_type" - $ref: "#/parameters/checkin" - $ref: "#/parameters/checkout" - $ref: "#/parameters/currency" - $ref: "#/parameters/language" - $ref: "#/parameters/country_code" - $ref: "#/parameters/occupancy" - $ref: "#/parameters/sales_channel" - $ref: "#/parameters/sales_environment" - $ref: "#/parameters/filter" - $ref: "#/parameters/rate_option" - $ref: "#/parameters/billing_terms" - $ref: "#/parameters/payment_terms" - $ref: "#/parameters/partner_point_of_sale" responses: 200: $ref: "#/responses/Recommendations" 400: $ref: "#/responses/Recommendations400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/Recommendations404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /itineraries: post: description: | This link will be available in the shop response after getting current price. It returns an itinerary id and links to retrieve reservation details, cancel the booking, or resume the booking (if a held booking is created). summary: "Create Booking" tags: - Booking consumes: - application/json parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/content_type" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/bookTestHeader" - $ref: "#/parameters/token" - $ref: "#/parameters/bookRequestBody" responses: 201: $ref: "#/responses/ItineraryCreationResponse" 400: $ref: "#/responses/BadRequestInvalidInput400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 426: $ref: "#/responses/Error426" 409: $ref: "#/responses/PriceMismatch409Error" 410: $ref: "#/responses/SoldOut410Error" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" get: description: | This can be called directly without a token when an affiliate reference id is provided. It returns details about a booking associated with the affiliate reference id along with cancel links to cancel the booking. 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. summary: "Retrieve Booking with Affiliate Reference Id" tags: - Manage Bookings parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/retrieveTestHeader" - $ref: "#/parameters/affiliateReferenceId" - $ref: "#/parameters/emailRequired" responses: 200: $ref: "#/responses/ItineraryRetrievalResponse" 400: $ref: "#/responses/RapidInvalidRequest400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/ItineraryNotFound404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /itineraries/{itinerary_id}: put: description: | This link will be available in the booking response after creating a held booking. summary: "Resume Booking" tags: - Booking parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/resumeTestHeader" - $ref: "#/parameters/itinerary_id" - $ref: "#/parameters/token" responses: 204: $ref: "#/responses/ResumeBooking" 202: $ref: "#/responses/ResumeBookingUnknown" 400: $ref: "#/responses/BadRequestInvalidInput400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/ItineraryNotFound404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" get: description: | 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/2.1/itineraries/8955599932111?token=QldfCGlcUA4GXVlSAQ4W * Using the email of the booking, example: https://api.ean.com/2.1/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. summary: "Retrieve Booking" tags: - Manage Bookings parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/retrieveTestHeader2" - $ref: "#/parameters/itinerary_id" - $ref: "#/parameters/retrieveToken" - $ref: "#/parameters/emailOptional" responses: 200: $ref: "#/responses/ItineraryRetrievalResponse" 400: $ref: "#/responses/RapidInvalidRequest400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/ItineraryNotFound404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" delete: description: | This link will be available in a held booking response. summary: "Cancel Held Booking" tags: - Manage Bookings parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/cancelTestHeader" - $ref: "#/parameters/itinerary_id" - $ref: "#/parameters/token" responses: 204: $ref: "#/responses/CancelBooking" 202: $ref: "#/responses/CancelBookingUnknown" 400: $ref: "#/responses/RapidInvalidRequest400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/ItineraryNotFound404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" /itineraries/{itinerary_id}/rooms/{room_id}: delete: description: | This link will be available in the booking response and in the retrieve response. summary: "Cancel a room." tags: - Manage Bookings parameters: - $ref: "#/parameters/accept" - $ref: "#/parameters/acceptEncoding" - $ref: "#/parameters/authorization" - $ref: "#/parameters/customerIp" - $ref: "#/parameters/customerSessionId" - $ref: "#/parameters/user_agent" - $ref: "#/parameters/cancelRoomTestHeader" - $ref: "#/parameters/itinerary_id" - $ref: "#/parameters/roomId" - $ref: "#/parameters/token" responses: 204: $ref: "#/responses/CancelRoom" 202: $ref: "#/responses/CancelRoomUnknown" 400: $ref: "#/responses/RapidInvalidRequest400Error" 401: $ref: "#/responses/Error401" 403: $ref: "#/responses/Error403" 404: $ref: "#/responses/ItineraryNotFound404Error" 426: $ref: "#/responses/Error426" 429: $ref: "#/responses/Error429" 500: $ref: "#/responses/Error500" 503: $ref: "#/responses/Error503" parameters: accept: in: header name: Accept description: | Specifies the response format that the client would like to receive back. This must be `application/json`. Example: `application/json` required: true type: string acceptEncoding: in: header name: Accept-Encoding description: | Specifies the response encoding that the client would like to receive back. This must be `gzip`. Example: `gzip` required: true type: string authorization: in: header name: Authorization description: "The custom generated authentication header. Refer to our [signature authentication](https://developer.expediapartnersolutions.com/reference/signature-authentication) page for full details." required: true type: string customerIp: in: header name: Customer-Ip description: | 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. required: true type: string customerSessionId: in: header name: Customer-Session-Id description: | Insert your own unique value for each user session, beginning with the first API call. Continue to pass the same value for each subsequent API call during the user's session, using a new value for every new customer session.
    Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it explicitly links together request paths for individual user's session. required: false type: string language: in: query name: language description: | Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit language and country codes. Use only ISO639-1 alpha 2 language codes and ISO3166-1 alpha 2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
    Example: `en-US` Language Options: [https://developer.expediapartnersolutions.com/reference/language-options/](https://developer.expediapartnersolutions.com/reference/language-options/) required: true type: string regionDescendantsId: in: path name: region_id description: | ID of the region to retrieve descendants for. The requested region is not included in the response. The Region ID for the world is 0. Refer to the list of [top level regions](https://developer.expediapartnersolutions.com/reference/region-types/top-level-regions). Example: `602962`. required: true type: string regionId: in: path name: region_id description: | ID of the region to retrieve. Example: `602962`. required: true type: string iataAirportCode: in: "path" name: "iata_airport_code" description: | 3-character IATA airport code of the airport to retrieve. The code must be upper case. Example: `ORD`. required: true type: "string" regionDescendantsInclude: in: "query" name: "include" description: | 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. Example: `details` Possible values: `standard`, `details`, `property_ids`, `property_ids_expanded` required: true type: array collectionFormat: multi items: type: string regionInclude: in: "query" name: "include" description: | 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. Example: `details` Possible values: `details`, `property_ids`, `property_ids_expanded` required: true type: array collectionFormat: multi items: type: string airportsInclude: in: query name: include description: | 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 associated region of the airport. * property_ids - Include the list of the property IDs within a 20km radius of the airport. * associated_region_property_ids - Include the list of property IDs within the polygon of the associated region. The associated region is the city or multi-city most commonly associated with the airport. Example: `details` Possible values: `details`, `property_ids`, `associated_region_property_ids`. required: true type: array collectionFormat: multi items: type: string propertyId: in: path name: property_id description: | Expedia Property ID.
    Example: `19248` required: true type: string roomId: name: room_id in: path required: true type: string description: | Room ID of a property.
    Example: `123abc`. rateId: name: rate_id in: path required: true type: string description: | Rate ID of a room.
    Example: `123abc` propertyIdQueryRequired: in: query name: property_id description: | The ID of the property you want to search for. You can provide 1 to 250 property_id parameters.
    Example: `property_id=19248&property_id=20321` required: true type: array collectionFormat: multi items: type: string propertyIdQuery: in: query name: property_id description: | The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. Example: `property_id=19248&property_id=20321` required: false type: array collectionFormat: multi items: type: string token: in: query name: token description: | 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. Example: `MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m` required: true type: string retrieveToken: in: query name: token description: | 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. Example: `MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m` required: false type: string priceCheckToken: name: token in: query required: true type: string description: Provided as part of the shop response. itinerary_id: in: path name: itinerary_id description: | This parameter is used only to prefix the token value - no ID value is used.
    Example: `8955599932111` required: true type: string affiliateReferenceId: name: affiliate_reference_id in: query required: true type: string description: | The affilliate reference id value. This field supports a maximum of 28 characters. Example: `111A222BB33344CC5555` emailRequired: name: email in: query required: true type: string description: | Email associated with the booking.
    Example: `test@example.com`. emailOptional: in: query name: email description: | Email associated with the booking. (Email is required if the token is not provided the request)
    Example: `test@example.com`. required: false type: string billing_terms: in: query name: billing_terms description: | This parameter is to specify the terms of how a resulting booking should be billed. If this field is needed, the value for this will be provided to you seperately by EPS.
    required: false type: string payment_terms: in: query name: payment_terms description: | This parameter is to specify what terms should be used when being paid for a resulting booking. If this field is needed, the value for this will be provided to you seperately by EPS.
    required: false type: string partner_point_of_sale: in: query name: partner_point_of_sale description: | This parameter is to specify what point of sale the partner wants shop/book under. If this field is needed, the value for this will be provided to you seperately by EPS. type: string reference_property_id: in: "path" name: "property_id" type: "string" required: true description: | Reference property to get alternative properties for. recommendation_type: in: "query" name: "recommendation_type" required: true type: "string" enum: - "relevance" description: | Requested recommendation type. `relevance` means similar properties. content_type: in: header name: Content-Type description: | This parameter is to specify what format the request body is in. The only supported value is application/json. Example: `application/json` required: true type: string user_agent: in: header name: User-Agent description: | The `User-Agent` header string from the customer's request, as captured by your integration. If you are building an application then the `User-Agent` value should be `{app name}/{app version}`. Example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36` Example: `TravelNow/3.30.112` required: true type: string availabilityTestHeader: name: Test in: header required: false type: string enum: - standard - service_unavailable - unknown_internal_error description: | Shop calls have a test header that can be used to return set responses with the following keywords:
    * `standard` * `service_unavailable` * `unknown_internal_error` priceCheckTestHeader: name: Test in: header required: false type: string enum: - matched - price_changed - sold_out - service_unavailable - unknown_internal_error description: | Price check calls have a test header that can be used to return set responses with the following keywords: * `matched` * `price_changed` * `sold_out` * `service_unavailable` * `unknown_internal_error` depositPoliciesTestHeader: name: Test in: header required: false type: string description: | Deposit policies calls have a test header that can be used to return set responses with the following keywords: * `all` * `night` * `amount` * `percent` * `remainder` * `service_unavailable` * `unknown_internal_error` enum: - all - night - amount - percent - remainder - service_unavailable - unknown_internal_error bookTestHeader: name: Test in: header required: false type: string enum: - standard - service_unavailable - internal_server_error - price_unavailable - price_mismatch - cc_declined - rooms_unavailable description: | 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` * `price_unavailable` * `price_mismatch` * `cc_declined` * `rooms_unavailable` retrieveTestHeader: name: Test in: header required: false type: string enum: - standard - service_unavailable - internal_server_error description: | 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` retrieveTestHeader2: name: Test in: header required: false type: string enum: - standard - service_unavailable - internal_server_error description: | 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` resumeTestHeader: name: Test in: header required: false type: string enum: - standard - service_unavailable - internal_server_error description: | 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` * `internal_server_error` cancelTestHeader: name: Test in: header required: false type: string enum: - standard - service_unavailable - internal_server_error - post_stay_cancel description: | 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` cancelRoomTestHeader: name: Test in: header required: false type: string enum: - standard - service_unavailable - unknown_internal_error - post_stay_cancel description: | 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` bookRequestBody: in: body name: Request description: "" schema: type: object required: - rooms - payments properties: affiliate_reference_id: description: "Your unique reference value. This field supports a maximum of 28 characters and is required to be unique (if provided)." type: string example: 4480 hold: description: "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." type: boolean example: false rooms: type: array items: type: object required: - given_name - family_name - email - phone - smoking - number_of_adults properties: title: description: "Honorific title of room guest." type: string enum: - Mr - Ms - Mrs - Miss - Master - Herr - Frau - Fraulein - Dr - Prof - Herr Dr - Frau Dr - Herr Prof - Frau Prof - M - Mme - Mlle - Mstr - Sig - Sig.ra - Sig.na - Dott example: Mr given_name: description: "First name of room guest." type: string example: "John" family_name: description: "Last name of room guest." type: string example: "Smith" email: description: "Email address of room guest. Must adhere to standard email format." type: string example: "john@example.com" phone: description: "Contact phone for the room guest, please do not include any special characters." type: string example: "4875550077" smoking: description: "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. Defaults to false." type: boolean example: false special_request: description: "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)." type: string example: "Top floor or away from street please" number_of_adults: description: "Total adult occupancy for the room. Use the same occupancy provided for the shop request made leading to this book request." type: number example: 2 child_ages: type: array items: type: number example: [4, 5] payments: type: array items: type: object required: - type - billing_contact properties: type: description: "Identifier for the type of payment. If affiliate_collect, cardholder information is not required as EPS will not be processing the payment." type: string enum: - "corporate_card" - "customer_card" - "virtual_card" - "affiliate_collect" example: "customer_card" card_type: description: "The type of credit card that is being used. Obtain possible values from the Payment Options call. Required for credit card transactions." type: string example: "VI" number: description: "Card number. Required for credit card transactions." type: string example: "4111111111111111" security_code: description: "CVV/CSV code from the back of the customer's card. Required for credit card transactions." type: string example: "123" expiration_month: description: "Two-digit month the credit card will expire. Required for credit card transactions." type: string example: "08" expiration_year: description: "Year the credit card will expire. Required for credit card transactions." type: string example: "2025" billing_contact: $ref: "#/definitions/BillingContact" affiliate_metadata: description: "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'." type: string example: "data_point_1:123|data_point2:This is data." required: true checkin: in: query name: checkin description: | Check-in date, in ISO 8601 format (YYYY-MM-DD)
    Example: `2018-09-15`. required: true type: string checkout: in: query name: checkout description: | 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. Example: `2018-09-17`. required: true type: string currency: in: query name: currency description: | Requested currency for the rates, in ISO 4217 format
    Example: `USD`.
    Currency Options: [https://developer.expediapartnersolutions.com/reference/currency-options/](https://developer.expediapartnersolutions.com/reference/currency-options/) required: true type: string country_code: in: query name: country_code description: | 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. Example: country_code=US For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) required: true type: string occupancy: in: query name: occupancy description: | 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` required: true type: array collectionFormat: multi items: type: string sales_channel: in: query name: sales_channel description: | 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 required: true type: string sales_environment: in: query name: sales_environment description: | 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. required: true type: string sort_type: in: query name: sort_type description: | Order properties should be returned in. If the requested sort type cannot be applied, the response will include a Warning header indicating the results are unsorted.
    * `preferred` - What we are paid impacts our sort order. required: true default: preferred type: string filter: in: query name: filter description: | 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. required: false type: array collectionFormat: multi items: type: string include: in: query name: include type: string description: | Request additional data for each property. Accepted values:
    * `all_rates` - Return all room types for each property. required: false rate_option: in: query name: rate_option type: array collectionFormat: multi items: type: string description: | Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. Accepted values:
    * `closed_user_group` - Return closed user group 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. required: false definitions: PropertyContentMap: type: object additionalProperties: $ref: "#/definitions/PropertyContent" PropertyContent: type: object description: An indivdual property object in the map of property objects. properties: property_id: type: string description: Unique Expedia property ID. name: type: string description: Property name. address: type: object description: Container for the property's address information. properties: line_1: type: string description: Address line 1. line_2: type: string description: Address line 2. city: type: string description: City. state_province_code: type: string description: 2-letter code used for Australia, Canada and the USA. state_province_name: type: string description: Text name of the State/Province - more common for additional countries. postal_code: type: string description: Postal/zip code. country_code: type: string description: 2-letter country code, in ISO 3166-1 alpha-2 format. ratings: type: object description: Information about the property’s rating. properties: property: type: object description: Rating information for the property. properties: rating: type: string description: Star Rating (0-5) for the property. A value of 0.0 or a blank value indicate none is available. type: type: string description: Returns a value of either "Star" or "Alternate". Star indicates the rating is provided by the hotel's local star rating authority. Alternate indicates that the rating is an Expedia-assigned value; an official rating was not available. Points of sale in Australia must differentiate visually between these two different rating types on consumer-facing websites. tripadvisor: type: object description: Effective November 6th, Expedia Group no longer maintains a relationship with TripAdvisor, and will no longer be providing TripAdvisor content. properties: rating: type: string description: TripAdvisor rating for the property. Returns a value between 0.0 and 5.0. count: type: number description: Number of TripAdvisor guest reviews for the property. links: type: object description: Link to the TripAdvisor rating image. Display of the rating image is required per TripAdvisor’s contract. additionalProperties: $ref: "#/definitions/Link" location: type: object description: The property's location information. properties: coordinates: type: object description: The coordinates of the property. properties: latitude: type: number longitude: type: number phone: type: string description: The property's phone number. fax: type: string description: The property's fax number. category: type: object description: The property's category. See our [property categories reference](https://developer.expediapartnersolutions.com/reference/property-categories) for current known category ID and name values. properties: id: type: number description: The ID of the property's category. name: type: string description: The property's category. business_model: type: object description: How and when the payment can be taken. properties: expedia_collect: type: boolean description: Whether or not a payment for this property can be taken by Expedia at the time of booking. property_collect: type: boolean description: Whether or not a payment for this property can be taken by the property upon arrival. rank: type: number description: The property's rank. This value sorts properties based on EPS transactional data from the last 30 days, with 1 indicating the best-performing hotel and others following in ascending numerical order. checkin: type: object description: The property's check-in information. properties: begin_time: type: string description: The time at which a property begins to allow check-ins. end_time: type: string description: The time at which a property stops allowing check-ins. instructions: type: string description: The property's check-in policy. special_instructions: type: string description: Any special instructions for checking into this property that may be specific to this property. min_age: type: string description: The minimum age for a customer to be able to check-in at a property. checkout: type: object description: The property's check-out information. properties: time: type: string description: The time by which a guest must check out. fees: type: object description: Information related to a property's fees. properties: mandatory: type: string description: Describes resort fees and other mandatory taxes or charges. May describe which services are covered by any fees, such as fitness centers or internet access. optional: type: string description: Describes additional optional fees for items such as breakfast, wifi, parking, pets etc. policies: type: object description: Information about property policies that guests need to be aware of. properties: know_before_you_go: type: string description: Description of information that may be helpful when planning a trip to this property. attributes: type: object description: Attributes about the property. properties: general: type: object description: Lists all of the general attributes about the property. additionalProperties: $ref: "#/definitions/Attribute" pets: type: object description: Lists all of the pet attributes about the property. additionalProperties: $ref: "#/definitions/Attribute" amenities: type: object description: Lists all of the amenities available for all guests at the property. See our [amenities reference](https://developer.expediapartnersolutions.com/reference/amenities) for current known amenity ID and name values. additionalProperties: $ref: "#/definitions/Amenity" images: type: array description: Contains all property images available. items: type: object description: An individual image. See our [image categories reference](https://developer.expediapartnersolutions.com/reference/image-categories) for current known caption and category values. properties: caption: type: string description: Image caption. hero_image: type: boolean description: Whether this image is a hero image or not. category: type: number description: The category of the image. links: type: object description: 'Contains urls for all of the image sizes available. Sizes include: 70 px, 350 px, and 1,000 px' additionalProperties: $ref: "#/definitions/Link" onsite_payments: type: object description: The property's accepted forms of payments when onsite. properties: currency: type: string description: The currency accepted at the property. types: type: object description: The types of payments accepted at the property. additionalProperties: $ref: "#/definitions/PaymentType" rooms: type: object description: Information about all of the rooms at the property. additionalProperties: $ref: "#/definitions/RoomContent" rates: type: object description: Additional content about the rates which the hotel offers. This should be used in conjunction with the pricing and other rate-related information used in shopping. additionalProperties: $ref: "#/definitions/RateContent" dates: type: object description: Dates about the property. properties: added: type: string description: The date the property's content was added to EPS, in ISO 8601 format. updated: type: string description: The date the property's content was updated by EPS, in ISO 8601 format. descriptions: type: object description: Descriptions of a property. properties: amenities: type: string description: Describes general building amenities at the property. dining: type: string description: Describes dining accommodations at the property. renovations: type: string description: Describes any recent room or property renovations. national_ratings: type: string description: States the source of the property's star rating (such as a regional or national tourism agency) and any other ratings claimed. business_amenities: type: string description: Describes any business-specific amenities at the property, e.g. conference rooms. rooms: type: string description: Describes typical room amenities. attractions: type: string description: Nearby attractions/areas, often including distances from the property. location: type: string description: General location as entered by the property. airports: type: object description: Airports related to the property. properties: preferred: type: object description: The preferred airport of the property. properties: iata_airport_code: type: string description: The airport's IATA code. distance: type: object description: Information about how far away the airport is from the property. properties: value: type: number description: The distance away from the property the airport is. unit: type: string description: The type of units that the distance value is in. registry_number: type: string description: The property's registry number required by some jurisdictions. Error: type: object description: The overall class of error that occured. properties: type: description: The error type. type: string message: description: A human readable message giving details about this error. type: string fields: type: array description: Details about the specific fields that had an error. items: type: object description: An individual field that had an error. properties: name: type: string description: The field that had an error. type: type: string description: The type of the field that had an error. value: type: string description: The value of the field that had an error. errors: type: array description: An array of all the actual errors that occured. items: type: object description: An individual error. properties: type: type: string description: The error type. message: type: string description: A human readable message giving details about this error. fields: type: array description: Details about the specific fields that had an error. items: type: object description: An individual field that had an error. properties: name: type: string description: The field that had an error. type: type: string description: The type of the field that had an error. value: type: string description: The value of the field that had an error. RegionDescendants: type: object description: A map of region types to region ids. additionalProperties: type: object description: A map of region ids to regions. additionalProperties: $ref: "#/definitions/Region" Region: type: object properties: id: type: string description: Region Id. type: type: string description: Region type. name: type: string description: Region name. name_full: type: string description: Full region name. country_code: type: string description: Region country code (ISO-3166 ALPHA-2). coordinates: type: object properties: center_longitude: type: number description: Center Longitude. center_latitude: type: number description: Center Latitude. bounding_polygon: type: object properties: type: type: string description: Type of bounding polygon. coordinates: type: array description: An array of multiple polygon(s) that combine to make a full MultiPolygon in geojson format. items: type: array description: An array of polygon(s) that combine to make up a single Polygon in geojson format. If there is more than one polygon at this level, the first is the outer boundary and the remaining polygons are interior rings or holes. items: type: array description: An array of Points making up single polygon in geojson format. items: type: array description: Individual coordinates as a geojson Point, in longitude, latitude order (x,y). items: type: number ancestors: type: array description: An array of the region's ancestors. items: type: object description: A region ancestor. properties: id: description: Id of ancestor region. type: string type: description: Region type of ancestor region. type: string descendants: type: object description: A map of the region types that contain direct descendants of the region. additionalProperties: type: array description: An array of region ids associated with the region type. items: type: string property_ids: type: array description: An array of associated property ids for the region. items: type: string property_ids_expanded: type: array description: An array of associated property ids within an expanded radius for the region. items: type: string Airports: type: object description: A map of airport IATA codes to airports. additionalProperties: $ref: "#/definitions/Airport" Airport: type: object properties: iata_airport_code: type: string description: 3-character IATA airport code. name: type: string description: Airport name. name_full: type: string description: Full airport name. country_code: type: string description: Airport’s country code (ISO-3166 ALPHA-2). coordinates: properties: center_longitude: type: number description: Center longitude. center_latitude: type: number description: Center latitude. property_ids: type: array description: An array of property ids within a 20 km radius of the airport. items: type: string associated_region: description: City or multi-city typically associated with the airport. properties: id: type: string description: Region Id of the city or multi-city typically associated with the airport. type: type: string description: Region type of the associated region. name: type: string description: Region name of the associated region. name_full: type: string description: Full region name of the associated region. property_ids: type: array description: An array of property ids within the polygon of the associated region. items: type: string PropertyAvailability: type: object description: The rooms and rates for a property. properties: property_id: description: Expedia property ID. example: 19248 type: string rooms: description: Array of objects containing room information. type: array items: type: object description: The room information. properties: id: description: Unique Identifier for a room type. example: 123abc type: string room_name: description: Name of the room type. example: Fancy Queen Room type: string rates: description: Array of objects containing rate information. type: array items: type: object properties: id: description: Unique Identifier for a rate. example: 333abc type: string available_rooms: description: >- 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. example: 12 type: number refundable: description: 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. type: boolean fenced_deal: description: >- Indicates that a "Member Only Deal" discount has been applied to the rate. Partners must be enabled to receive "Member Only Deals" to benefit from this parameter. 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 partners to drive loyalty. In addition, it can be used by OTA's to create an opaque but public shopping experience. These deals are expected to be messaged with the specific traveler program naming. type: boolean deposit_required: description: If a deposit is required for the rate, this value will be `true`. A "deposit_policies" link will be included in this response to retrieve more information about the deposit, including amounts and timing. type: boolean merchant_of_record: description: | * `expedia` - Payment is taken by Expedia. The payment options avaliable can be discovered using the "payment-options" link in the response. This includes AFFILIATE_COLLECT payments. * `property` - Payment is taken by the property. example: expedia type: string enum: - expedia - property amenities: description: Room amenities. type: array items: type: object properties: id: type: string example: 1234 description: Unique identifier for the rate amenity. name: type: string example: Free Wireless Internet description: The name describing the amenity included in the rate. links: type: object properties: payment_options: type: object description: The link to request payment options. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: GET type: string href: description: | The relative URI for the specified method. example: /2.1/properties/19248/payment-options?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href deposit_policies: type: object description: The link to request deposit policies. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: GET type: string href: description: | The relative URI for the specified method. example: /2.1/properties/19248/deposit-policies?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href required: - payment_options bed_groups: type: array items: type: object properties: links: type: object properties: price_check: type: object properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: GET type: string href: description: | The link to request updated pricing and availability for a selected rate. example: /2.1/properties/availability/19248/rooms/abc123/rates/abc123/price-check?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href configuration: type: array description: 'The bed configuration for a given room. This array can be empty for the related bed group.' items: type: object properties: type: description: The type of bed. example: Bed type: string size: description: The size of the bed. example: Queen type: string quantity: description: The number of bed(s). example: 1 type: number cancel_penalties: description: Array of `cancel_penalty` objects containing cancel penalty information. Will not be populated on non refundable. type: array items: type: object properties: currency: description: Currency of the amount object. example: USD type: string start: description: Effective date and time of cancellation penalty in extended ISO 8601 format, with ±hh:mm timezone offset example: '2018-02-12T11:59:00.000-08:00' type: string end: description: End date and time of cancellation penalty in extended ISO 8601 format, with ±hh:mm timezone offset example: '2018-02-12T11:59:00.000-08:00' type: string amount: description: The monetary amount of the penalty. example: "10.00" type: string nights: description: Number of nights charged for as penalty. example: 1 type: string percent: description: Percentage of total booking charged for as penalty. A thirty percent penalty would be returned as 0.3 example: "0.3" type: string required: - currency occupancies: $ref: '#/definitions/RoomRates' promo_id: description: Unique identifier for the promotional rate. example: 999abc type: string promo_description: description: The description for the promotional rate. example: Book early and save 15% type: string required: - id - available_rooms - refundable - fenced_deal - deposit_required - merchant_of_record - links - occupancies required: - id - rates links: type: object properties: additional_rates: type: object properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: GET type: string href: description: The relative URI for the specified method. example: /2.1/properties/availability/12345?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href required: - property_id - rooms RoomPriceCheck: type: object description: The price check response. required: - status - occupancies - links properties: status: example: matched description: Indicates matched when there is a price match with the shop response. type: string enum: - matched - price_changed - sold_out occupancies: $ref: '#/definitions/RoomRates' links: type: object description: The links associated with this response. properties: book: type: object description: The link which creates a booking. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: POST type: string href: description: The relative URI for the specified method. example: /2.1/itinerary?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href shop: type: object description: The link which takes partner back to shopping. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: GET type: string href: description: The relative URI for the specified method. example: /2.1/properties/availability/1234?token=REhZAQsABAMGQggMV1pFAV1YVA5cZhBYEgNKH1RGEVEQUAoOBwlVVBlVCEkFUxVZWgZAFAVbABgMC0RXRx= type: string required: - method - href RoomRates: type: object description: A map of room information by occupancy. additionalProperties: $ref: '#/definitions/RoomRate' RoomRate: type: object description: A map of room information by occupancy. properties: nightly: description: Array of arrays of amount objects. Each sub-array of amount objects represents a single night's charges type: array items: type: array items: type: object properties: type: description: The price breakout type. example: base_rate type: string enum: - 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 "Tax Recovery Charges and Service 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.
    - compensation
    - 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. If the nightly rate (base_rate) is displayed, then subtract this amount from that value. value: description: The value of the amount object. Decimal point inline with correct precision. example: "90.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - type - value - currency stay: description: 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. type: array items: type: object properties: type: example: base_rate description: The price breakout type. type: string enum: - base_rate - tax_and_service_fee - extra_person_fee - compensation - property_fee - sales_tax - adjustment value: description: The value of the amount object. Decimal point inline with correct precision. example: "90.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - type - value - currency totals: type: object properties: inclusive: description: | Provides the total price including taxes and fees. This does not include hotel collected fees such as resort, mandatory taxes, and mandatory fees. type: object properties: billable_currency: type: object description: The amount in the billable currency. properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency request_currency: type: object description: The amount in the requested currency. properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency exclusive: type: object description: Provides the total price excluding taxes and fees. properties: billable_currency: type: object description: The amount in the billable currency. properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency request_currency: type: object description: The amount in the requested currency. properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency strikethrough: type: object description: Provides the tax exclusive total price with any hotel funded discounts added back. Can be used to merchandise the savings due to a discount. properties: billable_currency: description: The amount in the billable currency. type: object properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency request_currency: description: The amount in the requested currency. type: object properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency marketing_fee: type: object description: Provides the potential owed earnings per transaction. properties: billable_currency: description: The amount in the billable currency. type: object properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency request_currency: description: The amount in the requested currency. type: object properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency minimum_selling_price: type: object description: Provides the minimum selling price. properties: billable_currency: description: The amount in the billable currency. type: object properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency request_currency: description: The amount in the requested currency. type: object properties: value: description: The value of the amount object. Decimal point inline with correct precision. example: "215.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - value - currency required: - inclusive - exclusive fees: description: Array of amount objects. Represents all the fees of this stay. type: array items: type: object properties: type: example: mandatory_fee type: string description: The fee or tax type. enum: - mandatory_fee - resort_fee - mandatory_tax value: description: The value of the amount object. Decimal point inline with correct precision. example: "10.00" type: string currency: description: Currency of the amount object. example: USD type: string required: - type - value - currency required: - nightly - stay - totals PaymentOption: type: object description: The payment option response. properties: affiliate_collect: type: object properties: name: description: Display name of payment option. type: string credit_card: type: object properties: card_options: type: array items: type: object properties: name: description: Display name of accepted payment card. type: string card_type: description: Two-letter code used in credit card bookings to indicate card type. Include the same value in your booking request. Do not map this value - always use the code from a live response. It is normal for some codes to appear for more than one card or mismatch against the provided card name. type: string processing_country: description: The country in which the payment will be processed. type: string required: - name - card_type name: description: Display name of payment option. type: string required: - card_options DepositPolicy: type: object description: | The deposit policy response. Each payment will have one and only one of the fields named: night, remainder, amount or percent. Each payment will also have one and only one due field. example: [ { "night": 3, "due": "2025-02-20" }, { "amount": "70.00", "due": "2025-12-21" }, { "percent": 90, "due": "2025-02-19" }, { "remainder": true, "due": "2025-03-01" } ] properties: night: description: The number of nights that must be paid for as a deposit. example: 3 type: number format: double remainder: description: The full remaining balance must be paid as a deposit. type: boolean amount: description: The specific dollar amount that must be paid as a deposit. type: string percent: description: The percent of the total that must be paid as a deposit. Twenty percent would be sent back as 20. type: number format: double due: description: Due date, in ISO 8601 format example: '2017-02-27' type: string required: - due BillingContact: type: object required: - given_name - family_name - email - phone - address properties: given_name: description: "First/given name of the payment type account holder." type: string example: "John" family_name: description: "Last/family name of the payment type account holder." type: string example: "Smith" email: description: "Email of the payment type account holder. Must adhere to standard email format." type: string example: "smith@example.com" phone: description: "Contact phone for the payment type account holder, please do not include any special characters." type: string example: "4875550077" address: type: object required: - line_1 - city - country_code properties: line_1: description: "First line of customer's street address" type: string example: "555 1st St" line_2: description: "Second line of customer's street address" type: string example: "10th Floor" line_3: description: "Third line of customer's street address" type: string example: "Unit 12" city: description: "Customer's city" type: string example: "Seattle" state_province_code: description: "Customer's state or province code" type: string example: "WA" postal_code: description: "Customer's postal code" type: string example: "98121" country_code: description: "Customer's country code, in two-letter ISO 3166-1 alpha-2 format" type: string example: "US" Amenity: type: object description: An individual amenity. properties: id: type: number description: Numeric identifier for the amenity. name: type: string description: Amenity name. Attribute: type: object description: An individual attribute. properties: id: type: number description: Numeric identifier for the attribute. name: type: string description: Attribute name. BedGroup: type: object description: An individual bed group. properties: id: type: string description: Unique identifier for a bed group. description: type: string description: This is a display ready description of a bed configuration for this room. configuration: type: array description: An array of bed configurations for this room. items: type: object description: An individual bed configuration. properties: type: type: string description: The type of this bed configuration in the room. size: type: string description: The size of this bed configuration in the room. quantity: type: number description: The number of this bed configuration in the room. PaymentType: type: object description: An individual payment type. properties: id: type: number description: The identifier of the payment type. name: type: string description: The name of the payment type. Link: type: object description: An individual link. properties: method: type: string description: Request method used to access the link. href: type: string description: Absolute URL. RateContent: type: object description: An individual rate. properties: id: type: string description: Unique identifier for a rate. amenities: type: object description: This lists all of the Amenities available with a specific rate, including value adds, such as breakfast. See our [amenities reference](https://developer.expediapartnersolutions.com/reference/amenities) for current known amenity ID and name values. additionalProperties: $ref: "#/definitions/Amenity" RoomContent: type: object description: An individual room. properties: id: type: string description: Unique identifier for a room type. name: type: string description: Room type name. descriptions: type: object description: Descriptions of a room. properties: overview: type: string description: Provides an overview of a room. amenities: type: object description: Lists all of the amenities available in the room. See our [amenities reference](https://developer.expediapartnersolutions.com/reference/amenities) for current known amenity ID and name values. additionalProperties: $ref: "#/definitions/Amenity" images: type: array description: The room's images. Contains all room images available. items: type: object description: An individual image. See our [image categories reference](https://developer.expediapartnersolutions.com/reference/image-categories) for current known category values. properties: hero_image: type: boolean description: Whether this image is a hero image or not. category: type: number description: The category of the image. links: type: object description: 'Contains urls for all of the image sizes available. Sizes include: 70 px, 200px, 350 px, and 1,000 px' additionalProperties: $ref: "#/definitions/Link" bed_groups: type: object description: A map of the room's bed groups. additionalProperties: $ref: "#/definitions/BedGroup" responses: PropertyAvailability: description: 'OK' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: type: array items: $ref: '#/definitions/PropertyAvailability' PropertyContent: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/PropertyContentMap" examples: Single Property Example: 12345: property_id: '12345' name: Test Property Name address: line_1: 123 Main St line_2: Apt A city: Springfield state_province_code: MO state_province_name: Missouri postal_code: '65804' country_code: US ratings: property: rating: '3.5' type: Star tripadvisor: rating: '4.5' count: 16 links: rating_image: method: GET href: http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png 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: begin_time: 3:00 PM end_time: 11:00 PM instructions: Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br /> special_instructions: There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation. min_age: '18' checkout: time: 11:00 AM fees: mandatory: '

    You''ll be asked to pay the following charges at the hotel:

    The hotel resort fee includes:

    We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.

    ' optional: 'Fee for in-room wireless Internet: USD 15 per hour (rates may vary)
  • Airport shuttle fee: USD 350 per vehicle (one way)
  • Rollaway bed fee: USD 175 per night
  • ' policies: know_before_you_go: 'Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation.
  • Children 11 years old and younger stay free when occupying the parent or guardian''s room, using existing bedding.
  • Only registered guests are allowed in the guestrooms.
  • Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
  • ' attributes: general: '3357': id: 3357 name: Caters to adults only '2549': id: 2549 name: No elevators pets: '51': id: 51 name: Pets allowed '2809': id: 2809 name: Dogs only amenities: '1234': id: 1234 name: Test Amenity images: - caption: Featured Image hero_image: true category: 3 links: 70px: method: GET href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg onsite_payments: currency: USD types: '171': id: 171 name: American Express rooms: '224829': id: '224829' name: Single Room descriptions: overview: '2 Twin Beds
    269-sq-foot (25-sq-meter) room with mountain views

    Internet - Free WiFi
    Entertainment - Flat-screen TV with cable channels
    Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
    Sleep - Premium bedding
    Bathroom - Private bathroom, shower, bathrobes, and free toiletries
    Practical - Safe and desk; cribs/infant beds available on request
    Comfort - Climate-controlled air conditioning and daily housekeeping
    Non-Smoking
    ' amenities: '1234': id: 1234 name: Test Amenity images: - hero_image: true category: 21001 links: 70px: method: GET href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg bed_groups: 5fe010529211bd68e8056ea6b8852f648027621e: id: 5fe010529211bd68e8056ea6b8852f648027621e description: 1 King Bed configuration: - type: KingBed size: King quantity: 1 rates: 333abc: id: 333abc amenities: '1234': id: 1234 name: Test Amenity dates: added: '1998-07-19T05:00:00.000Z' updated: '2018-03-22T07:23:14.000Z' descriptions: amenities: Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room. dining: Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee. renovations: 'During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ' national_ratings: For the benefit of our customers, we have provided a rating based on our rating system. business_amenities: Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite. rooms: Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks. attractions: 'Distances are calculated in a straight line from the property''s location to the point of interest or attraction, and may not reflect actual travel distance.

    Distances are displayed to the nearest 0.1 mile and kilometer.

    Sogo Department Store - 0.7 km / 0.4 mi
    National Museum of Natural Science - 1.1 km / 0.7 mi
    Shr-Hwa International Tower - 1.4 km / 0.8 mi
    Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
    Taichung Metropolitan Opera House - 1.7 km / 1 mi
    Tiger City Mall - 1.8 km / 1.1 mi
    Maple Garden Park - 1.9 km / 1.2 mi
    National Museum of Fine Arts - 2.1 km / 1.3 mi
    Feng Chia University - 2.4 km / 1.5 mi
    Bao An Temple - 2.5 km / 1.6 mi
    Fengjia Night Market - 2.5 km / 1.6 mi
    Zhonghua Night Market - 2.7 km / 1.7 mi
    Chonglun Park - 2.9 km / 1.8 mi
    Wan He Temple - 2.9 km / 1.8 mi
    Chungyo Department Store - 3.1 km / 1.9 mi

    The nearest airports are:
    Taichung (RMQ) - 12 km / 7.5 mi
    Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
    Taipei (TSA-Songshan) - 135.5 km / 84.2 mi

    ' location: This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science. airports: preferred: iata_airport_code: "SGF" distance: value: 4.9 unit: "km" registry_number: 1350K014A0088300 Multiple Properties Example: 12345: property_id: '12345' name: Test Property Name address: line_1: 123 Main St line_2: Apt A city: Springfield state_province_code: MO state_province_name: Missouri postal_code: '65804' country_code: US ratings: property: rating: '3.5' type: Star tripadvisor: rating: '4.5' count: 16 links: rating_image: method: GET href: http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png 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: begin_time: 3:00 PM end_time: 11:00 PM instructions: Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br /> special_instructions: There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation. min_age: '18' checkout: time: 11:00 AM fees: mandatory: '

    You''ll be asked to pay the following charges at the hotel:

    The hotel resort fee includes:

    We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.

    ' optional: 'Fee for in-room wireless Internet: USD 15 per hour (rates may vary)
  • Airport shuttle fee: USD 350 per vehicle (one way)
  • Rollaway bed fee: USD 175 per night
  • ' policies: know_before_you_go: 'Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation.
  • Children 11 years old and younger stay free when occupying the parent or guardian''s room, using existing bedding.
  • Only registered guests are allowed in the guestrooms.
  • Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
  • ' attributes: general: '3357': id: 3357 name: Caters to adults only '2549': id: 2549 name: No elevators pets: '51': id: 51 name: Pets allowed '2809': id: 2809 name: Dogs only amenities: '1234': id: 1234 name: Test Amenity images: - caption: Featured Image hero_image: true category: 3 links: 70px: method: GET href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg onsite_payments: currency: USD types: '171': id: 171 name: American Express rooms: '224829': id: '224829' name: Single Room descriptions: overview: '2 Twin Beds
    269-sq-foot (25-sq-meter) room with mountain views

    Internet - Free WiFi
    Entertainment - Flat-screen TV with cable channels
    Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
    Sleep - Premium bedding
    Bathroom - Private bathroom, shower, bathrobes, and free toiletries
    Practical - Safe and desk; cribs/infant beds available on request
    Comfort - Climate-controlled air conditioning and daily housekeeping
    Non-Smoking
    ' amenities: '1234': id: 1234 name: Test Amenity images: - hero_image: true category: 21001 links: 70px: method: GET href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg bed_groups: 5fe010529211bd68e8056ea6b8852f648027621e: id: 5fe010529211bd68e8056ea6b8852f648027621e description: 1 King Bed configuration: - type: KingBed size: King quantity: 1 rates: 333abc: id: 333abc amenities: '1234': id: 1234 name: Test Amenity dates: added: '1998-07-19T05:00:00.000Z' updated: '2018-03-22T07:23:14.000Z' descriptions: amenities: Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room. dining: Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee. renovations: 'During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ' national_ratings: For the benefit of our customers, we have provided a rating based on our rating system. business_amenities: Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite. rooms: Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks. attractions: 'Distances are calculated in a straight line from the property''s location to the point of interest or attraction, and may not reflect actual travel distance.

    Distances are displayed to the nearest 0.1 mile and kilometer.

    Sogo Department Store - 0.7 km / 0.4 mi
    National Museum of Natural Science - 1.1 km / 0.7 mi
    Shr-Hwa International Tower - 1.4 km / 0.8 mi
    Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
    Taichung Metropolitan Opera House - 1.7 km / 1 mi
    Tiger City Mall - 1.8 km / 1.1 mi
    Maple Garden Park - 1.9 km / 1.2 mi
    National Museum of Fine Arts - 2.1 km / 1.3 mi
    Feng Chia University - 2.4 km / 1.5 mi
    Bao An Temple - 2.5 km / 1.6 mi
    Fengjia Night Market - 2.5 km / 1.6 mi
    Zhonghua Night Market - 2.7 km / 1.7 mi
    Chonglun Park - 2.9 km / 1.8 mi
    Wan He Temple - 2.9 km / 1.8 mi
    Chungyo Department Store - 3.1 km / 1.9 mi

    The nearest airports are:
    Taichung (RMQ) - 12 km / 7.5 mi
    Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
    Taipei (TSA-Songshan) - 135.5 km / 84.2 mi

    ' location: This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science. airports: preferred: iata_airport_code: "SGF" distance: value: 4.9 unit: "km" registry_number: 1350K014A0088300 67890: property_id: '67890' name: Test Property Name 2 address: line_1: 123 Main St line_2: Apt A city: Springfield state_province_code: MO state_province_name: Missouri postal_code: '65804' country_code: US ratings: property: rating: '3.5' type: Star tripadvisor: rating: '4.5' count: 16 links: rating_image: method: GET href: http://www.tripadvisor.com/img/cdsi/img2/ratings/traveler/4.0-39958-4.png 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 checkin: begin_time: 3:00 PM end_time: 11:00 PM instructions: Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br /> special_instructions: There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation. min_age: '18' checkout: time: 11:00 AM fees: mandatory: '

    You''ll be asked to pay the following charges at the hotel:

    The hotel resort fee includes:

    We have included all charges provided to us by the property. However, charges can vary, for example, based on length of stay or the room you book.

    ' optional: 'Fee for in-room wireless Internet: USD 15 per hour (rates may vary)
  • Airport shuttle fee: USD 350 per vehicle (one way)
  • Rollaway bed fee: USD 175 per night
  • ' policies: know_before_you_go: 'Reservations are required for massage services and spa treatments. Reservations can be made by contacting the hotel prior to arrival, using the contact information on the booking confirmation.
  • Children 11 years old and younger stay free when occupying the parent or guardian''s room, using existing bedding.
  • Only registered guests are allowed in the guestrooms.
  • Some facilities may have restricted access. Guests can contact the property for details using the contact information on the booking confirmation.
  • ' attributes: general: '3357': id: 3357 name: Caters to adults only '2549': id: 2549 name: No elevators pets: '51': id: 51 name: Pets allowed '2809': id: 2809 name: Dogs only amenities: '1234': id: 1234 name: Test Amenity images: - caption: Featured Image hero_image: true category: 3 links: 70px: method: GET href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg onsite_payments: currency: USD types: '171': id: 171 name: American Express rooms: '224829': id: '224829' name: Single Room descriptions: overview: '2 Twin Beds
    269-sq-foot (25-sq-meter) room with mountain views

    Internet - Free WiFi
    Entertainment - Flat-screen TV with cable channels
    Food & Drink - Refrigerator, coffee/tea maker, room service, and free bottled water
    Sleep - Premium bedding
    Bathroom - Private bathroom, shower, bathrobes, and free toiletries
    Practical - Safe and desk; cribs/infant beds available on request
    Comfort - Climate-controlled air conditioning and daily housekeeping
    Non-Smoking
    ' amenities: '1234': id: 1234 name: Test Amenity images: - hero_image: true category: 21001 links: 70px: method: GET href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg bed_groups: 5fe010529211bd68e8056ea6b8852f648027621e: id: 5fe010529211bd68e8056ea6b8852f648027621e description: 1 King Bed configuration: - type: KingBed size: King quantity: 1 rates: 333abc: id: 333abc amenities: '1234': id: 1234 name: Test Amenity dates: added: '1998-07-20T05:00:00.000Z' updated: '2018-03-22T13:33:17.000Z' descriptions: amenities: Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room. dining: Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee. renovations: 'During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ' national_ratings: For the benefit of our customers, we have provided a rating based on our rating system. business_amenities: Featured amenities include complimentary wired Internet access, a 24-hour business center, and limo/town car service. Event facilities at this hotel consist of a conference center and meeting rooms. Free self parking is available onsite. rooms: Make yourself at home in one of the 334 air-conditioned rooms featuring LCD televisions. Complimentary wired and wireless Internet access keeps you connected, and satellite programming provides entertainment. Private bathrooms with separate bathtubs and showers feature deep soaking bathtubs and complimentary toiletries. Conveniences include phones, as well as safes and desks. attractions: 'Distances are calculated in a straight line from the property''s location to the point of interest or attraction, and may not reflect actual travel distance.

    Distances are displayed to the nearest 0.1 mile and kilometer.

    Sogo Department Store - 0.7 km / 0.4 mi
    National Museum of Natural Science - 1.1 km / 0.7 mi
    Shr-Hwa International Tower - 1.4 km / 0.8 mi
    Shinkong Mitsukoshi Department Store - 1.5 km / 0.9 mi
    Taichung Metropolitan Opera House - 1.7 km / 1 mi
    Tiger City Mall - 1.8 km / 1.1 mi
    Maple Garden Park - 1.9 km / 1.2 mi
    National Museum of Fine Arts - 2.1 km / 1.3 mi
    Feng Chia University - 2.4 km / 1.5 mi
    Bao An Temple - 2.5 km / 1.6 mi
    Fengjia Night Market - 2.5 km / 1.6 mi
    Zhonghua Night Market - 2.7 km / 1.7 mi
    Chonglun Park - 2.9 km / 1.8 mi
    Wan He Temple - 2.9 km / 1.8 mi
    Chungyo Department Store - 3.1 km / 1.9 mi

    The nearest airports are:
    Taichung (RMQ) - 12 km / 7.5 mi
    Taipei (TPE-Taoyuan Intl.) - 118.3 km / 73.5 mi
    Taipei (TSA-Songshan) - 135.5 km / 84.2 mi

    ' location: This 4-star hotel is within close proximity of Shr-Hwa International Tower and Shinkong Mitsukoshi Department Store. A stay at Tempus Hotel Taichung places you in the heart of Taichung, convenient to Sogo Department Store and National Museum of Natural Science. airports: preferred: iata_airport_code: "SGF" distance: value: 7.3 unit: "km" registry_number: 2350K014A089723 Recommendations400Error: description: Invalid Input schema: $ref: "#/definitions/Error" examples: Recommendation type not provided: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: recommendation_type.required message: 'Recommendation Type is required. Accepted recommendation_type are: [relevance].' fields: - name: recommendation_type type: querystring Recommendation type not supported: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: recommendation_type.invalid message: 'Recommendation Type is invalid. Accepted recommendation_type are: [relevance].' fields: - name: recommendation_type type: querystring, value: "XX" Multiple Errors: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: language.invalid_language_format message: 'Language is invalid. It must be formatted in ISO639-1 alpha 2 language codes and ISO3166-1 alpha 2 country codes format. See https://www.w3.org/International/articles/language-tags/.' fields: - name: language type: querystring value: xx_XX - type: recommendation_type.invalid message: 'Recommendation Type is invalid. Accepted recommendation_type values are: [relevance].' fields: - name: recommendation_type type: querystring value: "XX" headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. Recommendations404Error: description: Not found schema: $ref: "#/definitions/Error" examples: Recommendations not found: type: recommendations.not_found message: No recommendations found. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. PropertyContent400Error: description: Invalid Input headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: language.required message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]' fields: - name: language type: querystring - type: language.above_maximum message: The number of languages passed in must not be greater than 1. fields: - name: language type: querystring - type: language.not_supported message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]' fields: - name: language type: querystring value: xXX - type: property_id.required message: At least one property_id is required. fields: - name: property_id type: querystring - type: property_id.must_be_numeric message: All provided property_id query parameters must be numeric (contains only digits 0-9, with no other characters). fields: - name: property_id type: querystring value: abc - name: property_id type: querystring value: 123adsf - type: property_id.maximum_exceeded message: A maximum of 250 property_id query parameters may be provided to this request. fields: - name: property_id type: querystring PropertyContent404Error: description: Not Found headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: property_content.not_found message: Content information for the requested properties could not be found. PropertyCatalogFile: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Link" examples: Example: method: GET href: "https://example.com/propertycatalog.jsonl.gz?amz-security-token=FQoDYXdzEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDD%2FiIFt2RCrdJKrkKSK3A2ncL3qC6SsXLyC3XxgRBGKykCfsfF40Jm8ud6ht6C1LB3q9X0maQCHyXV5gSl9g9hrHtOiC5fnihUQBASMAbOsepEKCfS%2B%2FWDrKAr5lTR%2FptslJxQs6v5GTO7G3R6PYIKFG%2FFgQydd8bEB2njMjynyvgXNgEPsb%2FVuiDC1K%2BMhvoRAguXo4QHQgOVVRXXmbl87j0Ih6s5ffI3yfIvEBnmEfdLdd2E5yPHuIO%2FOItXYxEc0vgipvlT41PylYtS8rhgc3MKqJO4Uw7yNPMlbphdxy6TJzQRJW15o9TaHrFBBYvWrtfcMewOlLYu6N6R1EGQhT9Ayok9J2oKzFJ%2FSbMNmVUsHReM7v1chuY7XNGld9bKeu0xFjDth%2BcEHrjkqhyxBc2pBINvk8LT9uPOCykqbuc2OWlCpNtQyahPnxpdPMW4WEbIFaWUNHWj0ui507CN2useZBYfGIST94KEtJFlpZRB0ntz%2BxmWRSnPYG3K47meFS9cthMsYH1rxIdDei2W49TQbjnVIXY2RldvO2JaTKtYPJT85ds9W71R0s4t9LSgY%2BZ9kaLjF%2BLk7PGKIhBbLowqKRBBUozOf2zAU%3D&AWSAccessKeyId=ASIAIZYRJJGNLGQGVLDA&Expires=1503512048&Signature=p7V%2BTN6rZMiVaz6MxqU%2F4YHYkw8%3D" PropertyContentFile: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Link" examples: Example: method: GET href: "https://example.com/propertycontent.jsonl.gz?amz-security-token=FQoDYXdzEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDD%2FiIFt2RCrdJKrkKSK3A2ncL3qC6SsXLyC3XxgRBGKykCfsfF40Jm8ud6ht6C1LB3q9X0maQCHyXV5gSl9g9hrHtOiC5fnihUQBASMAbOsepEKCfS%2B%2FWDrKAr5lTR%2FptslJxQs6v5GTO7G3R6PYIKFG%2FFgQydd8bEB2njMjynyvgXNgEPsb%2FVuiDC1K%2BMhvoRAguXo4QHQgOVVRXXmbl87j0Ih6s5ffI3yfIvEBnmEfdLdd2E5yPHuIO%2FOItXYxEc0vgipvlT41PylYtS8rhgc3MKqJO4Uw7yNPMlbphdxy6TJzQRJW15o9TaHrFBBYvWrtfcMewOlLYu6N6R1EGQhT9Ayok9J2oKzFJ%2FSbMNmVUsHReM7v1chuY7XNGld9bKeu0xFjDth%2BcEHrjkqhyxBc2pBINvk8LT9uPOCykqbuc2OWlCpNtQyahPnxpdPMW4WEbIFaWUNHWj0ui507CN2useZBYfGIST94KEtJFlpZRB0ntz%2BxmWRSnPYG3K47meFS9cthMsYH1rxIdDei2W49TQbjnVIXY2RldvO2JaTKtYPJT85ds9W71R0s4t9LSgY%2BZ9kaLjF%2BLk7PGKIhBbLowqKRBBUozOf2zAU%3D&AWSAccessKeyId=ASIAIZYRJJGNLGQGVLDA&Expires=1503512048&Signature=p7V%2BTN6rZMiVaz6MxqU%2F4YHYkw8%3D" PropertyCatalogFile400Error: description: Invalid Input headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: language.required message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]' fields: - name: language type: querystring - type: language.above_maximum message: The number of languages passed in must not be greater than 1. fields: - name: language type: querystring - type: language.not_supported message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]' fields: - name: language type: querystring value: xXX PropertyContentFile400Error: description: Invalid Input headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: language.required message: 'A language is required. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]' fields: - name: language type: querystring - type: language.above_maximum message: The number of languages passed in must not be greater than 1. fields: - name: language type: querystring - type: language.not_supported message: 'Language is not supported. Supported languages are: [ar-SA, cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA, fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE, th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]' fields: - name: language type: querystring value: xXX ItineraryRetrievalResponse: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: type: object description: "The retrieve response." properties: itinerary_id: description: "The itinerary id." example: 8999989898988 type: string property_id: description: "The property id." example: 8150374 type: string links: description: These links will only appear on a held booking. type: object properties: resume: type: object description: The link to resume a held booking. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: PUT type: string href: description: | The relative URI for the specified method. example: /2.1/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href cancel: type: object description: The link to cancel a held booking. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: DELETE type: string href: description: | The relative URI for the specified method. example: /2.1/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href rooms: type: array items: type: object description: "The room information." properties: id: description: "The room id." example: "926784314" type: string confirmation_id: description: "The confirmation ids." type: object properties: expedia: description: "The expedia confirmation id." example: "1234567890" type: string property: description: "The property confirmation id." example: "BEF23123AA" type: string bed_group_id: type: string description: Unique identifier for a bed type. example: "d395b56d-d31d-4a84-ad2b-66820b1d48e2" checkin: description: "The check-in date of the itinerary." example: "2018-09-21" type: string checkout: description: "The check-out date of the itinerary." example: "2018-09-23" type: string number_of_adults: description: "The number of adults staying in the room." example: 2 type: number child_ages: description: "The ages of children for the room." example: [2,3] type: array items: type: number given_name: description: "The first name of the main guest staying in the room." example: Givenne type: string family_name: description: "The last name of the main guest staying in the room." example: Nameo type: string status: description: "The booking status of the room." example: booked type: string enum: - pending - booked - canceled special_request: description: "Any special request info associated with the room." example: Please give me extra towels. type: string smoking: description: "Indicates if the room is smoking or non-smoking." example: false type: boolean rate: type: object description: "The rate information associated with the itinerary." properties: id: description: "The id of the rate." example: 035943984 type: string merchant_of_record: description: "The merchant responsible for collecting payment." example: expedia type: string enum: - expedia - property refundable: description: "Indicates whether the itinerary is refundable or not." example: true type: boolean cancel_refund: description: "The refund information for cancelling the itinerary." type: object properties: amount: description: "The amount of the refund on cancelling the itinerary." example: -65.98 type: string currency: description: "The currency of the refund amount." example: USD type: string amenities: type: array example: [12345,678, 9999] items: description: "The amenity id associated with the itinerary." type: string nightly: type: array items: type: array items: type: object description: "The nightly rates associated with the itinerary." properties: value: description: "The amount of the nightly rate." example: 111.23 type: string type: description: "The type of the nightly rate." example: base_rate type: string enum: - base_rate - tax_and_service_fee - extra_person_fee - compensation - property_fee - sales_tax - adjustment currency: description: "The currency of the nightly rate." example: USD type: string stay: type: array items: type: object description: "The stay rates associated with the itinerary." properties: value: description: "The amount of the stay rate." example: 123.45 type: string type: description: "The type of the stay rate." example: base_rate type: string enum: - base_rate - tax_and_service_fee - extra_person_fee - compensation - property_fee - sales_tax - adjustment currency: description: "The currency of the stay rate." example: USD type: string cancel_penalties: type: array items: type: object description: "The cancel penalties associated with the itinerary." properties: percent: description: "The percentage of the cancel penalty." example: 1 type: number start: description: "The start date/time of the cancel penalty." example: "2018-01-01T01:01:01.000-08:00" type: string end: description: "The end date/time of the cancel penalty." example: "2018-12-12T01:01:01.000-08:00" type: string amount: description: "The monetary amount of the penalty." example: 250.75 type: number currency: description: "The currency of the cancel penalty." example: USD type: string nights: description: "The number of nights that the cancel penalty applies to." example: 2 type: number deposit_policies: example: - amount: 220.75 due: "2018-12-12T01:01:01.000-08:00" type: array items: type: object description: "The deposit policy associated with the itinerary." properties: night: description: "The number of nights required as deposit." example: 1 type: number amount: description: "The amount required as deposit." example: "200.00" type: string percent: description: "The required percent as deposit." example: 30 type: number remainder: description: "If the remainder is required as deposit." example: true type: boolean due: description: "The due date/time of the deposit." example: "2018-12-12T01:01:01.000-08:00" type: string fees: type: array items: type: object description: "Any fees associated with the itinerary." properties: type: description: "The type of fee." example: resort_fee type: string enum: - resort_fee - mandatory_tax - mandatory_fee value: description: "The amount of the fee." example: 20.75 type: string currency: description: "The currency of the fee." example: USD type: string scope: description: "The scope of the fee." example: per_accommodation type: string enum: - unknown - per_person - per_room - per_accommodation - per_house - per_apartment - per_adult frequency: description: "The frequency of the fee." example: per_day type: string enum: - unknown - per_night - per_day - per_stay - per_week - round_trip - one_way required: - id - merchant_of_record - refundable - nightly - fees links: type: object properties: cancel: type: object description: The link to cancel a room. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: DELETE type: string href: description: | The relative URI for the specified method. example: /2.1/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href required: - cancel required: - id - checkin - checkout - number_of_adults - given_name - family_name - status - smoking - links billing_contact: $ref: "#/definitions/BillingContact" adjustment: type: object description: "Any price adjustments associated with this itinerary." properties: value: description: "The amount of the adjustment." example: "-100.00" type: string type: description: "The type of the adjustment." example: "base_rate" type: string currency: description: "The currency of the adjustment." example: "USD" type: string required: - value - type - currency creation_date_time: description: "The creation date/time of the booking." example: "2017-08-17T13:31:15.523Z" type: string affiliate_reference_id: description: "Your unique reference value. This field supports a maximum of 28 characters and is required to be unique (if provided)." type: string example: 4480ABC affiliate_metadata: description: "Field that stores up to 256 characters of additional metadata with the itinerary, uniqueness is not required." type: string example: "This booking was made with EPS." required: - itinerary_id - creation_date_time File404Error: description: Not Found headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: file.not_found message: The requested file could not be found. fields: - name: filename type: path value: super_cool_file Error401: description: Unauthorized schema: $ref: "#/definitions/Error" examples: Example: type: request_unauthenticated message: Data required to authenticate your request is missing. Ensure that your request follows the guidelines in our documentation. Error403: description: Forbidden schema: $ref: "#/definitions/Error" examples: Example: type: request_unauthenticated message: Your request could not be authenticated. Ensure that your request follows the guidelines in our documentation. fields: - name: apikey type: header value: jaj3982k239dka328e - name: signature type: header value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b - name: timestamp type: header value: 198284729 - name: servertimestamp type: server value: 198284729 Error426: description: Upgrade Required schema: $ref: "#/definitions/Error" examples: Example: type: upgrade_required message: This service requires the use of TLS. Error429: description: Too Many Requests headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: too_many_requests message: You have reached your capacity for this type of request. Error500: description: Unknown Internal Error schema: $ref: "#/definitions/Error" examples: Example: type: unknown_internal_error message: An internal server error has occurred. Error503: description: Service Unavailable schema: $ref: "#/definitions/Error" examples: Example: type: service_unavailable message: This service is currently unavailable. PropertyAvailability400Error: description: Bad Request headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: checkin.invalid_date_format message: 'Invalid checkin format. It must be formatted in ISO 8601 (YYYY-mm-dd) http://www.iso.org/iso/catalogue_detail?csnumber=40874.' fields: - name: checkin type: querystring value: 2019-01-1 - type: number_of_occupancies.invalid_above_maximum message: 'Number of occupancies must be less than 9.' fields: - name: occupancy type: querystring value: '9' BadRequestInvalidInput400Error: description: Bad Request headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: checkin.invalid_date_format message: 'Invalid checkin format. It must be formatted in ISO 8601 (YYYY-mm-dd) http://www.iso.org/iso/catalogue_detail?csnumber=40874.' fields: - name: checkin type: querystring value: 2019-01-1 PropertyAvailability404Error: description: No availability found. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Error: type: availability.not_found message: No availability was found for the properties requested. PriceMismatch409Error: description: Price Mismatch headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: price_mismatch message: Payment amount did not match current price, please check price and try again. fields: - name: payments.amount type: body value: 100.00 - name: price.amount type: body value: 120.00 SoldOut410Error: description: Sold Out headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: rooms_unavailable message: One or more requested rooms are unavailable. ItineraryNotFound404Error: description: Not Found headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: resource_not_found message: Itinerary was not found with provided request. RapidInvalidRequest400Error: description: Bad Request headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: link.invalid message: 'Link is invalid.' Region: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Region" examples: Region: id: '178309' type: multi_city_vicinity name: Saint Louis, Missouri name_full: Saint Louis, Missouri, United States of America country_code: US coordinates: center_longitude: -93.26344 center_latitude: 36.638264 bounding_polygon: type: MultiPolygon coordinates: [[[[-90.859069,38.503453],[-90.853202,38.508207],[-90.81246,38.493525],[-90.845915,38.481057],[-90.857717,38.48231],[-90.859069,38.503453]]],[[[-90.907324,38.796858],[-90.895084,38.852815],[-90.793246,38.824804],[-90.800455,38.809497],[-90.905098,38.77501],[-90.907324,38.796858]]],[[[-90.160125,38.456535],[-90.153095,38.455189],[-90.153836,38.465606],[-90.149344,38.465929],[-90.149547,38.47438],[-90.153305,38.474261],[-90.160125,38.456535]]]] ancestors: [{id: '201', type: country}] descendants: high_level_region: ['6330730'] city: ['10014', '9975'] property_ids: ['37242', '859343'] property_ids_expanded: ['37242', '859343', '48972'] RegionDescendants: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/RegionDescendants" examples: Region Descendants: city: '602962': id: '602962' type: multi_city_vicinity name: Springfield name_full: Springfield, Missouri, United States of America country_code: US coordinates: center_longitude: -93.310036 center_latitude: 37.227924 bounding_polygon: type: Polygon coordinates: [[[-93.446782,37.169329],[-93.4244,37.169432],[-93.371097,37.168636],[-93.376295,37.139236],[-93.361419,37.138634],[-93.347109,37.100601],[-93.215792,37.095905],[-93.215259,37.138013],[-93.189332,37.141503],[-93.191278,37.333322],[-93.438268,37.339372],[-93.446782,37.169329]]] ancestors: [{id: '227', type: province_state}, {id: '201', type: country}, {id: '500001', type: continent}] descendants: point_of_interest: ['6064841', '6064853'] '9066': id: '9066' type: city name: Ozark name_full: Ozark, Missouri, United States of America country_code: US coordinates: center_longitude: -93.20526 center_latitude: 37.020943 bounding_polygon: type: Polygon coordinates: [[[-93.233393,37.028373],[-93.194201,37.028041],[-93.192648,37.001514],[-93.23247,37.002062],[-93.233393,37.028373]]] ancestors: [{id: '227', type: province_state}, {id: '201', type: country}, {id: '500001', type: continent}] point_of_interest: '6064841': id: '6064841' type: point_of_interest name: American National Fish and Wildlife Museum name_full: American National Fish and Wildlife Museum, Springfield, Missouri, United States of America country_code: US coordinates: center_longitude: -93.29635 center_latitude: 37.1826 ancestors: [{id: '602962', type: multi_city_vicinity}, {id: '227', type: province_state}, {id: '201', type: country}, {id: '500001', type: continent}] '6064853': id: '6064853' type: point_of_interest name: Hammons Field name_full: Hammons Field, Springfield, Missouri, United States of America country_code: US coordinates: center_longitude: -93.2785 center_latitude: 37.21079 ancestors: [{id: '602962', type: multi_city_vicinity}, {id: '227', type: province_state}, {id: '201', type: country}, {id: '500001', type: continent}] Airport: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Airport" examples: Airport: iata_airport_code: ORD name: Chicago, IL (ORD-O'Hare Intl.) name_full: Chicago, IL, United States (ORD-O'Hare Intl.) country_code: US coordinates: center_longitude: -87.904785 center_latitude: 41.97693 property_ids: ['5532143', '8069454', '8277961', '22592', '5546779'] associated_region: id: '178248' type: multi_city_vicinity name: Chicago name_full: Chicago, Illinois, United States of America property_ids: ['5532143', '8069454', '8277961', '22592', '5546779'] Airports: description: OK headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Airports" examples: Airports: ORD: iata_airport_code: ORD name: Chicago, IL (ORD-O'Hare Intl.) name_full: Chicago, IL, United States (ORD-O'Hare Intl.) country_code: US coordinates: center_longitude: -87.904785 center_latitude: 41.97693 property_ids: ['5532143', '8069454', '8277961', '22592', '5546779'] associated_region: id: '178248' type: multi_city_vicinity name: Chicago name_full: Chicago, Illinois, United States of America property_ids: ['5532143', '8069454', '8277961', '22592', '5546779'] LHR: iata_airport_code: LHR name: London (LHR-Heathrow) name_full: London, United Kingdom (LHR-Heathrow) country_code: GB coordinates: center_longitude: -0.449753 center_latitude: 51.47088 property_ids: ['5532143', '8069454', '8277961', '22592', '5546779'] associated_region: id: '178279' type: multi_city_vicinity name: London name_full: London, England, United Kingdom property_ids: ['8301777', '918764', '890123'] RegionDescendants400Error: description: Bad Request headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: include.invalid message: 'Include is invalid. Accepted include values are: [details, property_ids, property_ids_expanded, standard]' fields: - name: include type: querystring value: STANDARD RegionDescendants404Error: description: Not Found headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: descendants.not_found message: The requested descendants could not be found. fields: - name: region_id type: path value: '29384729424' Region400Error: description: Bad Request headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: include.invalid message: 'Include is invalid. Accepted include values are: [details, property_ids, property_ids_expanded]' fields: - name: include type: querystring value: DETAILS Region404Error: description: Not Found headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: region.not_found message: The requested region could not be found. fields: - name: region_id type: path value: '29384729424' Airport400Error: description: Bad Request headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: invalid_input message: An invalid request was sent in, please check the nested errors for details. errors: - type: include.invalid message: 'Include is invalid. Accepted include values are: [associated_region_property_ids, details, property_ids]' fields: - name: include type: querystring value: DETAILS Airport404Error: description: Not Found headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/Error" examples: Example: type: airport.not_found message: The requested airport could not be found. fields: - name: iata_airport_code type: path value: XYZ RoomPriceCheck: description: 'OK' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: '#/definitions/RoomPriceCheck' examples: Example: status: matched occupancies: 2: nightly: - - type: base_rate value: '90.00' currency: USD stay: - type: base_rate value: '90.00' currency: USD totals: inclusive: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD exclusive: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD strikethrough: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD marketing_fee: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD minimum_selling_price: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD fees: type: mandatory_fee value: '10.00' currency: USD links: book: method: POST href: /2.1/itinerary?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m PriceChanged409: description: 'Price Changed' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/RoomPriceCheck" examples: Example: status: price_changed occupancies: 1234: nightly: type: base_rate value: '90.00' currency: USD stay: type: base_rate value: '90.00' currency: USD totals: inclusive: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD exclusive: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD strikethrough: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD marketing_fee: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD minimum_selling_price: billable_currency: value: '215.00' currency: USD request_currency: value: '215.00' currency: USD fees: type: mandatory_fee value: '10.00' currency: USD links: shop: method: GET href: /2.1/properties/availability/1234?token=REhZAQsABAMGQggMV1pFAV1YVA5cZhBYEgNKH1RGEVEQUAoOBwlVVBlVCEkFUxVZWgZAFAVbABgMC0RXRx= book: method: POST href: /2.1/itinerary?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m PriceCheckSoldOut410Error: description: 'Sold Out' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: "#/definitions/RoomPriceCheck" examples: Example: status: sold_out links: shop: method: GET href: /2.1/properties/availability/1234?token=REhZAQsABAMGQggMV1pFAV1YVA5cZhBYEgNKH1RGEVEQUAoOBwlVVBlVCEkFUxVZWgZAFAVbABgMC0RXRx= PaymentOptions: description: 'OK' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: $ref: '#/definitions/PaymentOption' examples: PaymentOptions: affiliate_collect: name: Affiliate Collect credit_card: name: Credit Card card_options: - name: AmericanExpress card_type: AX - name: MasterCard card_type: CA processing_country: US DepositPolicies: description: 'OK' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: type: array items: $ref: '#/definitions/DepositPolicy' Recommendations: description: 'OK' headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: type: array items: $ref: '#/definitions/PropertyAvailability' ItineraryCreationResponse: description: Created headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. schema: type: object description: The book response. properties: itinerary_id: description: The itinerary id. example: 8999989898988 type: string links: type: object properties: retrieve: type: object description: The link to retrieve a booking. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: GET type: string href: description: | The relative URI for the specified method. example: /2.1/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href resume: type: object description: The link to resume a held booking. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: PUT type: string href: description: | The relative URI for the specified method. example: /2.1/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href cancel: type: object description: The link to cancel a held booking. properties: method: description: | The request method to indicate the desired action to be performed for a given resource. example: DELETE type: string href: description: | The relative URI for the specified method. example: /2.1/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m type: string required: - method - href required: - retrieve required: - itinerary_id - links ResumeBooking: description: No Content - Held booking has successfully resumed. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. ResumeBookingUnknown: description: Accepted - Request is valid but the state of the booking is unknown. Make a retrieve call to verify the booking has been resumed properly. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. CancelBooking: description: No Content - Booking has successfully canceled. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. CancelBookingUnknown: description: Accepted - Request is valid but the state of the booking is unknown. Make a retrieve call to verify the booking has been canceled properly. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. CancelRoom: description: No Content - Booking has successfully canceled. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used. CancelRoomUnknown: description: Accepted - Request is valid but the state of the booking is unknown. Make a retrieve call to verify the booking has been canceled properly. headers: Rate-Limit-Day: type: number description: Reserved for future use. Optional header for request capacity per day. Rate-Limit-Day-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the daily time window. Rate-Limit-Day-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the daily capacity resets. Rate-Limit-Minute: type: number description: Reserved for future use. Optional header for request capacity per minute. Rate-Limit-Minute-Remaining: type: number description: Optional header for the remaining capacity, as a percentage, for the per minute time window. Rate-Limit-Minute-Reset: type: number description: Optional header for the timestamp, as the number of milliseconds since the Unix Epoch, when the per minute capacity resets. Rate-Limit-Reduction-Status: type: string description: Optional header that indicates the state (inactive, active) of minute capacity reduction triggered once all daily capacity has been used.