From 25afa8780399302ea8b5d7436adf8fdaa92f4337 Mon Sep 17 00:00:00 2001 From: OmarAlJarrah Date: Tue, 22 Apr 2025 13:56:58 +0300 Subject: [PATCH 1/3] chore: update rapid specs --- specs.yaml | 19299 +++++++++++++++++++++++++++------------------------ 1 file changed, 10043 insertions(+), 9256 deletions(-) diff --git a/specs.yaml b/specs.yaml index fa95244a1c..c8bf865485 100644 --- a/specs.yaml +++ b/specs.yaml @@ -4,28 +4,28 @@ info: description: EPS Rapid V3 version: v3 servers: - - url: https://test.ean.com/v3 +- url: https://test.ean.com/v3 tags: - - name: Content - description: This section outlines the API calls available to you to access property - content. - - name: Geography - description: The EPS Geography API provides geography content for regions around - the world. - - name: Shopping - description: The EPS shopping APIs provide you with access to live rates & availability. - - name: Bookings - description: "The primary itinerary method of the Booking API creates a reservation\ +- name: Content + description: This section outlines the API calls available to you to access property + content. +- name: Geography + description: The EPS Geography API provides geography content for regions around + the world. +- name: Shopping + description: The EPS shopping APIs provide you with access to live rates & availability. +- name: Bookings + description: "The primary itinerary method of the Booking API creates a reservation\ \ for the selected hotel, room, rate and occupancy." - - name: Manage Booking - description: Retrieve existing itineraries or cancel existing rooms. - - name: Notifications - description: Requests test notifications and undelivered notifications. +- name: Manage Booking + description: Retrieve existing itineraries or cancel existing rooms. +- name: Notifications + description: Requests test notifications and undelivered notifications. paths: /properties/content: get: tags: - - Content + - Content summary: Property Content description: | Search property content for active properties in the requested language.

@@ -36,423 +36,423 @@ paths: can include property-level, room-level and rate-level information. operationId: getPropertyContent parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be + supplied once and will return all properties that match the requested supply source. An error is thrown if + the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for + more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: all_inclusive + in: query + description: | + Search to include properties that have the requested `all_inclusive` values equal to true. If this parameter + is not supplied, all `all_inclusive` scenarios are included. This parameter can be supplied multiple times + with different values, which will include properties that match any of the requested scenarios. + * `all_rate_plans` - Return properties where `all_inclusive.all_rate_plans` is true. + * `some_rate_plans` = Return properties where `all_inclusive.some_rate_plans` is true. + schema: + type: array + items: type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be - supplied once and will return all properties that match the requested supply source. An error is thrown if - the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for - more information. - required: true - schema: + examples: + Optional: + value: null + All: + value: all_rate_plans + - name: amenity_id + in: query + description: | + The ID of the amenity you want to search for. This parameter can be supplied multiple times with different + values, which will include properties that match any of the requested amenity IDs. This is currently only + capable of searching for property level amenities. Room and rate level amenities cannot be searched on. + schema: + type: array + items: type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: all_inclusive - in: query - description: | - Search to include properties that have the requested `all_inclusive` values equal to true. If this parameter - is not supplied, all `all_inclusive` scenarios are included. This parameter can be supplied multiple times - with different values, which will include properties that match any of the requested scenarios. - * `all_rate_plans` - Return properties where `all_inclusive.all_rate_plans` is true. - * `some_rate_plans` = Return properties where `all_inclusive.some_rate_plans` is true. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - All: - value: all_rate_plans - - name: amenity_id - in: query - description: | - The ID of the amenity you want to search for. This parameter can be supplied multiple times with different - values, which will include properties that match any of the requested amenity IDs. This is currently only - capable of searching for property level amenities. Room and rate level amenities cannot be searched on. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Elevator: - value: 8 - Multiple: - value: - - 115 - - 43 - - name: attribute_id - in: query - description: | - The ID of the attribute you want to search for. This parameter can be supplied multiple times with different - values, which will include properties that match any of the requested attribute IDs. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Pets: - value: 51 - Multiple: - value: - - 5058 - - 5059 - - name: brand_id - in: query - description: | - The ID of the brand you want to search for. This parameter can be supplied multiple times with different - values, which will include properties that match any of the requested brand IDs. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Hyatt: - value: 11210 - Multiple: - value: - - 1 - - 11210 - - name: business_model - in: query - description: | - Search for properties with the requested business model enabled. This parameter can be supplied multiple - times with different values, which will return all properties that match any of the requested business - models. The value must be lower case. - * `expedia_collect` - Return only properties where the payment is collected by Expedia. - * `property_collect` - Return only properties where the payment is collected at the property. - schema: - type: array - items: - type: string - enum: - - expedia_collect - - property_collect - examples: - Optional: - value: null - Single: - value: expedia_collect - - name: category_id - in: query - description: | - Search to include properties that have the requested - [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If - this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times - with different values, which will include properties that match any of the requested category IDs. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Single: - value: 1 - Multiple: - value: - - 1 - - 2 - - name: category_id_exclude - in: query - description: | - Search to exclude properties that do not have the requested - [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If - this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times - with different values, which will exclude properties that match any of the requested category IDs. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Single: - value: 1 - Multiple: - value: - - 1 - - 2 - - name: chain_id - in: query - description: | - The ID of the chain you want to search for. These chain IDs can be positive and negative numbers. This - parameter can be supplied multiple times with different values, which will include properties that match - any of the requested chain IDs. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Single: - value: -6 - Multiple: - value: - - 1 - - 2 - - name: country_code - in: query - description: | - Search for properties with the requested country code, in ISO 3166-1 alpha-2 format. This parameter can be - supplied multiple times with different values, which will include properties that match any of the - requested country codes. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Single: - value: US - Multiple: - value: - - US - - CA - - name: date_added_end - in: query - description: | - Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: + examples: + Optional: + value: null + Elevator: + value: 8 + Multiple: + value: + - 115 + - 43 + - name: attribute_id + in: query + description: | + The ID of the attribute you want to search for. This parameter can be supplied multiple times with different + values, which will include properties that match any of the requested attribute IDs. + schema: + type: array + items: type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-21' - - name: date_added_start - in: query - description: | - Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: + examples: + Optional: + value: null + Pets: + value: 51 + Multiple: + value: + - 5058 + - 5059 + - name: brand_id + in: query + description: | + The ID of the brand you want to search for. This parameter can be supplied multiple times with different + values, which will include properties that match any of the requested brand IDs. + schema: + type: array + items: type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-20' - - name: date_updated_end - in: query - description: | - Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: + examples: + Optional: + value: null + Hyatt: + value: 11210 + Multiple: + value: + - 1 + - 11210 + - name: business_model + in: query + description: | + Search for properties with the requested business model enabled. This parameter can be supplied multiple + times with different values, which will return all properties that match any of the requested business + models. The value must be lower case. + * `expedia_collect` - Return only properties where the payment is collected by Expedia. + * `property_collect` - Return only properties where the payment is collected at the property. + schema: + type: array + items: type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-21' - - name: date_updated_start - in: query - description: | - Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: + enum: + - expedia_collect + - property_collect + examples: + Optional: + value: null + Single: + value: expedia_collect + - name: category_id + in: query + description: | + Search to include properties that have the requested + [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If + this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times + with different values, which will include properties that match any of the requested category IDs. + schema: + type: array + items: type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-20' - - name: include - in: query - description: | - Each time this parameter is specified will add to the list of fields and associated objects returned in the - response. All values and field names are lower case. The values `property_ids` and `catalog` will continue - to behave as specified below for backwards compatibility. All other top level field names will add the - specified field to the list of fields returned in the response. See the response schema for a full list of - top level field names. Additionally, the field `property_id` will always be returned regardless of what - include values are passed.

- Possible values: - * `property_ids` - ***DEPRECATED*** - Please use `property_id` which matches the response field name. - * `catalog` - Include all property catalog fields. See - [Property Catalog File endpoint](https://developers.expediagroup.com/docs/rapid/resources/rapid-api#get-/files/properties/catalog) - for a list of fields. - * `property_id` - Passing in the value `property_id` and no other values will limit the response to only - `property_id`. Not necessary to include in combination with other field name values, as it will always - be returned. - * All field names found at the top level of the property content response are now valid values for - inclusion. - schema: - type: array - items: - type: string - examples: - IncludeAll: - value: null - Single: - value: images - Multiple: - value: - - images - - address - - name: multi_unit - in: query - description: | - Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit - properties will be included. - * `true` - Include only properties that are multi-unit. - * `false` - Do not include properties that are multi-unit. - schema: - type: boolean - examples: - Optional: - value: null - Single: - value: false - - name: property_id - in: query - description: | - The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. - schema: - type: array - items: - type: string - examples: - Single: - value: 1337 - Multiple: - value: - - 1337 - - 1 - Optional: - value: null - - name: property_rating_max - in: query - description: | - Search for properties with a property rating less than or equal to the requested rating. The highest - property rating value is 5.0. - schema: + examples: + Optional: + value: null + Single: + value: 1 + Multiple: + value: + - 1 + - 2 + - name: category_id_exclude + in: query + description: | + Search to exclude properties that do not have the requested + [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If + this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times + with different values, which will exclude properties that match any of the requested category IDs. + schema: + type: array + items: type: string - examples: - Optional: - value: null - Single: - value: 5.0 - - name: property_rating_min - in: query - description: | - Search for properties with a property rating greater than or equal to the requested rating. The lowest - property rating value is 0.0. - schema: + examples: + Optional: + value: null + Single: + value: 1 + Multiple: + value: + - 1 + - 2 + - name: chain_id + in: query + description: | + The ID of the chain you want to search for. These chain IDs can be positive and negative numbers. This + parameter can be supplied multiple times with different values, which will include properties that match + any of the requested chain IDs. + schema: + type: array + items: type: string - examples: - Optional: - value: null - Single: - value: 3.5 - - name: spoken_language_id - in: query - description: | - The id of the spoken language you want to search for. This parameter can be supplied multiple times with - different values, which will include properties that match any of the requested spoken languages. The - language code as a subset of BCP47 format. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Single: - value: en - Multiple: - value: - - zh-yue - - vi - - name: billing_terms - in: query - 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 separately. - schema: + examples: + Optional: + value: null + Single: + value: -6 + Multiple: + value: + - 1 + - 2 + - name: country_code + in: query + description: | + Search for properties with the requested country code, in ISO 3166-1 alpha-2 format. This parameter can be + supplied multiple times with different values, which will include properties that match any of the + requested country codes. + schema: + type: array + items: type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: + examples: + Optional: + value: null + Single: + value: US + Multiple: + value: + - US + - CA + - name: date_added_end + in: query + description: | + Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: + type: string + examples: + Optional: + value: null + Recent: + value: '2023-09-21' + - name: date_added_start + in: query + description: | + Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: + type: string + examples: + Optional: + value: null + Recent: + value: '2023-09-20' + - name: date_updated_end + in: query + description: | + Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: + type: string + examples: + Optional: + value: null + Recent: + value: '2023-09-21' + - name: date_updated_start + in: query + description: | + Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: + type: string + examples: + Optional: + value: null + Recent: + value: '2023-09-20' + - name: include + in: query + description: | + Each time this parameter is specified will add to the list of fields and associated objects returned in the + response. All values and field names are lower case. The values `property_ids` and `catalog` will continue + to behave as specified below for backwards compatibility. All other top level field names will add the + specified field to the list of fields returned in the response. See the response schema for a full list of + top level field names. Additionally, the field `property_id` will always be returned regardless of what + include values are passed.

+ Possible values: + * `property_ids` - ***DEPRECATED*** - Please use `property_id` which matches the response field name. + * `catalog` - Include all property catalog fields. See + [Property Catalog File endpoint](https://developers.expediagroup.com/docs/rapid/resources/rapid-api#get-/files/properties/catalog) + for a list of fields. + * `property_id` - Passing in the value `property_id` and no other values will limit the response to only + `property_id`. Not necessary to include in combination with other field name values, as it will always + be returned. + * All field names found at the top level of the property content response are now valid values for + inclusion. + schema: + type: array + items: type: string - - name: payment_terms - in: query - 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 separately. - schema: + examples: + IncludeAll: + value: null + Single: + value: images + Multiple: + value: + - images + - address + - name: multi_unit + in: query + description: | + Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit + properties will be included. + * `true` - Include only properties that are multi-unit. + * `false` - Do not include properties that are multi-unit. + schema: + type: boolean + examples: + Optional: + value: null + Single: + value: false + - name: property_id + in: query + description: | + The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. + schema: + type: array + items: type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: + examples: + Single: + value: 1337 + Multiple: + value: + - 1337 + - 1 + Optional: + value: null + - name: property_rating_max + in: query + description: | + Search for properties with a property rating less than or equal to the requested rating. The highest + property rating value is 5.0. + schema: + type: string + examples: + Optional: + value: null + Single: + value: 5.0 + - name: property_rating_min + in: query + description: | + Search for properties with a property rating greater than or equal to the requested rating. The lowest + property rating value is 0.0. + schema: + type: string + examples: + Optional: + value: null + Single: + value: 3.5 + - name: spoken_language_id + in: query + description: | + The id of the spoken language you want to search for. This parameter can be supplied multiple times with + different values, which will include properties that match any of the requested spoken languages. The + language code as a subset of BCP47 format. + schema: + type: array + items: type: string + examples: + Optional: + value: null + Single: + value: en + Multiple: + value: + - zh-yue + - vi + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -552,6 +552,7 @@ paths: business_model: expedia_collect: true property_collect: false + updated_expedia_collect: true checkin: "24_hour": 24-hour check-in begin_time: 3:00 PM @@ -620,13 +621,13 @@ paths: name: Number of indoor pools - 10 value: 10 images: - - caption: Featured Image - hero_image: true - category: 3 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + - 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: @@ -658,21 +659,21 @@ paths: name: Test Amenity - 200 value: "200" images: - - hero_image: true - category: 21001 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg - caption: Guestroom + - hero_image: true + category: 21001 + links: + "70px": + method: GET + href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + caption: Guestroom bed_groups: "37321": id: "37321" description: 1 King Bed configuration: - - type: KingBed - size: King - quantity: 1 + - type: KingBed + size: King + quantity: 1 area: square_meters: 20 square_feet: 215 @@ -853,6 +854,7 @@ paths: business_model: expedia_collect: true property_collect: true + updated_expedia_collect: true rank: 99999999 checkin: begin_time: 4:00 PM @@ -908,24 +910,24 @@ paths: id: "9" name: Fitness facilities categories: - - gym + - gym "1073745320": id: "1073745320" name: Paddle boating nearby images: - - hero_image: true - category: 21001 - links: - "350px": - method: GET - href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_b.jpg - "70px": - method: GET - href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_t.jpg - "1000px": - method: GET - href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_z.jpg - caption: Room + - hero_image: true + category: 21001 + links: + "350px": + method: GET + href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_b.jpg + "70px": + method: GET + href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_t.jpg + "1000px": + method: GET + href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_z.jpg + caption: Room onsite_payments: currency: USD dates: @@ -995,10 +997,10 @@ paths: property_manager: name: Scott Horton house_rules: - - Children welcome - - No pets - - No smoking - - No parties or events + - Children welcome + - No pets + - No smoking + - No parties or events amenities: "1": id: "1" @@ -1014,32 +1016,32 @@ paths: ipm_name: Good Company unit_configurations: "1": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "2": - - quantity: 1 - type: SLEEP_SOFA_FUTON - description: 'Sleep sofa/futon(s) - ' - - quantity: 2 - type: BUNK_BED - description: 'Bunk bed(s) - ' + - quantity: 1 + type: SLEEP_SOFA_FUTON + description: 'Sleep sofa/futon(s) - ' + - quantity: 2 + type: BUNK_BED + description: 'Bunk bed(s) - ' "3": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "4": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "5": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "6": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' enhanced_house_rules: Pets: rule: No pets allowed @@ -1061,7 +1063,7 @@ paths: as many of them live here full time. Quiet hours are 10pm-8am. additional_information: - - "No weapons, illegal drugs, parties, disruptive guests,\ + - "No weapons, illegal drugs, parties, disruptive guests,\ \ or underage drinking is permitted." CheckIn: rule: Check in after 4:00 PM @@ -1176,6 +1178,7 @@ paths: business_model: expedia_collect: true property_collect: false + updated_expedia_collect: true checkin: "24_hour": 24-hour check-in begin_time: 3:00 PM @@ -1244,13 +1247,13 @@ paths: name: Number of indoor pools - 10 value: 10 images: - - caption: Featured Image - hero_image: true - category: 3 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + - 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: @@ -1282,21 +1285,21 @@ paths: name: Test Amenity - 200 value: "200" images: - - hero_image: true - category: 21001 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg - caption: Guestroom + - hero_image: true + category: 21001 + links: + "70px": + method: GET + href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + caption: Guestroom bed_groups: "37321": id: "37321" description: 1 King Bed configuration: - - type: KingBed - size: King - quantity: 1 + - type: KingBed + size: King + quantity: 1 area: square_meters: 20 square_feet: 215 @@ -1495,6 +1498,7 @@ paths: business_model: expedia_collect: true property_collect: true + updated_expedia_collect: false checkin: "24_hour": 24-hour check-in begin_time: 3:00 PM @@ -1563,13 +1567,13 @@ paths: name: Number of indoor pools - 10 value: 10 images: - - caption: Featured Image - hero_image: true - category: 3 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + - 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: @@ -1601,21 +1605,21 @@ paths: name: Test Amenity - 200 value: "200" images: - - hero_image: true - category: 21001 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg - caption: Guestroom + - hero_image: true + category: 21001 + links: + "70px": + method: GET + href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + caption: Guestroom bed_groups: "37321": id: "37321" description: 1 King Bed configuration: - - type: KingBed - size: King - quantity: 1 + - type: KingBed + size: King + quantity: 1 area: square_meters: 17 views: @@ -1828,47 +1832,47 @@ paths: 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,\ + - 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,\ + 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.must_be_numeric - message: "All provided property_id query parameters must be numeric\ + fields: + - name: language + type: querystring + value: xXX + - 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.above_maximum - message: A maximum of 250 property_id query parameters may be provided - to this request. - fields: - - name: property_id - type: querystring + fields: + - name: property_id + type: querystring + value: abc + - name: property_id + type: querystring + value: 123adsf + - type: property_id.above_maximum + message: A maximum of 250 property_id query parameters may be provided + to this request. + fields: + - name: property_id + type: querystring "401": description: Unauthorized headers: @@ -1888,18 +1892,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -2002,11 +2006,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/inactive: get: tags: - - Content + - Content summary: Inactive Properties description: | Request a list of properties that are inactive because they have been removed from sale since a specified @@ -2015,87 +2019,87 @@ paths: 200 response section. operationId: getInactiveProperties parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: since - in: query - description: | - Required on initial call, not accepted on subsequent paging links provided in response header.
- The earliest date that a property became inactive to include in the results. ISO 8601 format (YYYY-MM-DD) - schema: - type: string - examples: - Initial: - value: '2023-09-20' - Paging: - value: null - - name: token - in: query - description: | - Only used for requesting additional pages of data. Provided by the `next` URL in the `Link` response header. - schema: - type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: since + in: query + description: | + Required on initial call, not accepted on subsequent paging links provided in response header.
+ The earliest date that a property became inactive to include in the results. ISO 8601 format (YYYY-MM-DD) + schema: + type: string + examples: + Initial: + value: '2023-09-20' + Paging: + value: null + - name: token + in: query + description: | + Only used for requesting additional pages of data. Provided by the `next` URL in the `Link` response header. + schema: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -2141,8 +2145,8 @@ paths: examples: Inactive Properties: value: - - property_id: "12345" - - property_id: "23456" + - property_id: "12345" + - property_id: "23456" No Results: value: [] "400": @@ -2171,19 +2175,19 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: since.required - message: The since field is required. Please provide a date in ISO - 8601 (YYYY-MM-DD) format. - fields: - - name: since - type: querystring - - type: since.invalid_date_format - message: The since field is not formatted correctly. Please provide - a date in ISO 8601 (YYYY-MM-DD) format. - fields: - - name: since - type: querystring - value: 23-1-1 + - type: since.required + message: The since field is required. Please provide a date in ISO + 8601 (YYYY-MM-DD) format. + fields: + - name: since + type: querystring + - type: since.invalid_date_format + message: The since field is not formatted correctly. Please provide + a date in ISO 8601 (YYYY-MM-DD) format. + fields: + - name: since + type: querystring + value: 23-1-1 "401": description: Unauthorized headers: @@ -2201,18 +2205,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden content: @@ -2299,11 +2303,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/guest-reviews: get: tags: - - Content + - Content summary: Property Guest Reviews description: | Note: Property Guest Reviews are only available if your account is configured for access and all launch requirements have been followed. Please find the launch requirements here [https://support.expediapartnersolutions.com/hc/en-us/articles/360008646799](https://support.expediapartnersolutions.com/hc/en-us/articles/360008646799) and contact your Account Manager for more details. @@ -2313,135 +2317,135 @@ paths: To ensure you always show the latest guest reviews, this call should be made whenever a customer looks at the details for a specific property. operationId: getPropertyGuestReviews parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Japanese: - value: ja-JP - - name: property_id - in: path - description: Expedia Property ID. - required: true - schema: - type: string - example: 12345 - - name: filter - in: query - description: | - Single filter value. Send multiple instances of this parameter to request multiple filters. - * `language` - Filters reviews to only those that match the specified `language` parameter value. Without - this filter, the matching language will be preferred, but other language results can be returned. - Specifying this filter could produce an error when there are no matching results. - schema: - type: array - items: - type: string - enum: - - language - examples: - Optional: - value: null - Single: - value: language - - name: trip_reason - in: query - description: | - Desired reason provided for the reviewer's trip that you wish to display. This parameter can be supplied - multiple times with different values, which will include reviews that match any of the requested trip - reasons. - required: false - schema: - type: array - items: - type: string - enum: - - business - - leisure - - friends_and_family - - business_and_leisure - examples: - Optional: - value: null - Single: - value: business - Multiple: - value: - - business - - business_and_leisure - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Japanese: + value: ja-JP + - name: property_id + in: path + description: Expedia Property ID. + required: true + schema: + type: string + example: 12345 + - name: filter + in: query + description: | + Single filter value. Send multiple instances of this parameter to request multiple filters. + * `language` - Filters reviews to only those that match the specified `language` parameter value. Without + this filter, the matching language will be preferred, but other language results can be returned. + Specifying this filter could produce an error when there are no matching results. + schema: + type: array + items: type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: + enum: + - language + examples: + Optional: + value: null + Single: + value: language + - name: trip_reason + in: query + description: | + Desired reason provided for the reviewer's trip that you wish to display. This parameter can be supplied + multiple times with different values, which will include reviews that match any of the requested trip + reasons. + required: false + schema: + type: array + items: type: string + enum: + - business + - leisure + - friends_and_family + - business_and_leisure + examples: + Optional: + value: null + Single: + value: business + Multiple: + value: + - business + - business_and_leisure + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -2469,31 +2473,31 @@ paths: example: verified: recent: - - verification_source: Expedia verified Review - title: Definitely staying again - date_submitted: '2019-02-11T18:19:40Z' - rating: "5" - reviewer_name: Bill - stay_date: 2019-02 - trip_reason: leisure - travel_companion: self - text: "Staff very helpful and friendly. Pool was 18 meters deep,\ + - verification_source: Expedia verified Review + title: Definitely staying again + date_submitted: '2019-02-11T18:19:40Z' + rating: "5" + reviewer_name: Bill + stay_date: 2019-02 + trip_reason: leisure + travel_companion: self + text: "Staff very helpful and friendly. Pool was 18 meters deep,\ \ very strange." - - verification_source: Expedia verified Review - title: Pool much too deep - date_submitted: '2019-02-10T11:15:01Z' - rating: "2" - reviewer_name: Gregory - stay_date: 2019-01 - trip_reason: friends_and_family - travel_companion: family_with_children - text: Bottom of the 18 meter pool was too scary. Staff were nice - though. - management_responses: - - text: | - Dear Guest, Thank you for your feedback. I hope we have the opportunity to welcome you back - in the near future. Best regards, Kara (General Manager) - date: '2019-02-11T14:36:54Z' + - verification_source: Expedia verified Review + title: Pool much too deep + date_submitted: '2019-02-10T11:15:01Z' + rating: "2" + reviewer_name: Gregory + stay_date: 2019-01 + trip_reason: friends_and_family + travel_companion: family_with_children + text: Bottom of the 18 meter pool was too scary. Staff were nice + though. + management_responses: + - text: | + Dear Guest, Thank you for your feedback. I hope we have the opportunity to welcome you back + in the near future. Best regards, Kara (General Manager) + date: '2019-02-11T14:36:54Z' "400": description: Invalid Input headers: @@ -2522,31 +2526,31 @@ paths: 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,\ + - 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,\ + 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 + fields: + - name: language + type: querystring + value: xXX "401": description: Unauthorized headers: @@ -2566,18 +2570,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -2679,11 +2683,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /files/properties/catalog: get: tags: - - Content + - Content summary: Property Catalog File description: | Returns a link to download the master list of EPS's active properties in the requested language. The response includes high-level details about each property. @@ -2708,100 +2712,100 @@ paths:
Example of a JSONL file with 2 properties: ``` - {"property_id":"12345","name":"Test Property Name","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":false,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345"},"fr-FR":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":48382,"overall":"3.1","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"73%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838}},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":false},"dates":{"added":"1998-07-19T05:00:00.000Z","updated":"2018-03-22T07:23:14.000Z"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"chain":{"id":"-6","name":"Hyatt Hotels"},"brand":{"id":"2209","name":"Hyatt Place"},"supply_source":"expedia"} - {"property_id":"67890","name":"Test Property Name 2","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":true,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890"},"de-DE":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":7651,"overall":"4.3","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"80%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838}},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":true},"dates":{"added":"1998-07-20T05:00:00.000Z","updated":"2018-03-22T13:33:17.000Z"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"chain":{"id":"-5","name":"Hilton Worldwide"},"brand":{"id":"358","name":"Hampton Inn"},"supply_source":"expedia"} + {"property_id":"12345","name":"Test Property Name","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":false,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345"},"fr-FR":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":48382,"overall":"3.1","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"73%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838}},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":false,"updated_expedia_collect":true},"dates":{"added":"1998-07-19T05:00:00.000Z","updated":"2018-03-22T07:23:14.000Z"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"chain":{"id":"-6","name":"Hyatt Hotels"},"brand":{"id":"2209","name":"Hyatt Place"},"supply_source":"expedia"} + {"property_id":"67890","name":"Test Property Name 2","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":true,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890"},"de-DE":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":7651,"overall":"4.3","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"80%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838}},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":true,"updated_expedia_collect":false},"dates":{"added":"1998-07-20T05:00:00.000Z","updated":"2018-03-22T13:33:17.000Z"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"chain":{"id":"-5","name":"Hilton Worldwide"},"brand":{"id":"358","name":"Hampton Inn"},"supply_source":"expedia"} ``` operationId: getPropertyCatalogFile parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) - - Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - example: en-US - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) - for more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) + + Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + example: en-US + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) + for more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -2858,31 +2862,31 @@ paths: 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,\ + - 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,\ + 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 + fields: + - name: language + type: querystring + value: xXX "401": description: Unauthorized headers: @@ -2902,18 +2906,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -2953,9 +2957,9 @@ paths: type: file.not_found message: The requested file could not be found. fields: - - name: filename - type: path - value: file.jsonl.gz + - name: filename + type: path + value: file.jsonl.gz "426": description: Upgrade Required headers: @@ -3019,11 +3023,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /files/properties/content: get: tags: - - Content + - Content summary: Property Content File 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. @@ -3032,106 +3036,106 @@ paths:
Example of a JSONL file with 2 properties: ``` - {"property_id":"12345","name":"Test Property Name","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":false,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345"},"fr-FR":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":48382,"overall":"3.1","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"73%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838}},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":false},"checkin":{"24_hour":"24-hour check-in","begin_time":"3:00 PM","end_time":"11:00 PM","instructions":"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />","special_instructions":"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.","min_age":18},"checkout":{"time":"11:00 AM"},"fees":{"mandatory":"

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"},"3321":{"id":"3321","name":"Pet maximum weight in kg is - 24","value":24}}},"amenities":{"9":{"id":"9","name":"Fitness facilities"},"2820":{"id":"2820","name":"Number of indoor pools - 10","value":10}},"images":[{"caption":"Featured Image","hero_image":true,"category":3,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"onsite_payments":{"currency":"USD","types":{"171":{"id":"171","name":"American Express"}}},"rooms":{"224829":{"id":"224829","name":"Single Room","descriptions":{"overview":"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":{"130":{"id":"130","name":"Refrigerator"},"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"}},"images":[{"hero_image":true,"category":21001,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}},"caption":"Guestroom"}],"bed_groups":{"37321":{"id":"37321","description":"1 King Bed","configuration":[{"type":"KingBed","size":"King","quantity":1}]}},"area":{"square_meters":20,"square_feet":215},"views":{"4146":{"id":"4146","name":"Courtyard view"}},"occupancy":{"max_allowed":{"total":5,"children":2,"adults":4},"age_categories":{"Adult":{"name":"Adult","minimum_age":9}}}}},"rates":{"333abc":{"id":"333abc","amenities":{"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"},"2104":{"id":"2104","name":"Full Breakfast"}},"special_offer_description":"Breakfast for 2 - Rate includes the following:\r\nMust book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"}},"dates":{"added":"1998-07-19T05:00:00.000Z","updated":"2018-03-22T07:23:14.000Z"},"descriptions":{"amenities":"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.","dining":"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.","renovations":"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ","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.","headline":"Near National Museum of Natural Science","general":"General description"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"airports":{"preferred":{"iata_airport_code":"SGF"}},"themes":{"2337":{"id":"2337","name":"Luxury Hotel"},"2341":{"id":"2341","name":"Spa Hotel"}},"all_inclusive":{"all_rate_plans":true,"some_rate_plans":false,"details":"

    This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).

    Activities and facilities/equipment
    Land activities


    Lessons/classes/games

    Entertainment

    "},"tax_id":"AB-012-987-1234-01","chain":{"id":"-6","name":"Hyatt Hotels"},"brand":{"id":"2209","name":"Hyatt Place"},"spoken_languages":{"vi":{"id":"vi","name":"Vietnamese"}},"multi_unit":true,"payment_registration_recommended":false,"vacation_rental_details": {"registry_number": "Property Registration Number 123456","private_host": "true","property_manager": {"name": "Victor","links": {"image": {"method": "GET","href": "https://test-image/test/test/836f1097-fbcf-43b5-bc02-c8ff6658cb90.c1.jpg"}}},"rental_agreement": {"links": {"rental_agreement": {"method": "GET","href": "https://test-link.test.amazonaws.com/rentalconditions_property_d65e7eb5-4a7c-4a80-a8a3-171999f9f444.pdf"}}},"house_rules": ["Children welcome","No pets","No smoking","No parties or events"],"amenities": {"4296": {"id": "4296","name": "Furnished balcony or patio"},"2859": {"id": "2859","name": "Private pool"}},"vrbo_srp_id": "123.1234567.5678910","listing_id": "1234567","listing_number": "5678910","listing_source": "HOMEAWAY_US","listing_unit": "/units/0000/32d82dfa-1a48-45d6-9132-49fdbf1bfc60"},"supply_source":"vrbo","registry_number":"Property Registration Number 123456"} - {"property_id":"67890","name":"Test Property Name 2","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":true,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890"},"de-DE":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":7651,"overall":"4.3","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"80%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838},"obfuscated_coordinates":{"latitude":28.339303,"longitude":-81.47791},"obfuscation_required":true},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":true},"checkin":{"24_hour":"24-hour check-in","begin_time":"3:00 PM","end_time":"11:00 PM","instructions":"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />","special_instructions":"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.","min_age":18},"checkout":{"time":"11:00 AM"},"fees":{"mandatory":"

    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"},"3321":{"id":"3321","name":"Pet maximum weight in kg is - 24","value":24}}},"amenities":{"9":{"id":"9","name":"Fitness facilities"},"2820":{"id":"2820","name":"Number of indoor pools - 10","value":10}},"images":[{"caption":"Featured Image","hero_image":true,"category":3,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"onsite_payments":{"currency":"USD","types":{"171":{"id":"171","name":"American Express"}}},"rooms":{"224829":{"id":"224829","name":"Single Room","descriptions":{"overview":"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":{"130":{"id":"130","name":"Refrigerator"},"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"}},"images":[{"hero_image":true,"category":21001,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}},"caption":"Guestroom"}],"bed_groups":{"37321":{"id":"37321","description":"1 King Bed","configuration":[{"type":"KingBed","size":"King","quantity":1}]}},"area":{"square_meters":17},"views":{"4134":{"id":"4134","name":"City view"}},"occupancy":{"max_allowed":{"total":3,"children":2,"adults":3},"age_categories":{"ChildAgeA":{"name":"ChildAgeA","minimum_age":3}}}}},"rates":{"333abc":{"id":"333abc","amenities":{"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"},"2104":{"id":"2104","name":"Full Breakfast"}},"special_offer_description":"Breakfast for 2 - Rate includes the following:\r\nMust book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"}},"dates":{"added":"1998-07-20T05:00:00.000Z","updated":"2018-03-22T13:33:17.000Z"},"descriptions":{"amenities":"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.","dining":"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.","renovations":"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ","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.","headline":"Near National Museum of Natural Science","general":"General description"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"airports":{"preferred":{"iata_airport_code":"SGF"}},"themes":{"2337":{"id":"2337","name":"Luxury Hotel"},"2341":{"id":"2341","name":"Spa Hotel"}},"all_inclusive":{"all_rate_plans":true,"some_rate_plans":false,"details":"

    This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).

    Activities and facilities/equipment
    Land activities


    Lessons/classes/games

    Entertainment

    "},"tax_id":"CD-012-987-1234-02","chain":{"id":"-5","name":"Hilton Worldwide"},"brand":{"id":"358","name":"Hampton Inn"},"spoken_languages":{"en":{"id":"en","name":"English"}},"multi_unit":true,"payment_registration_recommended":true,"vacation_rental_details":{"registry_number":"Property Registration Number 123456","private_host":"true","property_manager":{"name":"John Smith","links":{"image":{"method":"GET","href":"https://example.com/profile.jpg"}}},"rental_agreement":{"links":{"rental_agreement":{"method":"GET","href":"https:/example.com/rentalconditions.pdf"}}},"house_rules":["Children welcome","No pets","No smoking","No parties or events"],"amenities":{"2859":{"id":"2859","name":"Private pool"},"4296":{"id":"4296","name":"Furnished balcony or patio"}},"vrbo_srp_id":"123.1234567.5678910","listing_id":"1234567","listing_number":"5678910","listing_source":"HOMEAWAY_US","listing_unit":"/units/0000/32d82dfa-1a48-45d6-9132-49fdbf1bfc60"},"supply_source":"vrbo","registry_number":"Property Registration Number 123456"} + {"property_id":"12345","name":"Test Property Name","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":false,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=12345"},"fr-FR":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=fr-FR&include=address&property_id=12345"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":48382,"overall":"3.1","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"73%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838}},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":false,"updated_expedia_collect":false},"checkin":{"24_hour":"24-hour check-in","begin_time":"3:00 PM","end_time":"11:00 PM","instructions":"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />","special_instructions":"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.","min_age":18},"checkout":{"time":"11:00 AM"},"fees":{"mandatory":"

    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"},"3321":{"id":"3321","name":"Pet maximum weight in kg is - 24","value":24}}},"amenities":{"9":{"id":"9","name":"Fitness facilities"},"2820":{"id":"2820","name":"Number of indoor pools - 10","value":10}},"images":[{"caption":"Featured Image","hero_image":true,"category":3,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"onsite_payments":{"currency":"USD","types":{"171":{"id":"171","name":"American Express"}}},"rooms":{"224829":{"id":"224829","name":"Single Room","descriptions":{"overview":"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":{"130":{"id":"130","name":"Refrigerator"},"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"}},"images":[{"hero_image":true,"category":21001,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}},"caption":"Guestroom"}],"bed_groups":{"37321":{"id":"37321","description":"1 King Bed","configuration":[{"type":"KingBed","size":"King","quantity":1}]}},"area":{"square_meters":20,"square_feet":215},"views":{"4146":{"id":"4146","name":"Courtyard view"}},"occupancy":{"max_allowed":{"total":5,"children":2,"adults":4},"age_categories":{"Adult":{"name":"Adult","minimum_age":9}}}}},"rates":{"333abc":{"id":"333abc","amenities":{"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"},"2104":{"id":"2104","name":"Full Breakfast"}},"special_offer_description":"Breakfast for 2 - Rate includes the following:\r\nMust book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"}},"dates":{"added":"1998-07-19T05:00:00.000Z","updated":"2018-03-22T07:23:14.000Z"},"descriptions":{"amenities":"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.","dining":"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.","renovations":"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ","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.","headline":"Near National Museum of Natural Science","general":"General description"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"airports":{"preferred":{"iata_airport_code":"SGF"}},"themes":{"2337":{"id":"2337","name":"Luxury Hotel"},"2341":{"id":"2341","name":"Spa Hotel"}},"all_inclusive":{"all_rate_plans":true,"some_rate_plans":false,"details":"

    This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).

    Activities and facilities/equipment
    Land activities


    Lessons/classes/games

    Entertainment

    "},"tax_id":"AB-012-987-1234-01","chain":{"id":"-6","name":"Hyatt Hotels"},"brand":{"id":"2209","name":"Hyatt Place"},"spoken_languages":{"vi":{"id":"vi","name":"Vietnamese"}},"multi_unit":true,"payment_registration_recommended":false,"vacation_rental_details": {"registry_number": "Property Registration Number 123456","private_host": "true","property_manager": {"name": "Victor","links": {"image": {"method": "GET","href": "https://test-image/test/test/836f1097-fbcf-43b5-bc02-c8ff6658cb90.c1.jpg"}}},"rental_agreement": {"links": {"rental_agreement": {"method": "GET","href": "https://test-link.test.amazonaws.com/rentalconditions_property_d65e7eb5-4a7c-4a80-a8a3-171999f9f444.pdf"}}},"house_rules": ["Children welcome","No pets","No smoking","No parties or events"],"amenities": {"4296": {"id": "4296","name": "Furnished balcony or patio"},"2859": {"id": "2859","name": "Private pool"}},"vrbo_srp_id": "123.1234567.5678910","listing_id": "1234567","listing_number": "5678910","listing_source": "HOMEAWAY_US","listing_unit": "/units/0000/32d82dfa-1a48-45d6-9132-49fdbf1bfc60"},"supply_source":"vrbo","registry_number":"Property Registration Number 123456"} + {"property_id":"67890","name":"Test Property Name 2","address":{"line_1":"123 Main St","line_2":"Apt A","city":"Springfield","state_province_code":"MO","state_province_name":"Missouri","postal_code":"65804","country_code":"US","obfuscation_required":true,"localized":{"links":{"es-ES":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=es-ES&include=address&property_id=67890"},"de-DE":{"method":"GET","href":"https://api.ean.com/v3/properties/content?language=de-DE&include=address&property_id=67890"}}}},"ratings":{"property":{"rating":"3.5","type":"Star"},"guest":{"count":7651,"overall":"4.3","cleanliness":"4.2","service":"1.1","comfort":"4.3","condition":"1.6","location":"4.0","neighborhood":"3.4","quality":"3.4","value":"2.2","amenities":"1.4","recommendation_percent":"80%"}},"location":{"coordinates":{"latitude":37.15845,"longitude":-93.26838},"obfuscated_coordinates":{"latitude":28.339303,"longitude":-81.47791},"obfuscation_required":true},"phone":"1-417-862-0153","fax":"1-417-863-7249","category":{"id":"1","name":"Hotel"},"rank":42,"business_model":{"expedia_collect":true,"property_collect":true,"updated_expedia_collect":true},"checkin":{"24_hour":"24-hour check-in","begin_time":"3:00 PM","end_time":"11:00 PM","instructions":"Extra-person charges may apply and vary depending on hotel policy. <br />Government-issued photo identification and a credit card or cash deposit are required at check-in for incidental charges. <br />Special requests are subject to availability upon check-in and may incur additional charges. Special requests cannot be guaranteed. <br />","special_instructions":"There is no front desk at this property. To make arrangements for check-in please contact the property ahead of time using the information on the booking confirmation.","min_age":18},"checkout":{"time":"11:00 AM"},"fees":{"mandatory":"

    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"},"3321":{"id":"3321","name":"Pet maximum weight in kg is - 24","value":24}}},"amenities":{"9":{"id":"9","name":"Fitness facilities"},"2820":{"id":"2820","name":"Number of indoor pools - 10","value":10}},"images":[{"caption":"Featured Image","hero_image":true,"category":3,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}}}],"onsite_payments":{"currency":"USD","types":{"171":{"id":"171","name":"American Express"}}},"rooms":{"224829":{"id":"224829","name":"Single Room","descriptions":{"overview":"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":{"130":{"id":"130","name":"Refrigerator"},"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"}},"images":[{"hero_image":true,"category":21001,"links":{"70px":{"method":"GET","href":"https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg"}},"caption":"Guestroom"}],"bed_groups":{"37321":{"id":"37321","description":"1 King Bed","configuration":[{"type":"KingBed","size":"King","quantity":1}]}},"area":{"square_meters":17},"views":{"4134":{"id":"4134","name":"City view"}},"occupancy":{"max_allowed":{"total":3,"children":2,"adults":3},"age_categories":{"ChildAgeA":{"name":"ChildAgeA","minimum_age":3}}}}},"rates":{"333abc":{"id":"333abc","amenities":{"1234":{"id":"1234","name":"Test Amenity - 200","value":"200"},"2104":{"id":"2104","name":"Full Breakfast"}},"special_offer_description":"Breakfast for 2 - Rate includes the following:\r\nMust book this rate plan to receive benefits. Details provided at check-in. Taxes and gratuity may not be included. No refunds for any unused portion of offer. Offer subject to availability. Offer is not valid with groups/conventions and may not be combined with other promotional offers. Other restrictions and blackout dates may apply.\r\n"}},"dates":{"added":"1998-07-20T05:00:00.000Z","updated":"2018-03-22T13:33:17.000Z"},"descriptions":{"amenities":"Don't miss out on the many recreational opportunities, including an outdoor pool, a sauna, and a fitness center. Additional features at this hotel include complimentary wireless Internet access, concierge services, and an arcade/game room.","dining":"Grab a bite at one of the hotel's 3 restaurants, or stay in and take advantage of 24-hour room service. Quench your thirst with your favorite drink at a bar/lounge. Buffet breakfasts are available daily for a fee.","renovations":"During renovations, the hotel will make every effort to minimize noise and disturbance. The property will be renovating from 08 May 2017 to 18 May 2017 (completion date subject to change). The following areas are affected: ","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.","headline":"Near National Museum of Natural Science","general":"General description"},"statistics":{"52":{"id":"52","name":"Total number of rooms - 820","value":"820"},"54":{"id":"54","name":"Number of floors - 38","value":"38"}},"airports":{"preferred":{"iata_airport_code":"SGF"}},"themes":{"2337":{"id":"2337","name":"Luxury Hotel"},"2341":{"id":"2341","name":"Spa Hotel"}},"all_inclusive":{"all_rate_plans":true,"some_rate_plans":false,"details":"

    This resort is all-inclusive. Onsite food and beverages are included in the room price (some restrictions may apply).

    Activities and facilities/equipment
    Land activities


    Lessons/classes/games

    Entertainment

    "},"tax_id":"CD-012-987-1234-02","chain":{"id":"-5","name":"Hilton Worldwide"},"brand":{"id":"358","name":"Hampton Inn"},"spoken_languages":{"en":{"id":"en","name":"English"}},"multi_unit":true,"payment_registration_recommended":true,"vacation_rental_details":{"registry_number":"Property Registration Number 123456","private_host":"true","property_manager":{"name":"John Smith","links":{"image":{"method":"GET","href":"https://example.com/profile.jpg"}}},"rental_agreement":{"links":{"rental_agreement":{"method":"GET","href":"https:/example.com/rentalconditions.pdf"}}},"house_rules":["Children welcome","No pets","No smoking","No parties or events"],"amenities":{"2859":{"id":"2859","name":"Private pool"},"4296":{"id":"4296","name":"Furnished balcony or patio"}},"vrbo_srp_id":"123.1234567.5678910","listing_id":"1234567","listing_number":"5678910","listing_source":"HOMEAWAY_US","listing_unit":"/units/0000/32d82dfa-1a48-45d6-9132-49fdbf1bfc60"},"supply_source":"vrbo","registry_number":"Property Registration Number 123456"} ``` operationId: getPropertyContentFile parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Japanese: - value: ja-JP - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) - for more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Japanese: + value: ja-JP + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) + for more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -3188,31 +3192,31 @@ paths: 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,\ + - 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,\ + 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 + fields: + - name: language + type: querystring + value: xXX "401": description: Unauthorized headers: @@ -3232,18 +3236,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -3283,9 +3287,9 @@ paths: type: file.not_found message: The requested file could not be found. fields: - - name: filename - type: path - value: file.jsonl.gz + - name: filename + type: path + value: file.jsonl.gz "426": description: Upgrade Required headers: @@ -3349,11 +3353,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /regions: get: tags: - - Geography + - Geography summary: Regions description: | Returns the geographic definition and property mappings of regions matching the specified parameters.

    @@ -3364,214 +3368,214 @@ paths: The response is a paginated list of regions. See the `Link` header in the 200 response section. operationId: getRegions parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: include - in: query - 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. - required: true - schema: - type: array - items: - type: string - enum: - - standard - - details - - property_ids - - property_ids_expanded - examples: - Single: - value: standard - Multiple: - value: - - property_ids - - standard - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Japanese: - value: ja-JP - - name: ancestor_id - in: query - description: | - Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of - [top level regions](https://developers.expediagroup.com/docs/rapid/lodging/geography/geography-reference-lists). - schema: - type: string - examples: - Optional: - value: null - Single: - value: 602962 - - name: area - in: query - description: | - Filter the results to regions that intersect with a specified area.

    - The area may be defined in one of two ways: - * radius,region_id - * radius,latitude,longitude - - Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
    - Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
    - Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
    - When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
    - Due to the number of results, unless `point_of_interest` is specified as the only type, regions of type `point_of_interest` - will not be included in a request that filters to an area.

    - An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
    - `&type=airport&limit=3&area=50,37.227924,-93.310036` - schema: - type: string - examples: - Optional: - value: null - Area: - value: "3,602962" - - name: country_code - in: query - description: | - Filter the results to a specified ISO 3166-1 alpha-2 country code. - - For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) - schema: - type: array - items: - type: string - examples: - Optional: - value: null - United States: - value: US - - name: country_subdivision_code - in: query - description: Filter the results down to only the ISO 3166-2 country subdivision. - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Missouri: - value: US-MO - - name: iata_location_code - in: query - description: | - Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. - schema: - type: string - examples: - Optional: - value: null - Springfield: - value: SGF - - name: limit - in: query - description: | - Limit the number of results returned. - Using the area parameter will impose a max value of 100 for this whether specified or not. - schema: - type: number - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. - schema: - type: string - examples: - Optional: - value: null - VRBO: - value: vrbo - - name: type - in: query - description: | - Filter the results to a specified region type. - schema: - type: array - items: - type: string - - name: billing_terms - in: query - 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 separately. - schema: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: include + in: query + 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. + required: true + schema: + type: array + items: type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: + enum: + - standard + - details + - property_ids + - property_ids_expanded + examples: + Single: + value: standard + Multiple: + value: + - property_ids + - standard + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Japanese: + value: ja-JP + - name: ancestor_id + in: query + description: | + Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of + [top level regions](https://developers.expediagroup.com/docs/rapid/lodging/geography/geography-reference-lists). + schema: + type: string + examples: + Optional: + value: null + Single: + value: 602962 + - name: area + in: query + description: | + Filter the results to regions that intersect with a specified area.

    + The area may be defined in one of two ways: + * radius,region_id + * radius,latitude,longitude + + Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
    + Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
    + Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
    + When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
    + Due to the number of results, unless `point_of_interest` is specified as the only type, regions of type `point_of_interest` + will not be included in a request that filters to an area.

    + An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
    + `&type=airport&limit=3&area=50,37.227924,-93.310036` + schema: + type: string + examples: + Optional: + value: null + Area: + value: "3,602962" + - name: country_code + in: query + description: | + Filter the results to a specified ISO 3166-1 alpha-2 country code. + + For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) + schema: + type: array + items: type: string - - name: payment_terms - in: query - 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 separately. - schema: + examples: + Optional: + value: null + United States: + value: US + - name: country_subdivision_code + in: query + description: Filter the results down to only the ISO 3166-2 country subdivision. + schema: + type: array + items: type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: + examples: + Optional: + value: null + Missouri: + value: US-MO + - name: iata_location_code + in: query + description: | + Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. + schema: + type: string + examples: + Optional: + value: null + Springfield: + value: SGF + - name: limit + in: query + description: | + Limit the number of results returned. + Using the area parameter will impose a max value of 100 for this whether specified or not. + schema: + type: number + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. + schema: + type: string + examples: + Optional: + value: null + VRBO: + value: vrbo + - name: type + in: query + description: | + Filter the results to a specified region type. + schema: + type: array + items: type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -3639,96 +3643,96 @@ paths: examples: Regions: value: + - id: "602962" + type: multi_city_vicinity + name: Springfield + name_full: "Springfield, Missouri, United States of America" + descriptor: and vicinity + country_code: US + country_subdivision_code: US-MO + 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" + - 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 + country_subdivision_code: US-MO + coordinates: + center_longitude: -93.29635 + center_latitude: 37.1826 + ancestors: - id: "602962" type: multi_city_vicinity - name: Springfield - name_full: "Springfield, Missouri, United States of America" - descriptor: and vicinity - country_code: US - country_subdivision_code: US-MO - 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" - - 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 - country_subdivision_code: US-MO - 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 - - id: "4605779" - type: airport - name: "Springfield, MO (SGF-Springfield-Branson National)" - name_full: "Springfield, MO, United States (SGF-Springfield-Branson\ + - id: "227" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent + - id: "4605779" + type: airport + name: "Springfield, MO (SGF-Springfield-Branson National)" + name_full: "Springfield, MO, United States (SGF-Springfield-Branson\ \ National)" - iata_airport_code: SGF - country_code: US - country_subdivision_code: US-MO - coordinates: - center_longitude: -93.382095 - center_latitude: 37.24233 - associations: - multi_city_vicinity: - - "6058734" - ancestors: - - id: "602962" - type: multi_city_vicinity - - id: "227" - type: province_state - - id: "201" - type: country - - id: "500001" - type: continent + iata_airport_code: SGF + country_code: US + country_subdivision_code: US-MO + coordinates: + center_longitude: -93.382095 + center_latitude: 37.24233 + associations: + multi_city_vicinity: + - "6058734" + ancestors: + - id: "602962" + type: multi_city_vicinity + - id: "227" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent No regions: value: [] "400": @@ -3781,13 +3785,13 @@ paths: 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,\ + - 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 + fields: + - name: include + type: querystring + value: STANDARD "401": description: Unauthorized headers: @@ -3807,18 +3811,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -4003,130 +4007,130 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /regions/{region_id}: get: tags: - - Geography + - Geography summary: Region description: | Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object. operationId: getRegion parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: region_id - in: path - description: | - ID of the region to retrieve. - required: true - schema: - type: string - example: 178248 - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) - - Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: region_id + in: path + description: | + ID of the region to retrieve. + required: true + schema: + type: string + example: 178248 + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) + + Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + example: en-US + - name: include + in: query + 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. + required: true + style: form + explode: true + schema: + type: array + items: type: string - example: en-US - - name: include - in: query - 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. - required: true - style: form - explode: true - schema: - type: array - items: - type: string - enum: - - details - - property_ids - - property_ids_expanded - example: + enum: - details - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. - schema: - type: string - examples: - Optional: - value: null - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - property_ids + - property_ids_expanded + example: + - details + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. + schema: + type: string + examples: + Optional: + value: null + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -4189,64 +4193,64 @@ paths: 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 + - - - - -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: "215" - type: province_state - - id: "201" - type: country - - id: "500001" - type: continent + - id: "215" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent descendants: high_level_region: - - "6330730" + - "6330730" city: - - "10014" - - "9975" + - "10014" + - "9975" property_ids: - - "37242" - - "859343" + - "37242" + - "859343" property_ids_expanded: - - "37242" - - "859343" - - "48972" + - "37242" + - "859343" + - "48972" Airport: value: id: "4477519" @@ -4262,16 +4266,16 @@ paths: center_latitude: 41.97693 associations: multi_city_vicinity: - - "178248" + - "178248" ancestors: - - id: "178309" - type: province_state - - id: "215" - type: province_state - - id: "201" - type: country - - id: "500001" - type: continent + - id: "178309" + type: province_state + - id: "215" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent "400": description: Bad Request headers: @@ -4322,13 +4326,13 @@ paths: 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,\ + - type: include.invalid + message: "Include is invalid. Accepted include values are: [details,\ \ property_ids, property_ids_expanded]" - fields: - - name: include - type: querystring - value: DETAILS + fields: + - name: include + type: querystring + value: DETAILS "401": description: Unauthorized headers: @@ -4348,18 +4352,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -4421,9 +4425,9 @@ paths: type: region.not_found message: The requested region could not be found. fields: - - name: region_id - type: path - value: "29384729424" + - name: region_id + type: path + value: "29384729424" "426": description: Upgrade Required headers: @@ -4509,11 +4513,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/geography: post: tags: - - Geography + - Geography summary: Properties within Polygon description: | Returns the properties within an custom polygon that represents a multi-city area or smaller. @@ -4523,96 +4527,96 @@ paths: * Number of coordinates - must be <= 2000 operationId: postGeography parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: include - in: query - description: | - Options for which content to return in the response. The value must be lower case. - * property_ids - Include the property IDs. - required: true - schema: - type: string - example: property_ids - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be - supplied once and will return all properties that match the requested supply source. An error is thrown if - the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) - for more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: include + in: query + description: | + Options for which content to return in the response. The value must be lower case. + * property_ids - Include the property IDs. + required: true + schema: + type: string + example: property_ids + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be + supplied once and will return all properties that match the requested supply source. An error is thrown if + the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) + for more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string requestBody: content: application/json: @@ -4727,8 +4731,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: polygon.coordinates_required - message: The polygon must have coordinates. + - type: polygon.coordinates_required + message: The polygon must have coordinates. "401": description: Unauthorized headers: @@ -4748,18 +4752,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -4857,11 +4861,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/availability: get: tags: - - Shopping + - Shopping 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. @@ -4870,337 +4874,337 @@ paths: * 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). operationId: getAvailability parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: checkin + in: query + description: | + Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days. + required: true + schema: + type: string + example: '2025-07-01' + - name: checkout + in: query + description: | + Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations. + required: true + schema: + type: string + example: '2025-07-03' + - name: currency + in: query + description: | + Requested currency for the rates, in ISO 4217 format

    + Currency Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options](https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options) + required: true + schema: + type: string + examples: + Dollar: + value: USD + - name: country_code + in: query + 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.
    + For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) + required: true + schema: + type: string + examples: + United States: + value: US + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
    + Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + - name: occupancy + in: query + 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 + style: form + explode: true + schema: + type: array + items: type: string - example: TravelNow/3.30.112 - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: + examples: + Two: + value: 2 + - name: property_id + in: query + description: | + The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. + required: true + style: form + explode: true + schema: + type: array + items: type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: + examples: + Single: + value: + - 20321 + - name: rate_plan_count + in: query + description: | + The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized.

    + The value must be between 1 and 250. + required: true + schema: + type: number + examples: + Single: + value: 1 + - name: sales_channel + in: query + 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 + schema: + type: string + examples: + Website: + value: website + - name: sales_environment + in: query + 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 + schema: + type: string + examples: + Hotel: + value: hotel_only + - name: amenity_category + in: query + description: | + Single amenity category. Send multiple instances of this parameter to request rates that match multiple amenity categories.
    + See the Amenity Categories section of the + [Content Reference Lists](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) + for a list of values. + style: form + explode: true + schema: + type: array + items: type: string - - name: Test - in: header - 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` - schema: + examples: + Optional: + value: null + Multiple: + value: + - swimming_pool + - name: exclusion + in: query + description: | + Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    + * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. + * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. + schema: + type: array + items: type: string enum: - - standard - - service_unavailable - - unknown_internal_error - - name: checkin - in: query - description: | - Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days. - required: true - schema: - type: string - example: '2025-06-01' - - name: checkout - in: query - description: | - Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations. - required: true - schema: - type: string - example: '2025-06-03' - - name: currency - in: query - description: | - Requested currency for the rates, in ISO 4217 format

    - Currency Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options](https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options) - required: true - schema: - type: string - examples: - Dollar: - value: USD - - name: country_code - in: query - 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.
    - For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) - required: true - schema: - type: string - examples: - United States: - value: US - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
    - Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - - name: occupancy - in: query - 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 - style: form - explode: true - schema: - type: array - items: - type: string - examples: - Two: - value: 2 - - name: property_id - in: query - description: | - The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. - required: true - style: form - explode: true - schema: - type: array - items: - type: string - examples: - Single: - value: - - 20321 - - name: rate_plan_count - in: query - description: | - The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized.

    - The value must be between 1 and 250. - required: true - schema: - type: number - examples: - Single: - value: 1 - - name: sales_channel - in: query - 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 - schema: - type: string - examples: - Website: - value: website - - name: sales_environment - in: query - 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 - schema: - type: string - examples: - Hotel: - value: hotel_only - - name: amenity_category - in: query - description: | - Single amenity category. Send multiple instances of this parameter to request rates that match multiple amenity categories.
    - See the Amenity Categories section of the - [Content Reference Lists](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) - for a list of values. - style: form - explode: true - schema: - type: array - items: - type: string - examples: - Optional: - value: null - Multiple: - value: - - swimming_pool - - name: exclusion - in: query - description: | - Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    - * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. - * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. - schema: - type: array - items: - type: string - enum: - - refundable_damage_deposit - - card_on_file - examples: - Optional: - value: null - Single: - value: - - refundable_damage_deposit - Multiple: - value: - - refundable_damage_deposit - - card_on_file - - name: filter - in: query - 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. - * `loyalty` - Filters results to only show rates that are eligible for loyalty points. - style: form - explode: true - schema: - type: array - items: - type: string - enum: - - refundable - - expedia_collect - - property_collect - examples: - Optional: - value: null - Multiple: - value: - - expedia_collect - - name: include - in: query - description: | - Modify the response by including types of responses that are not provided by default.
    - * `unavailable_reason` - When a property is unavailable for an actionable reason, return a response with that reason - See [Unavailable Reason Codes](https://developers.expediagroup.com/docs/rapid/resources/reference/unavailable-reason-codes) for possible values. - * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `room.rate.sale_scenario` section of the response. - * `rooms.rates.marketing_fee_incentives` - When a rate has a marketing fee incentive applied, the response will include the `marketing_fee_incentives` array if this flag is provided in the request. - * `rooms.rates.current_refundability` - Displays the current `refundability` of a rate. - schema: - type: array - items: - type: string - enum: - - unavailable_reason - - sale_scenario.mobile_promotion - - rooms.rates.marketing_fee_incentives - - rooms.rates.current_refundability - examples: - Optional: - value: null - Multiple: - value: - - unavailable_reason - - name: rate_option - in: query - description: | - Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. - Accepted values:
    - * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. - * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. - * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. - style: form - explode: true - schema: - type: array - items: - type: string - enum: - - member - - net_rates - - cross_sell - - name: travel_purpose - in: query - description: | - This parameter is to specify the travel purpose of the booking. This may impact available rate plans, pricing, or tax calculations. - * `leisure` - * `business` - schema: + - refundable_damage_deposit + - card_on_file + examples: + Optional: + value: null + Single: + value: + - refundable_damage_deposit + Multiple: + value: + - refundable_damage_deposit + - card_on_file + - name: filter + in: query + 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. + * `loyalty` - Filters results to only show rates that are eligible for loyalty points. + style: form + explode: true + schema: + type: array + items: type: string enum: - - leisure - - business - examples: - Optional: - value: null - Single: - value: leisure - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: + - refundable + - expedia_collect + - property_collect + examples: + Optional: + value: null + Multiple: + value: + - expedia_collect + - name: include + in: query + description: | + Modify the response by including types of responses that are not provided by default.
    + * `unavailable_reason` - When a property is unavailable for an actionable reason, return a response with that reason - See [Unavailable Reason Codes](https://developers.expediagroup.com/docs/rapid/resources/reference/unavailable-reason-codes) for possible values. + * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `room.rate.sale_scenario` section of the response. + * `rooms.rates.marketing_fee_incentives` - When a rate has a marketing fee incentive applied, the response will include the `marketing_fee_incentives` array if this flag is provided in the request. + * `rooms.rates.current_refundability` - Displays the current `refundability` of a rate. + schema: + type: array + items: type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: + enum: + - unavailable_reason + - sale_scenario.mobile_promotion + - rooms.rates.marketing_fee_incentives + - rooms.rates.current_refundability + examples: + Optional: + value: null + Multiple: + value: + - unavailable_reason + - name: rate_option + in: query + description: | + Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. + Accepted values:
    + * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. + * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. + * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. + style: form + explode: true + schema: + type: array + items: type: string + enum: + - member + - net_rates + - cross_sell + - name: travel_purpose + in: query + description: | + This parameter is to specify the travel purpose of the booking. This may impact available rate plans, pricing, or tax calculations. + * `leisure` + * `business` + schema: + type: string + enum: + - leisure + - business + examples: + Optional: + value: null + Single: + value: leisure + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -5252,586 +5256,586 @@ paths: examples: Availability: value: - - property_id: "19248" - status: available - rooms: - - id: 123abc - room_name: Fancy Queen Room - rates: - - id: 333abc - status: available - available_rooms: 12 - refundable: true - current_refundability: partially_refundable - member_deal_available: true - sale_scenario: - package: false - member: false - corporate: false - distribution: false - mobile_promotion: false - merchant_of_record: expedia - amenities: - "1234": - id: "1234" - name: Free Wireless Internet - links: - payment_options: - method: GET - href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL - bed_groups: - "12345": - links: - price_check: - method: GET - href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL - expires: '2019-03-05T07:23:14.000Z' - id: "12345" - description: 1 Queen Bed - configuration: - - type: Bed - size: Queen - quantity: 1 - cancel_penalties: - - currency: USD - start: '2018-02-12T11:59:00.000-08:00' - end: '2018-02-12T11:59:00.000-08:00' - amount: "10.00" - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - marketing_fee_incentives: - - source: property - start: '2022-02-02' - end: '2022-02-02' - occupancy_pricing: - "2": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - property_inclusive: - billable_currency: - value: "717.00" - currency: CAD - request_currency: - value: "539.00" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "490.00" - currency: USD - property_inclusive_strikethrough: - billable_currency: - value: "750.00" - currency: CAD - request_currency: - value: "565.00" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "9.00" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - "1-7,10": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "490.00" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "9.00" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - category: entertainment - offer_type: credit - frequency: per_stay - person_count: 1 - deal: - id: 999abc - description: Book early and save 15% - card_on_file_limit: - value: "500.00" - currency: USD - refundable_damage_deposit: - value: "500.00" - currency: USD - deposits: - - value: "70.00" - due: '2025-12-21' + - property_id: "19248" + status: available + rooms: + - id: 123abc + room_name: Fancy Queen Room + rates: + - id: 333abc + status: available + available_rooms: 12 + refundable: true + current_refundability: partially_refundable + member_deal_available: true + sale_scenario: + package: false + member: false + corporate: false + distribution: false + mobile_promotion: false + merchant_of_record: expedia + amenities: + "1234": + id: "1234" + name: Free Wireless Internet + links: + payment_options: + method: GET + href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL + bed_groups: + "12345": + links: + price_check: + method: GET + href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL + expires: '2019-03-05T07:23:14.000Z' + id: "12345" + description: 1 Queen Bed + configuration: + - type: Bed + size: Queen + quantity: 1 + cancel_penalties: + - currency: USD + start: '2018-02-12T11:59:00.000-08:00' + end: '2018-02-12T11:59:00.000-08:00' + amount: "10.00" + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + marketing_fee_incentives: + - source: property + start: '2022-02-02' + end: '2022-02-02' + occupancy_pricing: + "2": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" currency: USD - links: - additional_rates: - method: GET - href: /v3/properties/12345/availability?token=MY5S3j36cOcL - score: 10052 - Availability and Unavailable Reason: - value: - - property_id: "824739" - status: partially_unavailable - score: 12345 - unavailable_reason: - code: adults_exceed_threshold - data: "2" - - property_id: "19248" - status: available - rooms: - - id: 123abc - room_name: Fancy Queen Room - rates: - - id: 333abc - status: available - available_rooms: 12 - refundable: true - member_deal_available: true - sale_scenario: - package: false - member: false - corporate: false - distribution: false - mobile_promotion: false - merchant_of_record: expedia - amenities: - "1234": - id: "1234" - name: Free Wireless Internet - links: - payment_options: - method: GET - href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL - bed_groups: - "12345": - links: - price_check: - method: GET - href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL - expires: '2019-03-05T07:23:14.000Z' - id: "12345" - description: 1 Queen Bed - configuration: - - type: Bed - size: Queen - quantity: 1 - cancel_penalties: - - currency: USD - start: '2018-02-12T11:59:00.000-08:00' - end: '2018-02-12T11:59:00.000-08:00' - amount: "10.00" - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - occupancy_pricing: - "2": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - "1-7,10": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - category: entertainment - offer_type: credit - frequency: per_stay - person_count: 1 - deal: - id: 999abc - description: Book early and save 15% - card_on_file_limit: - value: "500.00" - currency: USD - refundable_damage_deposit: - value: "500.00" - currency: USD - deposits: - - value: "70.00" - due: '2025-12-21' + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" currency: USD - links: - additional_rates: - method: GET - href: /v3/properties/12345/availability?token=MY5S3j36cOcL - score: 10052 - No availability: - value: [] - "400": - description: Bad Request - headers: - Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number - Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number - Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number - Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number - Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ + property_inclusive: + billable_currency: + value: "717.00" + currency: CAD + request_currency: + value: "539.00" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "490.00" + currency: USD + property_inclusive_strikethrough: + billable_currency: + value: "750.00" + currency: CAD + request_currency: + value: "565.00" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "9.00" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + "1-7,10": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "490.00" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "9.00" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + category: entertainment + offer_type: credit + frequency: per_stay + person_count: 1 + deal: + id: 999abc + description: Book early and save 15% + card_on_file_limit: + value: "500.00" + currency: USD + refundable_damage_deposit: + value: "500.00" + currency: USD + deposits: + - value: "70.00" + due: '2025-12-21' + currency: USD + links: + additional_rates: + method: GET + href: /v3/properties/12345/availability?token=MY5S3j36cOcL + score: 10052 + Availability and Unavailable Reason: + value: + - property_id: "824739" + status: partially_unavailable + score: 12345 + unavailable_reason: + code: adults_exceed_threshold + data: "2" + - property_id: "19248" + status: available + rooms: + - id: 123abc + room_name: Fancy Queen Room + rates: + - id: 333abc + status: available + available_rooms: 12 + refundable: true + member_deal_available: true + sale_scenario: + package: false + member: false + corporate: false + distribution: false + mobile_promotion: false + merchant_of_record: expedia + amenities: + "1234": + id: "1234" + name: Free Wireless Internet + links: + payment_options: + method: GET + href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL + bed_groups: + "12345": + links: + price_check: + method: GET + href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL + expires: '2019-03-05T07:23:14.000Z' + id: "12345" + description: 1 Queen Bed + configuration: + - type: Bed + size: Queen + quantity: 1 + cancel_penalties: + - currency: USD + start: '2018-02-12T11:59:00.000-08:00' + end: '2018-02-12T11:59:00.000-08:00' + amount: "10.00" + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + occupancy_pricing: + "2": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + "1-7,10": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + category: entertainment + offer_type: credit + frequency: per_stay + person_count: 1 + deal: + id: 999abc + description: Book early and save 15% + card_on_file_limit: + value: "500.00" + currency: USD + refundable_damage_deposit: + value: "500.00" + currency: USD + deposits: + - value: "70.00" + due: '2025-12-21' + currency: USD + links: + additional_rates: + method: GET + href: /v3/properties/12345/availability?token=MY5S3j36cOcL + score: 10052 + No availability: + value: [] + "400": + description: Bad Request + headers: + Rate-Limit-Day: + description: Reserved for future use. Optional header for request capacity + per day. + schema: + type: number + Rate-Limit-Day-Remaining: + description: "Optional header for the remaining capacity, as a percentage,\ + \ for the daily time window." + schema: + type: number + Rate-Limit-Day-Reset: + description: "Optional header for the timestamp, as the number of milliseconds\ + \ since the Unix Epoch, when the daily capacity resets." + schema: + type: number + Rate-Limit-Minute: + description: Reserved for future use. Optional header for request capacity + per minute. + schema: + type: number + Rate-Limit-Minute-Remaining: + description: "Optional header for the remaining capacity, as a percentage,\ \ for the per minute time window." schema: type: number @@ -5857,36 +5861,36 @@ paths: 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: checkout.invalid_length_of_stay_too_long_vrbo - message: | - Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. - fields: - - name: checkin - type: querystring - value: '2024-09-21' - - name: checkout - type: querystring - value: '2025-10-21' - - type: number_of_occupancies.invalid_above_maximum - message: Number of occupancies must be less than 9. - fields: - - name: occupancy - type: querystring - value: "9" - - type: include.not_supported - message: | - Include value not supported. Supported include values are: [unavailable_reason] - fields: - - name: include - type: querystring - value: free_money + - 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: checkout.invalid_length_of_stay_too_long_vrbo + message: | + Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. + fields: + - name: checkin + type: querystring + value: '2024-09-21' + - name: checkout + type: querystring + value: '2025-10-21' + - type: number_of_occupancies.invalid_above_maximum + message: Number of occupancies must be less than 9. + fields: + - name: occupancy + type: querystring + value: "9" + - type: include.not_supported + message: | + Include value not supported. Supported include values are: [unavailable_reason] + fields: + - name: include + type: querystring + value: free_money "401": description: Unauthorized headers: @@ -5906,18 +5910,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -6015,11 +6019,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/availability: get: tags: - - Shopping + - Shopping summary: Get additional property room rates and availability description: | Returns additional rates on available room types, using the parameters of the previous call. The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. @@ -6027,242 +6031,242 @@ paths: * 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). operationId: getAdditionalAvailability parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - 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` - * `no_availability` - * `forbidden` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - no_availability - - forbidden - - name: property_id - in: path - description: | - Expedia Property ID.
    - required: true - schema: - type: string - example: 19248 - - name: token - in: query - description: "A hashed collection of query parameters. Used to maintain state\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + 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` + * `no_availability` + * `forbidden` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - no_availability + - forbidden + - name: property_id + in: path + description: | + Expedia Property ID.
    + required: true + schema: + type: string + example: 19248 + - name: token + in: query + description: "A hashed collection of query parameters. Used to maintain state\ \ across calls. This token is provided as part of the `additional_rates`\ \ link from the shop response, or the `shop` link on a `sold_out` price\ \ check response. It is also provided from the `shop_for_change` link on\ \ an itinerary retrieve." - required: true - schema: + required: true + schema: + type: string + - name: checkin + in: query + description: | + Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days.
    + Note: Only needed for hard change if desired check-in date is different than original booking. + If specified must also specify `checkout`. + schema: + type: string + example: '2025-07-01' + - name: checkout + in: query + description: | + Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations.
    + Note: Only needed for hard change if desired check-out date is different than original booking. + If specified must also specify `checkin`.
    + schema: + type: string + example: '2025-07-03' + - name: exclusion + in: query + description: | + Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    + Note: Optional parameter for use with hard change requests.
    + * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. + * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. + style: form + explode: true + schema: + type: array + items: type: string - - name: checkin - in: query - description: | - Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days.
    - Note: Only needed for hard change if desired check-in date is different than original booking. - If specified must also specify `checkout`. - schema: + enum: + - refundable_damage_deposit + - card_on_file + examples: + Optional: + value: null + Single: + value: + - refundable_damage_deposit + Multiple: + value: + - refundable_damage_deposit + - card_on_file + - name: filter + in: query + description: | + Single filter type. Send multiple instances of this parameter to request multiple filters.
    + Note: Optional parameter for use with hard change requests.
    + This parameter cannot be set to `property_collect` if the existing booking is `expedia_collect` and vice versa.
    + * `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. + * `loyalty` - Filters results to only show rates that are eligible for loyalty points. + style: form + explode: true + schema: + type: array + items: type: string - example: '2025-06-01' - - name: checkout - in: query - description: | - Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations.
    - Note: Only needed for hard change if desired check-out date is different than original booking. - If specified must also specify `checkin`.
    - schema: + enum: + - refundable + - expedia_collect + - property_collect + examples: + Optional: + value: null + Refundable: + value: refundable + ExpediaCollect: + value: expedia_collect + Multiple: + value: + - refundable + - expedia_collect + - name: include + in: query + description: | + Modify the response by including types of responses that are not provided by default.
    + * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `sale_scenario` section of the response. + schema: + type: array + items: type: string - example: '2025-06-03' - - name: exclusion - in: query - description: | - Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    - Note: Optional parameter for use with hard change requests.
    - * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. - * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. - style: form - explode: true - schema: - type: array - items: - type: string - enum: - - refundable_damage_deposit - - card_on_file - examples: - Optional: - value: null - Single: - value: - - refundable_damage_deposit - Multiple: - value: - - refundable_damage_deposit - - card_on_file - - name: filter - in: query - description: | - Single filter type. Send multiple instances of this parameter to request multiple filters.
    - Note: Optional parameter for use with hard change requests.
    - This parameter cannot be set to `property_collect` if the existing booking is `expedia_collect` and vice versa.
    - * `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. - * `loyalty` - Filters results to only show rates that are eligible for loyalty points. - style: form - explode: true - schema: - type: array - items: - type: string - enum: - - refundable - - expedia_collect - - property_collect - examples: - Optional: - value: null - Refundable: - value: refundable - ExpediaCollect: - value: expedia_collect - Multiple: - value: - - refundable - - expedia_collect - - name: include - in: query - description: | - Modify the response by including types of responses that are not provided by default.
    - * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `sale_scenario` section of the response. - schema: - type: array - items: - type: string - enum: - - sale_scenario.mobile_promotion - examples: - Optional: - value: null - MobilePromotion: - value: sale_scenario.mobile_promotion - - name: occupancy - in: query - 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.
    - Note: Only needed for hard change if desired occupancy is different than original booking.
    - Examples: - * 2 adults, one 9-year-old and one 4-year-old would be represented by `occupancy=2-9,4`.
    - * A multi-room request to lodge an additional 2 adults would be represented by `occupancy=2-9,4&occupancy=2` - style: form - explode: true - schema: - type: array - items: - type: string - - name: rate_option - in: query - description: | - Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. - Note: Optional parameter for use with hard change requests.
    - Accepted values:
    - * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. - * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. - * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. - style: form - explode: true - schema: - type: array - items: - type: string - enum: - - member - - net_rates - - cross_sell - examples: - Optional: - value: null - Member: - value: member - NetRates: - value: net_rates - Multiple: - value: - - member - - net_rates - - name: sales_channel - in: query - description: | - Provide the sales channel if you wish to override the sales_channel provided in the previous call. EPS dynamically provides the best content for optimal conversion on each sales channel.
    - Note: Must specify this value for hard change requests.
    - * `website` - Standard website accessed from the customer's computer - * `agent_tool` - Your own agent tool used by your call center or retail store agent - * `mobile_app` - An application installed on a phone or tablet device - * `mobile_web` - A web browser application on a phone or tablet device - * `meta` - Rates will be passed to and displayed on a 3rd party comparison website - * `cache` - Rates will be used to populate a local cache - schema: + enum: + - sale_scenario.mobile_promotion + examples: + Optional: + value: null + MobilePromotion: + value: sale_scenario.mobile_promotion + - name: occupancy + in: query + 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.
    + Note: Only needed for hard change if desired occupancy is different than original booking.
    + Examples: + * 2 adults, one 9-year-old and one 4-year-old would be represented by `occupancy=2-9,4`.
    + * A multi-room request to lodge an additional 2 adults would be represented by `occupancy=2-9,4&occupancy=2` + style: form + explode: true + schema: + type: array + items: type: string - - name: currency - in: query - description: | - Determines the returned currency type throughout the response
    - Note: This parameter is only valid for hard change requests and is ignored in all other cases - schema: + - name: rate_option + in: query + description: | + Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. + Note: Optional parameter for use with hard change requests.
    + Accepted values:
    + * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. + * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. + * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. + style: form + explode: true + schema: + type: array + items: type: string + enum: + - member + - net_rates + - cross_sell + examples: + Optional: + value: null + Member: + value: member + NetRates: + value: net_rates + Multiple: + value: + - member + - net_rates + - name: sales_channel + in: query + description: | + Provide the sales channel if you wish to override the sales_channel provided in the previous call. EPS dynamically provides the best content for optimal conversion on each sales channel.
    + Note: Must specify this value for hard change requests.
    + * `website` - Standard website accessed from the customer's computer + * `agent_tool` - Your own agent tool used by your call center or retail store agent + * `mobile_app` - An application installed on a phone or tablet device + * `mobile_web` - A web browser application on a phone or tablet device + * `meta` - Rates will be passed to and displayed on a 3rd party comparison website + * `cache` - Rates will be used to populate a local cache + schema: + type: string + - name: currency + in: query + description: | + Determines the returned currency type throughout the response
    + Note: This parameter is only valid for hard change requests and is ignored in all other cases + schema: + type: string responses: "200": description: OK @@ -6314,274 +6318,274 @@ paths: examples: Availability: value: - - property_id: 19248 - rooms: - - id: 123abc - room_name: Fancy Queen Room - rates: - - id: 333abc - status: available - available_rooms: 12 - refundable: true - member_deal_available: true - sale_scenario: - package: false - member: false - corporate: false - distribution: false - mobile_promotion: false - merchant_of_record: expedia - amenities: - "1234": - id: 1234 - name: Free Wireless Internet - links: - payment_options: - method: GET - href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL - bed_groups: - "12345": - links: - price_check: - method: GET - href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL - expires: '2019-03-05T07:23:14.000Z' - id: "12345" - description: 1 Queen Bed - configuration: - - type: Bed - size: Queen - quantity: 1 - cancel_penalties: - - currency: USD - start: '2018-02-12T11:59:00.000-08:00' - end: '2018-02-12T11:59:00.000-08:00' - amount: "10.00" - nights: 1 - percent: 30% - occupancy_pricing: - "2": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - "1-7,10": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - category: entertainment - offer_type: credit - frequency: per_stay - person_count: 1 - deal: - id: 999abc - description: Book early and save 15% - card_on_file_limit: - value: "500.00" - currency: USD - refundable_damage_deposit: - value: "500.00" - currency: USD - deposits: - - value: "70.00" - due: '2025-12-21' + - property_id: 19248 + rooms: + - id: 123abc + room_name: Fancy Queen Room + rates: + - id: 333abc + status: available + available_rooms: 12 + refundable: true + member_deal_available: true + sale_scenario: + package: false + member: false + corporate: false + distribution: false + mobile_promotion: false + merchant_of_record: expedia + amenities: + "1234": + id: 1234 + name: Free Wireless Internet + links: + payment_options: + method: GET + href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL + bed_groups: + "12345": + links: + price_check: + method: GET + href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL + expires: '2019-03-05T07:23:14.000Z' + id: "12345" + description: 1 Queen Bed + configuration: + - type: Bed + size: Queen + quantity: 1 + cancel_penalties: + - currency: USD + start: '2018-02-12T11:59:00.000-08:00' + end: '2018-02-12T11:59:00.000-08:00' + amount: "10.00" + nights: 1 + percent: 30% + occupancy_pricing: + "2": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" currency: USD - links: - additional_rates: - method: GET - href: /v3/properties/12345/availability?token=MY5S3j36cOcL - score: 10052 + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + "1-7,10": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + category: entertainment + offer_type: credit + frequency: per_stay + person_count: 1 + deal: + id: 999abc + description: Book early and save 15% + card_on_file_limit: + value: "500.00" + currency: USD + refundable_damage_deposit: + value: "500.00" + currency: USD + deposits: + - value: "70.00" + due: '2025-12-21' + currency: USD + links: + additional_rates: + method: GET + href: /v3/properties/12345/availability?token=MY5S3j36cOcL + score: 10052 No availability: value: [] "400": @@ -6634,35 +6638,35 @@ paths: 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: checkout.invalid_length_of_stay_too_long_vrbo - message: | - Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. - fields: - - name: checkin - type: querystring - value: '2024-09-21' - - name: checkout - type: querystring - value: '2025-10-21' - - type: number_of_occupancies.invalid_above_maximum - message: Number of occupancies must be less than 9. - fields: - - name: occupancy - type: querystring - value: 9 - - type: filter.mismatch - message: "Existing booking is expedia_collect, this cannot be changed." - fields: - - name: filter - type: querystring - value: property_collect + - 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: checkout.invalid_length_of_stay_too_long_vrbo + message: | + Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. + fields: + - name: checkin + type: querystring + value: '2024-09-21' + - name: checkout + type: querystring + value: '2025-10-21' + - type: number_of_occupancies.invalid_above_maximum + message: Number of occupancies must be less than 9. + fields: + - name: occupancy + type: querystring + value: 9 + - type: filter.mismatch + message: "Existing booking is expedia_collect, this cannot be changed." + fields: + - name: filter + type: querystring + value: property_collect "401": description: Unauthorized headers: @@ -6682,18 +6686,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -6788,109 +6792,109 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/rooms/{room_id}/rates/{rate_id}: get: tags: - - Shopping + - Shopping summary: Price-Check description: | Confirms the price returned by the Property Availability response. Use this API to verify a previously-selected rate is still valid before booking. If the price is matched, the response returns a link to request a booking. If the price has changed, the response returns new price details and a booking link for the new price. If the rate is no longer available, the response will return a new Property Availability request link to search again for different rates. In the event of a price change, go back to Property Availability and book the property at the new price or return to additional rates for the property. operationId: priceCheck parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - description: | - Price check calls have a test header that can be used to return set responses with the following keywords: - * `available` - * `price_changed` - * `sold_out` - * `service_unavailable` - * `unknown_internal_error` - schema: - type: string - enum: - - available - - price_changed - - sold_out - - service_unavailable - - unknown_internal_error - - name: property_id - in: path - description: | - Expedia Property ID.
    - required: true - schema: - type: string - example: 19248 - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: rate_id - in: path - description: | - Rate ID of a room.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - description: A hashed collection of query parameters. Used to maintain state - across calls. This token is provided as part of the price check link from - the shop response. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + description: | + Price check calls have a test header that can be used to return set responses with the following keywords: + * `available` + * `price_changed` + * `sold_out` + * `service_unavailable` + * `unknown_internal_error` + schema: + type: string + enum: + - available + - price_changed + - sold_out + - service_unavailable + - unknown_internal_error + - name: property_id + in: path + description: | + Expedia Property ID.
    + required: true + schema: + type: string + example: 19248 + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: rate_id + in: path + description: | + Rate ID of a room.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + description: A hashed collection of query parameters. Used to maintain state + across calls. This token is provided as part of the price check link from + the shop response. + required: true + schema: + type: string responses: "200": description: OK @@ -6944,12 +6948,12 @@ paths: occupancy_pricing: "2": nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD totals: inclusive: billable_currency: @@ -6980,9 +6984,9 @@ paths: value: "500.00" currency: USD deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD + - value: "70.00" + due: '2025-12-21' + currency: USD links: book: method: POST @@ -6994,12 +6998,12 @@ paths: occupancy_pricing: "2": nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD totals: inclusive: billable_currency: @@ -7025,20 +7029,20 @@ paths: currency: USD trader_information: traders: - - name: Test Property Name - address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" - country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf links: book: @@ -7051,12 +7055,12 @@ paths: occupancy_pricing: "2": nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD totals: inclusive: billable_currency: @@ -7087,9 +7091,9 @@ paths: value: "500.00" currency: USD deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD + - value: "70.00" + due: '2025-12-21' + currency: USD amount_owed: billable_currency: value: "132.56" @@ -7245,8 +7249,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -7266,18 +7270,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -7375,75 +7379,75 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/payment-options: get: tags: - - Shopping + - Shopping summary: Get Accepted Payment Types - EPS MOR Only description: | Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking. operationId: getPaymentOptions parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: property_id - in: path - description: | - Expedia Property ID.
    - required: true - schema: - type: string - example: 19248 - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: property_id + in: path + description: | + Expedia Property ID.
    + required: true + schema: + type: string + example: 19248 + - name: token + in: query + 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. + required: true + schema: + type: string responses: "200": description: OK @@ -7496,9 +7500,9 @@ paths: credit_card: name: Credit Card card_options: - - name: AmericanExpress - - name: MasterCard - processing_country: US + - name: AmericanExpress + - name: MasterCard + processing_country: US merchant: name: TRAVEL RESERVATION "400": @@ -7551,8 +7555,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "404": description: Not Found headers: @@ -7603,15 +7607,15 @@ paths: message: The requested property returned no payment options that are enabled for this point of sale. fields: - - name: property_id - type: path - value: "1337" - - name: token.currency - type: querystring - value: USD - - name: token.country_code - type: querystring - value: US + - name: property_id + type: path + value: "1337" + - name: token.currency + type: querystring + value: USD + - name: token.country_code + type: querystring + value: US "426": description: Upgrade Required headers: @@ -7694,11 +7698,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /calendars/availability: get: tags: - - Shopping + - Shopping summary: Get a calendar of availability dates for properties. This is currently a Vrbo property only feature. description: | @@ -7707,88 +7711,88 @@ paths: and information regarding the stay constraints. operationId: getCalendarAvailability parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Authorization - in: header - description: "The custom generated authentication header. Refer to our [signature\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Authorization + in: header + description: "The custom generated authentication header. Refer to our [signature\ \ authentication](https://developer.expediapartnersolutions.com/reference/signature-authentication)\ \ page for full details." - required: true - schema: - type: string - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: property_id - in: query - description: | - The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. - required: true - style: form - explode: true - schema: - type: array - items: - type: string - examples: - Single: - value: 1234 - Multiple: - value: - - 1234 - - 5678 - - name: start_date - in: query - description: | - The first day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD), up to 500 days in the future from the current date. - required: true - schema: + required: true + schema: + type: string + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: property_id + in: query + description: | + The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. + required: true + style: form + explode: true + schema: + type: array + items: type: string - format: date - example: '2025-06-15' - - name: end_date - in: query - description: | - The last day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD). This must be 365 days or less from the start_date. - required: true - schema: - type: string - format: date - example: '2025-12-17' + examples: + Single: + value: 1234 + Multiple: + value: + - 1234 + - 5678 + - name: start_date + in: query + description: | + The first day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD), up to 500 days in the future from the current date. + required: true + schema: + type: string + format: date + example: '2025-07-15' + - name: end_date + in: query + description: | + The last day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD). This must be 365 days or less from the start_date. + required: true + schema: + type: string + format: date + example: '2026-01-17' responses: "200": description: OK @@ -7840,42 +7844,42 @@ paths: examples: Single Property Availability: value: - - property_id: "1234" - days: - - date: '2022-09-20' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 14 - - date: '2022-09-21' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 14 + - property_id: "1234" + days: + - date: '2022-09-20' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 14 + - date: '2022-09-21' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 14 Multi Property Availability: value: - - property_id: "1234" - days: - - date: '2022-09-20' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 14 - - property_id: "5678" - days: - - date: '2022-09-20' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 5 + - property_id: "1234" + days: + - date: '2022-09-20' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 14 + - property_id: "5678" + days: + - date: '2022-09-20' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 5 No Results: value: [] "400": @@ -7928,19 +7932,19 @@ paths: 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" + - 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" "401": description: Unauthorized headers: @@ -7960,18 +7964,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -8069,90 +8073,90 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /payment-sessions: post: tags: - - Bookings + - Bookings summary: Register Payments description: | This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
    This link will be available in the Price Check response if payment registration is required. It returns a payment session ID and a link to create a booking. This will be the first step in the booking flow only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. Learn more with our [PSD2 Overview](https://developers.expediagroup.com/docs/rapid/lodging/booking/psd2-regulation) operationId: postPaymentSessions parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: content: application/json: @@ -8263,11 +8267,11 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: payments.required - message: Payment is required. - fields: - - name: payments - type: body + - type: payments.required + message: Payment is required. + fields: + - name: payments + type: body "401": description: Unauthorized headers: @@ -8287,18 +8291,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -8396,11 +8400,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries: get: tags: - - Manage Booking + - Manage Booking summary: Search for and retrieve Bookings with Affiliate Reference Id description: | This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. @@ -8408,88 +8412,88 @@ paths: Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to search for an itinerary that was successfully created, or if you receive a response with two fields, namely, `itinerary_id` and `creation_date_time`, then please wait a few minutes before trying to search for the itinerary again. operationId: getReservation parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - 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. - * `degraded_response` - Requires valid test booking - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: affiliate_reference_id - in: query - description: | - The affilliate reference id value. This field supports a maximum of 28 characters. - required: true - schema: - type: string - examples: - Single: - value: 111A222BB33344CC5555 - - name: email - in: query - description: | - Email associated with the booking. Special characters in the local part or domain should be encoded.
    - required: true - schema: - type: string - examples: - Single: - value: test@example.com - - name: include - in: query - description: "Options for which information to return in the response. The\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + 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. + * `degraded_response` - Requires valid test booking + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: affiliate_reference_id + in: query + description: | + The affilliate reference id value. This field supports a maximum of 28 characters. + required: true + schema: + type: string + examples: + Single: + value: 111A222BB33344CC5555 + - name: email + in: query + description: | + Email associated with the booking. Special characters in the local part or domain should be encoded.
    + required: true + schema: + type: string + examples: + Single: + value: test@example.com + - name: include + in: query + description: "Options for which information to return in the response. The\ \ value must be lower case.\n* `history` - Include itinerary history, showing\ \ details of the changes made to this itinerary. Changes from the property/supplier\ \ have an event_source equal to `other` in the response. \n* `history_v2`\ @@ -8497,18 +8501,18 @@ paths: \ itinerary. Changes from the property/supplier have an event_source equal\ \ to `supplier` in the response. See the [Itinerary history](https://developers.expediagroup.com/docs/rapid/lodging/manage-booking/itinerary-history#overview)\ \ for details.\n" - required: false - schema: - type: array - items: - type: string - enum: - - history - examples: - Optional: - value: null - History: - value: history + required: false + schema: + type: array + items: + type: string + enum: + - history + examples: + Optional: + value: null + History: + value: history responses: "200": description: OK @@ -8560,618 +8564,128 @@ paths: examples: Itineraries: value: - - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - non_vat_expedia_invoice: - method: GET - href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: -65.98 - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: leisure - trader_information: - traders: - - name: Test Property Name - address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" - country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply - terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf - Itinerary with History and Change - Extend Stay: - value: - - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" + - itinerary_id: "8999989898988" property_id: "8150374" links: cancel: method: DELETE href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + non_vat_expedia_invoice: + method: GET + href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m email: smith@example.com phone: country_code: "1" area_code: "487" number: "5550077" rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -9184,10 +8698,10 @@ paths: postal_code: "98121" country_code: US adjustment: - value: "-32.10" + value: -100.0 type: base_rate currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' + creation_date_time: '2017-08-17T13:31:15.523Z' affiliate_reference_id: 4480ABC affiliate_metadata: This booking was made with EPS. conversations: @@ -9195,201 +8709,978 @@ paths: property: method: GET href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: canceled - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - No itineraries: - value: [] - "206": - description: Partial Content - headers: - Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. + travel_purpose: business + trader_information: + traders: + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply + terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + invoicing: + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + point_of_sale_display: Global Travel Site + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itineraries with Property Collect: + value: + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + non_vat_expedia_invoice: + method: GET + href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: property + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + trader_information: + traders: + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply + terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itinerary with History and Change - Extend Stay: + value: + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: canceled + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + No itineraries: + value: [] + "206": + description: Partial Content + headers: + Rate-Limit-Day: + description: Reserved for future use. Optional header for request capacity + per day. schema: type: number Rate-Limit-Day-Remaining: @@ -9434,508 +9725,441 @@ paths: examples: Itineraries: value: - - itinerary_id: "8999989898988" - property_id: "8150374" + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + non_vat_expedia_invoice: + method: GET + href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD links: cancel: method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - non_vat_expedia_invoice: + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: method: GET - href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith + href: https://www.example.com?key=123abd456 + travel_purpose: business + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + trader_information: + traders: + - name: Test Property Name address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: leisure - trader_information: - traders: - - name: Test Property Name - address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" - country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply - terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply + terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing Itinerary with History and Change - Extend Stay: value: - - itinerary_id: "8999989898988" - property_id: "8150374" + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD links: cancel: method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: value: "-32.10" - type: base_rate currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" + - type: sales_tax + value: "11.12" currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -9944,20 +10168,19 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -9968,31 +10191,28 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -10023,13 +10243,115 @@ paths: billable_currency: value: "11.95" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -10055,197 +10377,197 @@ paths: href: https://www.example.com?key=123abd456 travel_purpose: unspecified impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: canceled + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: canceled - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD No itineraries: value: [] "400": @@ -10298,12 +10620,12 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: email.invalid - message: Customer email address is invalid. - fields: - - name: email - type: querystring - value: thisisabademail + - type: email.invalid + message: Customer email address is invalid. + fields: + - name: email + type: querystring + value: thisisabademail "401": description: Unauthorized headers: @@ -10323,18 +10645,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -10432,100 +10754,220 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] post: tags: - - Bookings + - Bookings summary: Create Booking description: | This link will be available in the Price Check response or in the register payments response when Two-Factor Authentication is used. It returns an itinerary id and links to retrieve reservation details, cancel a held booking, resume a held booking or complete payment session. Please note that depending on the state of the booking, the response will contain only the applicable link(s). operationId: postItinerary parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The book call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - * `complete_payment_session` - * `service_unavailable` - * `internal_server_error` - * `price_mismatch` - * `cc_declined` - * `rooms_unavailable` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - price_mismatch - - cc_declined - - rooms_unavailable - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The book call has a test header that can be used to return set responses with the following keywords:
    + * `standard` + * `complete_payment_session` + * `service_unavailable` + * `internal_server_error` + * `price_mismatch` + * `cc_declined` + * `rooms_unavailable` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - price_mismatch + - cc_declined + - rooms_unavailable + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateItineraryRequest' + examples: + Create Booking with Credit Card: + value: + affiliate_reference_id: 4480ABC + hold: false + email: john@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - given_name: John + family_name: Smith + smoking: false + special_request: Top floor or away from street please + loyalty_id: ABC123 + payments: + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + enrollment_date: '2018-09-15' + third_party_authentication: + cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= + eci: "05" + three_ds_version: 2.2.0 + ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de + pa_res_status: "Y" + ve_res_status: C + xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 + cavv_algorithm: "3" + ucaf_indicator: "0" + affiliate_metadata: data_point_1:123|data_point2:This is data. + tax_registration_number: "12345678910" + traveler_handling_instructions: Please use the card provided for + payment. Avoid cancelation as this is for a corporate traveler. + Contact traveler if any issues. + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + Create Booking with Virtual Card: + value: + affiliate_reference_id: 4480ABC + hold: false + email: john@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - given_name: John + family_name: Smith + smoking: false + special_request: Top floor or away from street please + loyalty_id: ABC123 + payments: + - type: virtual_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true required: true responses: "201": @@ -10654,25 +11096,25 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: address.country_code.invalid - message: Address country code is invalid. - fields: - - name: country_code - type: body - value: ABCD + - type: address.country_code.invalid + message: Address country code is invalid. + fields: + - name: country_code + type: body + value: ABCD Duplicate Itinerary Example: value: type: invalid_input message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: duplicate_itinerary - message: An itinerary already exists with this affiliate reference - id. - fields: - - name: affiliate_reference_id - type: body - value: ABCD + - type: duplicate_itinerary + message: An itinerary already exists with this affiliate reference + id. + fields: + - name: affiliate_reference_id + type: body + value: ABCD "401": description: Unauthorized headers: @@ -10692,18 +11134,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -10766,12 +11208,12 @@ paths: 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" + - name: payments.amount + type: body + value: "100.00" + - name: price.amount + type: body + value: "120.00" "410": description: Sold Out headers: @@ -10905,11 +11347,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}: get: tags: - - Manage Booking + - Manage Booking summary: Retrieve Booking description: | This API call returns itinerary details and links to resume or cancel the booking. There are two methods to retrieve a booking: @@ -10919,93 +11361,93 @@ paths: 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, or if you receive a response with two fields, namely, `itinerary_id` and `creation_date_time`, then please wait a few minutes before trying to retrieve the itinerary again. operationId: getReservationByItineraryId parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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. - * `degraded_response` - Requires valid test booking - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - schema: - type: string - - name: email - in: query - description: | - Email associated with the booking. Special characters in the local part or domain should be encoded. (Email is required if the token is not provided the request)
    - schema: - type: string - examples: - Optional: - value: null - Single: - value: test@example.com - - name: include - in: query - description: "Options for which information to return in the response. The\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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. + * `degraded_response` - Requires valid test booking + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + schema: + type: string + - name: email + in: query + description: | + Email associated with the booking. Special characters in the local part or domain should be encoded. (Email is required if the token is not provided the request)
    + schema: + type: string + examples: + Optional: + value: null + Single: + value: test@example.com + - name: include + in: query + description: "Options for which information to return in the response. The\ \ value must be lower case.\n* `history` - Include itinerary history, showing\ \ details of the changes made to this itinerary. Changes from the property/supplier\ \ have an event_source equal to `other` in the response. \n* `history_v2`\ @@ -11013,18 +11455,18 @@ paths: \ itinerary. Changes from the property/supplier have an event_source equal\ \ to `supplier` in the response. See the [Itinerary history](https://developers.expediagroup.com/docs/rapid/lodging/manage-booking/itinerary-history#overview)\ \ for details.\n" - required: false - schema: - type: array - items: - type: string - enum: - - history - examples: - Optional: - value: null - History: - value: history + required: false + schema: + type: array + items: + type: string + enum: + - history + examples: + Optional: + value: null + History: + value: history responses: "200": description: OK @@ -11086,34 +11528,520 @@ paths: area_code: "487" number: "5550077" rooms: - - id: "926784314" + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + loyalty_id: ABC123 + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + invoicing: + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + point_of_sale_display: Global Travel Site + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itinerary No History with Property Collect: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + loyalty_id: ABC123 + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itinerary with History: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" confirmation_id: - expedia: "1234567890" - property: BEF23123AA + expedia: "664637628" + property: COR8729347BB bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 checkin: '2018-09-21' - checkout: '2018-09-23' + checkout: '2018-09-22' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - loyalty_id: ABC123 + amount_charged: + billable_currency: + value: "244.70" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: -65.98 - currency: USD - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -11124,48 +12052,40 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: - value: "368.15" + value: "244.70" currency: USD exclusive: billable_currency: - value: "345.91" + value: "234.68" currency: USD marketing_fee: billable_currency: - value: "7.75" + value: "5.14" currency: USD property_fees: billable_currency: @@ -11184,55 +12104,12 @@ paths: billable_currency: value: "11.95" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: leisure - Itinerary with History: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -11241,24 +12118,19 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -11269,36 +12141,28 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -11329,16 +12193,127 @@ paths: billable_currency: value: "11.95" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -11363,207 +12338,113 @@ paths: method: GET href: https://www.example.com?key=123abd456 travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + mandatory_tax: + billable_currency: + value: "11.95" currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -11572,24 +12453,19 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo - status: booked + status: canceled special_request: Please give me extra towels. smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -11600,36 +12476,28 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -11660,226 +12528,6 @@ paths: billable_currency: value: "11.95" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: canceled - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD "206": description: Partial Content headers: @@ -11940,30 +12588,306 @@ paths: area_code: "487" number: "5550077" rooms: - - id: "926784314" + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + loyalty_id: ABC123 + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + Itinerary with History: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" confirmation_id: - expedia: "1234567890" - property: BEF23123AA + expedia: "664637628" + property: COR8729347BB bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 checkin: '2018-09-21' - checkout: '2018-09-23' + checkout: '2018-09-22' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - loyalty_id: ABC123 + amount_charged: + billable_currency: + value: "244.70" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -11974,43 +12898,40 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: - value: "368.15" + value: "244.70" currency: USD exclusive: billable_currency: - value: "345.91" + value: "234.68" currency: USD marketing_fee: billable_currency: - value: "7.75" + value: "5.14" currency: USD property_fees: billable_currency: @@ -12027,60 +12948,14 @@ paths: currency: USD mandatory_tax: billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: leisure - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - Itinerary with History: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -12089,20 +12964,19 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -12113,31 +12987,28 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -12168,13 +13039,115 @@ paths: billable_currency: value: "11.95" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -12200,212 +13173,114 @@ paths: href: https://www.example.com?key=123abd456 travel_purpose: unspecified impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate value: "123.45" currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + totals: + inclusive: + billable_currency: + value: "244.70" currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -12414,20 +13289,19 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo - status: booked + status: canceled special_request: Please give me extra towels. smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD rate: id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" promotions: value_adds: "123abc": @@ -12438,31 +13312,28 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -12493,229 +13364,6 @@ paths: billable_currency: value: "11.95" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: canceled - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD "400": description: Bad Request headers: @@ -12766,8 +13414,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -12787,18 +13435,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -12944,88 +13592,88 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] put: tags: - - Bookings + - Bookings summary: Resume Booking description: | This link will be available in the booking response after creating a held booking. operationId: putResumeBooking parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - Returns the HTTP 202 response caused by partial service unavailablity. - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` - Returns the HTTP 202 response caused by partial service unavailablity. + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + required: true + schema: + type: string responses: "202": description: Accepted - Request is valid but the state of the booking is @@ -13162,8 +13810,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -13183,18 +13831,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -13340,90 +13988,90 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] delete: tags: - - Manage Booking + - Manage Booking summary: Cancel Held Booking description: | This link will be available in a held booking response. operationId: deleteHeldBooking parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - post_stay_cancel - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - post_stay_cancel + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + required: true + schema: + type: string responses: "202": description: Accepted - Request is valid but the state of the booking is @@ -13563,8 +14211,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. Room Already Cancelled Example: value: type: room_already_cancelled @@ -13588,18 +14236,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -13745,11 +14393,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/invoice: get: tags: - - Manage Booking + - Manage Booking summary: Booking Receipt description: | A link to the booking receipt will be provided in the retrieve response if partner configuration enabled. This @@ -13757,95 +14405,95 @@ paths: tracking purposes. operationId: getBookingReceipt parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/pdf`. - required: true - schema: - type: string - example: application/pdf - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location - and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - description: | - The booking receipt call has a test header that can be used to return set responses with the following - keywords: - * `standard` - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This path variable will be provided as part of the link. This specifies which itinerary the booking receipt - request pertains to. - required: true - schema: - type: string - example: 8955599932111 - - name: token - in: query - 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. - required: true - schema: - type: string - example: MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - - name: branding - in: query - description: | - This parameter specifies which branding should be present on the generated PDF. Default behavior will be to - provide the booking receipt with `expedia_group` branding. Some partner configurations may change the default to unbranded. - schema: - type: string - enum: - - expedia_group - - unbranded - example: unbranded + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/pdf`. + required: true + schema: + type: string + example: application/pdf + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location + and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + description: | + The booking receipt call has a test header that can be used to return set responses with the following + keywords: + * `standard` + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This path variable will be provided as part of the link. This specifies which itinerary the booking receipt + request pertains to. + required: true + schema: + type: string + example: 8955599932111 + - name: token + in: query + 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. + required: true + schema: + type: string + example: MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + - name: branding + in: query + description: | + This parameter specifies which branding should be present on the generated PDF. Default behavior will be to + provide the booking receipt with `expedia_group` branding. Some partner configurations may change the default to unbranded. + schema: + type: string + enum: + - expedia_group + - unbranded + example: unbranded responses: "200": description: Invoice provided as body in PDF binary form. @@ -13943,13 +14591,13 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: branding.invalid - message: "Branding not supported. Supported branding values are:\ + - type: branding.invalid + message: "Branding not supported. Supported branding values are:\ \ [expedia_group, unbranded]" - fields: - - name: branding - type: querystring - value: custom_branding + fields: + - name: branding + type: querystring + value: custom_branding "401": description: Unauthorized headers: @@ -13969,18 +14617,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -14126,90 +14774,90 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/payment-sessions: put: tags: - - Bookings + - Bookings summary: Complete Payment Session description: | This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
    This link will be available in the booking response only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. It should be called after Two-Factor Authentication has been completed by the customer in order to finalize the payment and complete the booking or hold attempt. Learn more with our [PSD2 Overview](https://developers.expediagroup.com/docs/rapid/lodging/booking/psd2-regulation) operationId: putCompletePaymentSession parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The payment-sessions call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The payment-sessions call has a test header that can be used to return set responses with the following keywords:
    + * `standard` + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + required: true + schema: + type: string responses: "200": description: Payment Session Completed @@ -14327,8 +14975,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -14348,18 +14996,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -14505,105 +15153,105 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/rooms/{room_id}: put: tags: - - Manage Booking + - Manage Booking summary: Change details of a room. description: | This link will be available in the retrieve response. Changes in smoking preference and special request will be passed along to the property and are not guaranteed. operationId: changeRoomDetails parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The change call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - Requires valid test booking. - * `service_unavailable` - * `unknown_internal_error` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The change call has a test header that can be used to return set responses with the following keywords:
    + * `standard` - Requires valid test booking. + * `service_unavailable` + * `unknown_internal_error` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: description: "The request body is required, but only the fields that are being\ \ changed need to be passed in. Fields that are not being changed should\ @@ -14749,8 +15397,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -14770,18 +15418,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -14927,98 +15575,98 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] delete: tags: - - Manage Booking + - Manage Booking summary: Cancel a room. description: | This link will be available in the retrieve response. operationId: deleteRoom parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - post_stay_cancel - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - post_stay_cancel + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + 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. + required: true + schema: + type: string responses: "202": description: Accepted - Request is valid but the state of the booking is @@ -15156,8 +15804,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -15177,18 +15825,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -15334,11 +15982,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/rooms/{room_id}/pricing: put: tags: - - Manage Booking + - Manage Booking summary: Commit a change of itinerary that may require additional payment or refund. description: "This link will be available in the change response to confirm\ @@ -15347,103 +15995,103 @@ paths: \ is not supported at this time.\n" operationId: commitChange parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Authorization - in: header - description: "The custom generated authentication header. Refer to our [signature\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Authorization + in: header + description: "The custom generated authentication header. Refer to our [signature\ \ authentication](https://developer.expediapartnersolutions.com/reference/signature-authentication)\ \ page for full details." - required: true - schema: - type: string - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The change call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - Requires valid test booking. - * `service_unavailable` - * `unknown_internal_error` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - 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. - required: true - schema: - type: string + required: true + schema: + type: string + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The change call has a test header that can be used to return set responses with the following keywords:
    + * `standard` - Requires valid test booking. + * `service_unavailable` + * `unknown_internal_error` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: description: | The request body is required if additional payment is necessary. The body can optionally contain the `change_reference_id`. @@ -15588,8 +16236,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -15609,18 +16257,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -15731,12 +16379,12 @@ paths: 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" + - name: payments.amount + type: body + value: "100.00" + - name: price.amount + type: body + value: "120.00" "410": description: Sold Out headers: @@ -15870,95 +16518,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/amenities: get: tags: - - Content + - Content summary: Amenities Reference description: | Returns a complete collection of amenities available in the Rapid API. operationId: getAmenitiesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -16034,15 +16682,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -16062,18 +16710,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -16149,95 +16797,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/categories: get: tags: - - Content + - Content summary: Categories Reference description: | Returns a complete collection of categories available in the Rapid API. operationId: getCategoriesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -16305,15 +16953,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -16333,18 +16981,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -16420,13 +17068,12 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /chains: get: tags: - - Content + - Content summary: Chain Reference ***DEPRECATED*** - deprecated: true description: | ***DEPRECATED*** Please use `/references/chains`
    Returns a complete collection of chains recognized by the Rapid API. @@ -16440,69 +17087,69 @@ paths:
    Chain and brand names are provided in English only. operationId: getChainReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -16623,18 +17270,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -16710,11 +17357,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/chains: get: tags: - - Content + - Content summary: Chains Reference description: | Returns a complete collection of chains recognized by the Rapid API. @@ -16728,69 +17375,69 @@ paths:
    Chain and brand names are provided in English only. operationId: getChainsReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -16911,18 +17558,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -16998,95 +17645,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/general-attributes: get: tags: - - Content + - Content summary: General Attributes Reference description: | Returns a complete collection of general attributes available in the Rapid API. operationId: getGeneralAttributesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17158,15 +17805,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -17186,18 +17833,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17273,95 +17920,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/images: get: tags: - - Content + - Content summary: Images Reference description: | Returns a complete collection of images available in the Rapid API. operationId: getImagesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17429,15 +18076,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -17457,18 +18104,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17538,101 +18185,101 @@ paths: $ref: '#/components/headers/Region' content: application/json: - schema: - $ref: '#/components/schemas/Error' - example: - type: service_unavailable - message: This service is currently unavailable. - security: - - rapidAuth: [] - /references/onsite-payment-types: - get: - tags: - - Content - summary: Onsite Payment Types Reference - description: | - Returns a complete collection of onsite payment types available in the Rapid API. - operationId: getOnsitePaymentTypesReference - parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [] + /references/onsite-payment-types: + get: + tags: + - Content + summary: Onsite Payment Types Reference + description: | + Returns a complete collection of onsite payment types available in the Rapid API. + operationId: getOnsitePaymentTypesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17700,15 +18347,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -17728,18 +18375,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17815,95 +18462,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/pet-attributes: get: tags: - - Content + - Content summary: Pet Attributes Reference description: | Returns a complete collection of pet attributes available in the Rapid API. operationId: getPetAttributesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17975,15 +18622,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18003,18 +18650,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18090,95 +18737,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/rate-amenities: get: tags: - - Content + - Content summary: Rate Amenities Reference description: | Returns a complete collection of rate amenities available in the Rapid API. operationId: getRateAmenitiesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18254,15 +18901,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18282,18 +18929,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18369,95 +19016,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/room-amenities: get: tags: - - Content + - Content summary: Room Amenities Reference description: | Returns a complete collection of roomo amenities available in the Rapid API. operationId: getRoomAmenitiesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18533,15 +19180,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18561,18 +19208,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18648,95 +19295,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/room-images: get: tags: - - Content + - Content summary: Room Images Reference description: | Returns a complete collection of room images available in the Rapid API. operationId: getRoomImagesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18804,15 +19451,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18832,18 +19479,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18919,95 +19566,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/room-views: get: tags: - - Content + - Content summary: Room Views Reference description: | Returns a complete collection of room views available in the Rapid API. operationId: getRoomViewsReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19075,15 +19722,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19103,18 +19750,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19190,95 +19837,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/spoken-languages: get: tags: - - Content + - Content summary: Spoken Languages Reference description: | Returns a complete collection of spoken languages available in the Rapid API. operationId: getSpokenLanguagesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19343,15 +19990,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19371,18 +20018,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19458,95 +20105,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/statistics: get: tags: - - Content + - Content summary: Statistics Reference description: | Returns a complete collection of statistics available in the Rapid API. operationId: getStatisticsReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19618,15 +20265,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19646,18 +20293,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19733,95 +20380,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/themes: get: tags: - - Content + - Content summary: Themes Reference description: | Returns a complete collection of themes available in the Rapid API. operationId: getThemesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19889,15 +20536,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19917,18 +20564,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -20004,52 +20651,52 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /notifications: get: tags: - - Notifications + - Notifications summary: Request Undelivered Notifications description: | Use this API to fetch undelivered notifications. Up to 25 notifications are returned with each call. Each undelivered notification will be returned only once. operationId: requestUndeliveredNotifications parameters: - - name: undeliverable - in: query - description: Undeliverable notifications are returned when this parameter - is set to `true`. - required: true - schema: - type: boolean - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: undeliverable + in: query + description: Undeliverable notifications are returned when this parameter + is set to `true`. + required: true + schema: + type: boolean + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -20063,59 +20710,59 @@ paths: items: $ref: '#/components/schemas/Notification' example: - - event_id: e02d6f41-4708-476f-915d-8a7032942e94 - event_type: itinerary.agent.change - event_time: '2018-04-28T20:31:03.423Z' - itinerary_id: "1204309424793" - email: alice@example.com - message: An agent changed this itinerary. - affiliate_reference_id: R194193582 - - event_id: fe97op1b-595a-406e-8e0e-90108d5cb4a1 - event_type: itinerary.agent.cancel - event_time: '2018-05-24T04:08:50.839Z' - itinerary_id: "1204329124126" - email: bob@example.com - message: An agent canceled one or more rooms on this itinerary. - affiliate_reference_id: "" + - event_id: e02d6f41-4708-476f-915d-8a7032942e94 + event_type: itinerary.agent.change + event_time: '2018-04-28T20:31:03.423Z' + itinerary_id: "1204309424793" + email: alice@example.com + message: An agent changed this itinerary. + affiliate_reference_id: R194193582 + - event_id: fe97op1b-595a-406e-8e0e-90108d5cb4a1 + event_type: itinerary.agent.cancel + event_time: '2018-05-24T04:08:50.839Z' + itinerary_id: "1204329124126" + email: bob@example.com + message: An agent canceled one or more rooms on this itinerary. + affiliate_reference_id: "" security: - - rapidAuth: [] + - rapidAuth: [] post: tags: - - Notifications + - Notifications summary: Request Test Notification description: | This request triggers a test notification according to the specified event_type. All event types supported by the Notifications API are available to test. operationId: requestTestNotification parameters: - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string requestBody: content: application/json: @@ -20143,15 +20790,15 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: event_type.not_supported - message: "Event type is not supported. Supported event types are:\ + - type: event_type.not_supported + message: "Event type is not supported. Supported event types are:\ \ [itinerary.agent.create, itinerary.agent.change, itinerary.agent.cancel,\ \ itinerary.supplier.confirm, itinerary.supplier.cancel, itinerary.fraud.cancel]" - fields: - - name: event_type - type: path + fields: + - name: event_type + type: path security: - - rapidAuth: [] + - rapidAuth: [] components: schemas: PropertyContent: @@ -20446,6 +21093,11 @@ components: type: boolean description: Whether or not a payment for this property can be taken by the property upon arrival. + updated_expedia_collect: + type: boolean + description: Whether or not a payment for this property can be taken by + Expedia at the time of booking and whether a VAT invoice can be requested + from the property if the property is accountable to provide such a document. description: How and when the payment can be taken. Checkin: type: object @@ -20870,12 +21522,12 @@ components: Children: rule: Children allowed additional_information: - - Children allowed under age 13. - - Multiple children must sleep on cots. + - Children allowed under age 13. + - Multiple children must sleep on cots. Pets: rule: Pets allowed additional_information: - - Pets must be kept on the balcony. + - Pets must be kept on the balcony. amenities: $ref: '#/components/schemas/Amenity' vrbo_srp_id: @@ -20908,20 +21560,20 @@ components: is the unit location. example: "1": - - type: TWIN_SINGLE_BED - description: Twin/Single bed(s) - - quantity: 1 - - type: CHILD_BED - description: Child bed(s) - - quantity: 1 + - type: TWIN_SINGLE_BED + description: Twin/Single bed(s) - + quantity: 1 + - type: CHILD_BED + description: Child bed(s) - + quantity: 1 "2": - - type: QUEEN_BED - description: Queen bed(s) - - quantity: 1 + - type: QUEEN_BED + description: Queen bed(s) - + quantity: 1 Other1: - - type: CHILD_BED - description: Child bed(s) - - quantity: 3 + - type: CHILD_BED + description: Child bed(s) - + quantity: 3 free_text: type: string description: A free text description that could contain significantly unstructured @@ -20969,8 +21621,8 @@ components: type: array description: List of strings detailing further information about the rule. example: - - Children allowed ages 13-17 - - Three children are possible if one is in a cot + - Children allowed ages 13-17 + - Three children are possible if one is in a cot items: type: string UnitConfiguration: @@ -21094,21 +21746,21 @@ components: type: string description: The reason category for this reviewer's trip. enum: - - business - - leisure - - friends_and_family - - business_and_leisure + - business + - leisure + - friends_and_family + - business_and_leisure TravelCompanion: type: string description: The companion category for any travelers that accompanied this reviewer. enum: - - family - - family_with_children - - partner - - self - - friends - - pet + - family + - family_with_children + - partner + - self + - friends + - pet ManagementResponse: type: object properties: @@ -21239,11 +21891,11 @@ components: Polygon: title: Polygon allOf: - - $ref: '#/components/schemas/BoundingPolygon' - - type: object - properties: - coordinates: - $ref: '#/components/schemas/PolygonCoordinates' + - $ref: '#/components/schemas/BoundingPolygon' + - type: object + properties: + coordinates: + $ref: '#/components/schemas/PolygonCoordinates' PolygonCoordinates: type: array description: "An array of linear ring coordinate arrays that combine to make\ @@ -21267,16 +21919,16 @@ components: MultiPolygon: title: MultiPolygon allOf: - - $ref: '#/components/schemas/BoundingPolygon' - - type: object - properties: - coordinates: - type: array - description: "An array of multiple polygon(s) that combine to make a full\ + - $ref: '#/components/schemas/BoundingPolygon' + - type: object + properties: + coordinates: + type: array + description: "An array of multiple polygon(s) that combine to make a full\ \ [MultiPolygon](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.7)\ \ in geojson format." - items: - $ref: '#/components/schemas/PolygonCoordinates' + items: + $ref: '#/components/schemas/PolygonCoordinates' Ancestors: type: object properties: @@ -21289,8 +21941,8 @@ components: description: A region ancestor. PropertiesGeoJsonRequest: required: - - coordinates - - type + - coordinates + - type type: object properties: type: @@ -21302,30 +21954,30 @@ components: example: 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 + - - - -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 PropertyGeography: type: object properties: @@ -21343,8 +21995,8 @@ components: type: string description: Helps determine which type of property response is returned. enum: - - available - - partially_unavailable + - available + - partially_unavailable score: type: number description: A score to sort properties where the higher the value the better. @@ -21357,17 +22009,17 @@ components: partially_unavailable: '#/components/schemas/PropertyUnavailability' PropertyAvailability: allOf: - - $ref: '#/components/schemas/Property' - - type: object - properties: - rooms: - type: array - description: Array of objects containing room information. - items: - $ref: '#/components/schemas/RoomAvailability' - links: - $ref: '#/components/schemas/PropertyAvailabilityLinks' - description: The rooms and rates for a property. + - $ref: '#/components/schemas/Property' + - type: object + properties: + rooms: + type: array + description: Array of objects containing room information. + items: + $ref: '#/components/schemas/RoomAvailability' + links: + $ref: '#/components/schemas/PropertyAvailabilityLinks' + description: The rooms and rates for a property. RoomAvailability: type: object properties: @@ -21406,9 +22058,9 @@ components: description: Indicates the current refundability of the rate. This is a more detailed version of the `refundable` field. enum: - - refundable - - non_refundable - - partially_refundable + - refundable + - non_refundable + - partially_refundable member_deal_available: type: boolean description: Indicates if a "Member Only Deal" is available for this rate. @@ -21481,9 +22133,9 @@ components: price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. enum: - - available - - price_changed - - sold_out + - available + - price_changed + - sold_out SaleScenario: type: object properties: @@ -21622,12 +22274,12 @@ components: href: /v3/properties/12345/availability?token=MY5S3j36cOcL PropertyUnavailability: allOf: - - $ref: '#/components/schemas/Property' - - type: object - properties: - unavailable_reason: - $ref: '#/components/schemas/UnavailableReason' - description: "Response with a property that has no available rates for the\ + - $ref: '#/components/schemas/Property' + - type: object + properties: + unavailable_reason: + $ref: '#/components/schemas/UnavailableReason' + description: "Response with a property that has no available rates for the\ \ given request parameters, but `include=unavailable_reason` was requested." UnavailableReason: type: object @@ -21654,23 +22306,23 @@ components: * `partial_inventory_available` - Some of the dates have no inventory available for the specified duration. `data` will contain the unavailable dates separated by pipe `|`. eg. `2023-10-21|2023-10-23` * `no_inventory_available` - No inventory is available for the specified duration. enum: - - adults_exceed_threshold - - children_exceed_threshold - - infants_exceed_threshold - - minimum_child_age - - maximum_occupancy - - checkin_not_allowed - - checkout_not_allowed - - minimum_stay - - maximum_stay - - restricted_dates - - same_day_restrictions - - maximum_rooms - - children_not_supported - - minimum_advance_purchase - - maximum_advance_purchase - - partial_inventory_available - - no_inventory_available + - adults_exceed_threshold + - children_exceed_threshold + - infants_exceed_threshold + - minimum_child_age + - maximum_occupancy + - checkin_not_allowed + - checkout_not_allowed + - minimum_stay + - maximum_stay + - restricted_dates + - same_day_restrictions + - maximum_rooms + - children_not_supported + - minimum_advance_purchase + - maximum_advance_purchase + - partial_inventory_available + - no_inventory_available data: type: string description: An associated value that provides helpful information for some @@ -21714,9 +22366,9 @@ components: price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. enum: - - available - - price_changed - - sold_out + - available + - price_changed + - sold_out RoomPriceCheckLinks: type: object properties: @@ -21861,13 +22513,13 @@ components: example: 14 PaymentSessionsRequest: required: - - browser_accept_header - - customer_account_details - - encoded_browser_metadata - - merchant_url - - payments - - preferred_challenge_window_size - - version + - browser_accept_header + - customer_account_details + - encoded_browser_metadata + - merchant_url + - payments + - preferred_challenge_window_size + - version type: object properties: version: @@ -21890,11 +22542,11 @@ components: * `large`: 500 x 600 * `full_screen`: Full screen enum: - - extra_small - - small - - medium - - large - - full_screen + - extra_small + - small + - medium + - large + - full_screen merchant_url: type: string description: Fully qualified URL of merchant website or customer care site. @@ -21919,23 +22571,23 @@ components: add_card_attempts: 1 account_purchases: 1 payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - enrollment_date: '2018-09-15' + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + enrollment_date: '2018-09-15' PaymentSessionsRequestCustomerAccountDetails: type: object properties: @@ -21943,12 +22595,12 @@ components: type: string description: Mechanism used by the cardholder to authenticate to the merchant. enum: - - guest - - own_credentials - - federated_id - - issuer_credentials - - third_party_authentication - - fido_authentication + - guest + - own_credentials + - federated_id + - issuer_credentials + - third_party_authentication + - fido_authentication authentication_timestamp: type: string description: "Date and time in UTC of the cardholder authentication, in\ @@ -21975,20 +22627,20 @@ components: previous six months. PaymentRequest: required: - - billing_contact - - type + - billing_contact + - type type: object properties: type: type: string - description: "Identifier for the type of payment. If affiliate_collect,\ - \ card information is not required as EPS will not be processing the payment.\ - \ However, billing contact information is still required." + description: | + Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not + be processing the payment. However, billing contact information is still required. enum: - - corporate_card - - customer_card - - virtual_card - - affiliate_collect + - corporate_card + - customer_card + - virtual_card + - affiliate_collect number: type: string description: Card number. Required for credit card transactions. @@ -22010,13 +22662,16 @@ components: $ref: '#/components/schemas/ThirdPartyAuthRequest' enrollment_date: type: string - description: "Date the payment account was enrolled in the cardholder's\ - \ account with the merchant, in ISO 8601 format (YYYY-MM-DD)." + description: | + Date the payment account was enrolled in the cardholder's account with the merchant, in ISO 8601 format + (YYYY-MM-DD). + additional_handling: + $ref: '#/components/schemas/AdditionalHandling' BillingContactRequest: required: - - address - - family_name - - given_name + - address + - family_name + - given_name type: object properties: given_name: @@ -22033,7 +22688,7 @@ components: $ref: '#/components/schemas/BillingContactRequestAddress' BillingContactRequestAddress: required: - - country_code + - country_code type: object properties: line_1: @@ -22075,10 +22730,10 @@ components: \ are allowed." ThirdPartyAuthRequest: required: - - cavv - - ds_transaction_id - - eci - - three_ds_version + - cavv + - ds_transaction_id + - eci + - three_ds_version type: object properties: cavv: @@ -22125,6 +22780,111 @@ components: 0 - Non-SecureCode transaction, bypassed by the Merchant 1 - Merchant-Only SecureCode transaction 2 - Fully authenticated SecureCode transaction + AdditionalHandling: + required: + - authorized_expenses + type: object + properties: + authorized_expenses: + type: string + description: | + Indicates which types of expenses are authorized to be charged to the VCC. + * `prestay_expenses_only` - Indicates that the provided VCC is for pre-stay charges only (e.g., + deposits, cancellation fees, no-show fees). A physical card must be presented at check-in for any + remaining balance, as well as incidentals. + * `total_booking_amount` - Indicates that both pre-stay charges and the total booking amount are + authorized, but no incidentals are authorized. A physical card must be presented at check-in for any + incidentals. + * `total_plus_incidentals` - Indicates that pre-stay, total booking, and incidental expenses are + authorized. See `specified_incidental_expenses`. A physical card may be required for additional + incidental expenses. + * `see_authorization_form` - Indicates that a property should refer to the authorization form that will + be sent either by the card provider or the authorizing company. + enum: + - prestay_expenses_only + - total_booking_amount + - total_plus_incidentals + - see_authorization_form + specified_incidental_expenses: + type: array + description: | + Included list of enumerated categories to restrict the authorized incidentals. This is only utilized + when `authorized_expenses` is supplied with `total_plus_incidentals` and restrictions on incidentals are + desired.
    + Example: To allow any incidental expenses, specify `authorized_expenses` equal to + `total_plus_incidentals` and omit `specified_incidental_expenses`. + items: + type: string + description: The type of incidental expense authorized. + enum: + - breakfast + - entertainment + - internet + - meeting_expenses + - other_food_beverage + - parking + - phone + - taxes + - transfer + - other + total_charges_allowed: + $ref: '#/components/schemas/Amount' + is_cvc_required: + type: boolean + description: | + Indicates whether a CVC is required for the provided VCC. If this is marked required, the security_code + field for the payment MUST be provided. + authorizing_company: + type: string + description: Company that will issue the authorization form for the virtual + credit card payment. + card_contact: + type: object + properties: + email: + type: string + description: The email address of the VCC contact. + phone: + $ref: '#/components/schemas/Phone' + description: | + Object to hold information for a contact the supplier can reach in the event of any issues with the + provided payment. + max_payment_attempt_count: + type: number + description: Requested limit to number of payment attempts. + payment_allowable_period_start: + type: string + description: "Start date for valid range of the VCC payment instrument,\ + \ in ISO 8601 format (YYYY-MM-DD)." + payment_allowable_period_end: + type: string + description: "End date for valid range of the VCC payment instrument, in\ + \ ISO 8601 format (YYYY-MM-DD)." + description: | + Parent object for additional VCC handling instructions, to be included as part of the payment object when + virtual_card is the requested payment type for property collect inventory. If not included, existing + behavior regarding handling of VCCs with property collect inventory is to be preserved. This object will be + ignored for non-property collect/non-VCC transactions. total_charges_allowed represents the total ceiling of + all charges allowed on the VCC, including the booking price and any allowed incidentals. The value of total_charges_allowed + must be at least the booking value. + Phone: + type: object + properties: + country_code: + type: string + description: The numerical portion of the country code from the phone number. + Do not include the leading '+' character. + example: "1" + area_code: + type: string + description: The area code of the phone number. + example: "487" + number: + type: string + description: The remaining digits of the phone number. + example: "5550077" + description: The entire phone number must be represented across the three fields + in this object. PaymentSessions: type: object properties: @@ -22194,9 +22954,15 @@ components: Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler. enum: - - leisure - - business - - unspecified + - leisure + - business + - unspecified + supplier_transparency: + $ref: '#/components/schemas/SupplierTransparency' + additional_handling: + $ref: '#/components/schemas/AdditionalHandling' + invoicing: + $ref: '#/components/schemas/Invoicing' itinerary_history: type: array items: @@ -22230,24 +22996,6 @@ components: $ref: '#/components/schemas/Link' description: "A map of links, including links to resume or cancel a held booking.\ \ This is only included for held bookings." - Phone: - type: object - properties: - country_code: - type: string - description: The numerical portion of the country code from the phone number. - Do not include the leading '+' character. - example: "1" - area_code: - type: string - description: The area code of the phone number. - example: "487" - number: - type: string - description: The remaining digits of the phone number. - example: "5550077" - description: The entire phone number must be represented across the three fields - in this object. RoomItinerary: type: object properties: @@ -22290,7 +23038,6 @@ components: loyalty_id: type: string description: Deprecated. Please use the loyalty id inside the loyalty object. - deprecated: true loyalty: $ref: '#/components/schemas/Loyalty' rate: @@ -22312,9 +23059,9 @@ components: type: string description: The booking status of the room. enum: - - pending - - booked - - canceled + - pending + - booked + - canceled Loyalty: type: object properties: @@ -22560,6 +23307,45 @@ components: type: string description: The height of the image. example: "32" + SupplierTransparency: + type: object + properties: + point_of_sale_display_to_share: + type: string + description: The name of the point of sale to be shared. + company_name_to_share: + type: string + description: The name of the company to be shared. + consent_to_share: + type: boolean + description: Whether or not this info should be shared. + description: | + To be used for collecting and sharing partner and client information with the supplier. + Invoicing: + type: object + properties: + consent_to_share: + type: boolean + description: | + Whether the partner and traveler consent to share the invoicing section information with the supplier + and property. If not provided, this invoicing data will not be shared with the supplier or property. + company_name: + type: string + description: The traveler's company name to appear on the invoice. + company_address: + $ref: '#/components/schemas/Address_1' + point_of_sale_display: + type: string + description: | + Provide this when a specific site or branding should be used on the invoice instead of partner name. + email: + type: string + description: Email address to send invoices + vat_number: + type: string + description: A custom VAT number to include on invoices + description: | + To be included if invoicing is requested. ItineraryHistoryItem: type: object properties: @@ -22573,8 +23359,8 @@ components: event_type: type: string enum: - - adjustment - - coupon + - adjustment + - coupon amount: $ref: '#/components/schemas/Amount' agent_id: @@ -22600,10 +23386,10 @@ components: \ is `history`. However, it is `canceled_no_show` when the `include` request\ \ parameter is `history_v2`." enum: - - created - - modified - - canceled - - canceled_no_show + - created + - modified + - canceled + - canceled_no_show event_source: type: string description: "The source of the event. If `voyager_agent`, `agent_id` will\ @@ -22611,10 +23397,10 @@ components: \ event_source is `other` when the `include` request parameter is `history`.\ \ However, it is `supplier` when the `include` request parameter is `history_v2`." enum: - - rapid_api - - voyager_agent - - other - - supplier + - rapid_api + - voyager_agent + - other + - supplier change_reference_id: type: string description: Optional identifier provided during changes via Rapid. @@ -22693,27 +23479,27 @@ components: description: The rate information associated with the itinerary. CreateItineraryRequest: required: - - email - - phone - - rooms + - email + - phone + - rooms type: object properties: affiliate_reference_id: type: string - description: "Your unique reference value. This field supports from 3 to\ - \ a maximum of 28 characters and is required to be unique (if provided).\ - \ Entering special characters (\"<\", \">\", \"(\", \")\", and \"&\")\ - \ in this field will result in the request being rejected." + description: | + Your unique reference value. This field supports from 3 to a maximum of 28 characters and is required to be + unique (if provided). Entering special characters ("<", ">", "(", ")", and "&") in this field will result in + the request being rejected. hold: type: boolean - 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. + 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. email: type: string - description: "Email address for the customer. Must adhere to standard RFC\ - \ 822 email format. Special characters (\"<\", \">\", \"(\", \")\", and\ - \ \"&\") entered in this field will be re-encoded." + description: | + Email address for the customer. Must adhere to standard RFC 822 email format. Special characters ("<", ">", + "(", ")", and "&") entered in this field will be re-encoded. phone: $ref: '#/components/schemas/PhoneRequest' rooms: @@ -22722,46 +23508,32 @@ components: $ref: '#/components/schemas/CreateItineraryRequestRoom' payments: type: array - description: "Required if payment information prior to booking was not submitted.\ - \ If register payments was called prior to this call, do not submit payment\ - \ information again." + description: | + Required if payment information prior to booking was not submitted. If register payments was called prior to + this call, do not submit payment information again. items: $ref: '#/components/schemas/PaymentRequest' affiliate_metadata: type: string - 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'.\ - \ Other Special characters (\"<\", \">\", \"(\", \")\", and \"&\") entered\ - \ in this field will be re-encoded." + 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'. + Other Special characters ("<", ">", "(", ")", and "&") entered in this field will be re-encoded. tax_registration_number: type: string - description: "The customer's taxpayer identification number that is provided\ - \ by the government to nationals or resident aliens. This number should\ - \ be collected from individuals that pay taxes or participate in activities\ - \ that provide revenue for one or more tax types. Note: This value is\ - \ only needed from Brazilian and Indian customers." + description: | + The customer's taxpayer identification number that is provided by the government to nationals or resident + aliens. This number should be collected from individuals that pay taxes or participate in activities that + provide revenue for one or more tax types. *Note:* This value is only needed from Brazilian and Indian + customers. traveler_handling_instructions: type: string description: "Custom traveler handling instructions for the hotel. Do not\ \ include PCI sensitive data, such as credit card numbers, in this field." invoicing: - type: object - properties: - company_name: - type: string - description: The traveler's company name to appear on the invoice. - company_address: - $ref: '#/components/schemas/Address_1' - point_of_sale_display: - type: string - description: | - Provide this when a specific site or branding should be used on the invoice instead of partner name. - email: - type: string - description: Email address to send invoices - description: | - To be included if invoicing is requested. + $ref: '#/components/schemas/Invoicing' + supplier_transparency: + $ref: '#/components/schemas/SupplierTransparency' example: affiliate_reference_id: 4480ABC hold: false @@ -22771,51 +23543,68 @@ components: area_code: "487" number: "5550077" rooms: - - given_name: John - family_name: Smith - smoking: false - special_request: Top floor or away from street please - loyalty_id: ABC123 - loyalty: - member_id: ABD123 - program_id: SN + - given_name: John + family_name: Smith + smoking: false + special_request: Top floor or away from street please + loyalty_id: ABC123 + loyalty: + member_id: ABD123 + program_id: SN payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - enrollment_date: '2018-09-15' - third_party_authentication: - cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= - eci: "05" - three_ds_version: 2.2.0 - ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de - pa_res_status: "Y" - ve_res_status: C - xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 - cavv_algorithm: "3" - ucaf_indicator: "0" + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + enrollment_date: '2018-09-15' + third_party_authentication: + cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= + eci: "05" + three_ds_version: 2.2.0 + ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de + pa_res_status: "Y" + ve_res_status: C + xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 + cavv_algorithm: "3" + ucaf_indicator: "0" affiliate_metadata: data_point_1:123|data_point2:This is data. tax_registration_number: "12345678910" traveler_handling_instructions: Please use the card provided for payment. Avoid cancelation as this is for a corporate traveler. Contact traveler if any issues. + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" PhoneRequest: required: - - country_code - - number + - country_code + - number type: object properties: country_code: @@ -22836,8 +23625,8 @@ components: in this object. The entire phone number should not exceed 25 characters. CreateItineraryRequestRoom: required: - - family_name - - given_name + - family_name + - given_name type: object properties: given_name: @@ -22865,7 +23654,6 @@ components: loyalty_id: type: string description: Deprecated. Please use the loyalty id inside the loyalty object. - deprecated: true loyalty: $ref: '#/components/schemas/Loyalty' ItineraryCreation: @@ -22951,7 +23739,6 @@ components: loyalty_id: type: string description: Deprecated. Please use the loyalty id inside the loyalty object. - deprecated: true loyalty: $ref: '#/components/schemas/Loyalty' example: @@ -22978,37 +23765,37 @@ components: example: change_reference_id: v1-John payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - third_party_authentication: - cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= - eci: "05" - three_ds_version: 2.2.0 - ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de - pa_res_status: "Y" - ve_res_status: C - xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 - cavv_algorithm: "3" - ucaf_indicator: "0" - enrollment_date: '2018-09-15' + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + third_party_authentication: + cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= + eci: "05" + three_ds_version: 2.2.0 + ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de + pa_res_status: "Y" + ve_res_status: C + xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 + cavv_algorithm: "3" + ucaf_indicator: "0" + enrollment_date: '2018-09-15' PaymentRequestWithPhone: required: - - billing_contact - - type + - billing_contact + - type type: object properties: type: @@ -23017,10 +23804,10 @@ components: \ cardholder information is not required as EPS will not be processing\ \ the payment." enum: - - corporate_card - - customer_card - - virtual_card - - affiliate_collect + - corporate_card + - customer_card + - virtual_card + - affiliate_collect number: type: string description: Card number. Required for credit card transactions. @@ -23046,9 +23833,9 @@ components: \ account with the merchant, in ISO 8601 format (YYYY-MM-DD)." BillingContactRequestWithPhone: required: - - address - - family_name - - given_name + - address + - family_name + - given_name type: object properties: given_name: @@ -23146,7 +23933,7 @@ components: description: A notification. TestNotificationRequest: required: - - event_type + - event_type type: object properties: event_type: @@ -23195,8 +23982,8 @@ components: * `expedia` - Payment is taken by Expedia. * `property` - Payment is taken by the property. enum: - - expedia - - property + - expedia + - property CancelPenalty: type: object properties: @@ -23285,14 +24072,14 @@ components: "Taxes and Fees" * `traveler_service_fee` - Fee charged by Vrbo to support use of online tools, services and functions on its platform which enable guest self service. May be displayed as 'Traveler Service Fee' or 'Service Fee' any time fees are broken out for display on partner sites. enum: - - base_rate - - tax_and_service_fee - - extra_person_fee - - property_fee - - sales_tax - - adjustment - - recovery_charges_and_fees - - traveler_service_fee + - base_rate + - tax_and_service_fee + - extra_person_fee + - property_fee + - sales_tax + - adjustment + - recovery_charges_and_fees + - traveler_service_fee Stay: type: object properties: @@ -23309,14 +24096,14 @@ components: type: string description: The price breakout type. enum: - - base_rate - - tax_and_service_fee - - extra_person_fee - - property_fee - - sales_tax - - adjustment - - recovery_charges_and_fees - - traveler_service_fee + - base_rate + - tax_and_service_fee + - extra_person_fee + - property_fee + - sales_tax + - adjustment + - recovery_charges_and_fees + - traveler_service_fee Totals: type: object properties: @@ -23419,34 +24206,34 @@ components: type: string description: The general category that this value add promotion falls into. enum: - - food_and_beverage - - entertainment - - service - - activity - - credit + - food_and_beverage + - entertainment + - service + - activity + - credit OfferType: type: string description: The type of offer this value add promotion is. enum: - - buy_one_get_one_free - - credit - - discount - - free - - voucher + - buy_one_get_one_free + - credit + - discount + - free + - voucher Frequency: type: string description: The frequency of when this applies. enum: - - unknown - - per_night - - per_day - - per_stay - - per_week - - round_trip - - one_way + - unknown + - per_night + - per_day + - per_stay + - per_week + - round_trip + - one_way TraderInformation: required: - - terms_and_conditions + - terms_and_conditions type: object properties: traders: @@ -23722,4 +24509,4 @@ components: \ authentication](https://developers.expediagroup.com/docs/rapid/resources/reference/signature-authentication)\ \ page for full details." name: Authorization - in: header \ No newline at end of file + in: header From 61563ebf59496d0dd788f7e488a110b8de6861ca Mon Sep 17 00:00:00 2001 From: OmarAlJarrah Date: Tue, 22 Apr 2025 14:16:21 +0300 Subject: [PATCH 2/3] chore: update rapid specs --- specs.yaml | 19592 +++++++++++++++++++++++++-------------------------- 1 file changed, 9796 insertions(+), 9796 deletions(-) diff --git a/specs.yaml b/specs.yaml index c8bf865485..40091cce3e 100644 --- a/specs.yaml +++ b/specs.yaml @@ -4,28 +4,28 @@ info: description: EPS Rapid V3 version: v3 servers: -- url: https://test.ean.com/v3 + - url: https://test.ean.com/v3 tags: -- name: Content - description: This section outlines the API calls available to you to access property - content. -- name: Geography - description: The EPS Geography API provides geography content for regions around - the world. -- name: Shopping - description: The EPS shopping APIs provide you with access to live rates & availability. -- name: Bookings - description: "The primary itinerary method of the Booking API creates a reservation\ + - name: Content + description: This section outlines the API calls available to you to access property + content. + - name: Geography + description: The EPS Geography API provides geography content for regions around + the world. + - name: Shopping + description: The EPS shopping APIs provide you with access to live rates & availability. + - name: Bookings + description: "The primary itinerary method of the Booking API creates a reservation\ \ for the selected hotel, room, rate and occupancy." -- name: Manage Booking - description: Retrieve existing itineraries or cancel existing rooms. -- name: Notifications - description: Requests test notifications and undelivered notifications. + - name: Manage Booking + description: Retrieve existing itineraries or cancel existing rooms. + - name: Notifications + description: Requests test notifications and undelivered notifications. paths: /properties/content: get: tags: - - Content + - Content summary: Property Content description: | Search property content for active properties in the requested language.

    @@ -36,423 +36,423 @@ paths: can include property-level, room-level and rate-level information. operationId: getPropertyContent parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be - supplied once and will return all properties that match the requested supply source. An error is thrown if - the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for - more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: all_inclusive - in: query - description: | - Search to include properties that have the requested `all_inclusive` values equal to true. If this parameter - is not supplied, all `all_inclusive` scenarios are included. This parameter can be supplied multiple times - with different values, which will include properties that match any of the requested scenarios. - * `all_rate_plans` - Return properties where `all_inclusive.all_rate_plans` is true. - * `some_rate_plans` = Return properties where `all_inclusive.some_rate_plans` is true. - schema: - type: array - items: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: type: string - examples: - Optional: - value: null - All: - value: all_rate_plans - - name: amenity_id - in: query - description: | - The ID of the amenity you want to search for. This parameter can be supplied multiple times with different - values, which will include properties that match any of the requested amenity IDs. This is currently only - capable of searching for property level amenities. Room and rate level amenities cannot be searched on. - schema: - type: array - items: + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: type: string - examples: - Optional: - value: null - Elevator: - value: 8 - Multiple: - value: - - 115 - - 43 - - name: attribute_id - in: query - description: | - The ID of the attribute you want to search for. This parameter can be supplied multiple times with different - values, which will include properties that match any of the requested attribute IDs. - schema: - type: array - items: + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: type: string - examples: - Optional: - value: null - Pets: - value: 51 - Multiple: - value: - - 5058 - - 5059 - - name: brand_id - in: query - description: | - The ID of the brand you want to search for. This parameter can be supplied multiple times with different - values, which will include properties that match any of the requested brand IDs. - schema: - type: array - items: + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: type: string - examples: - Optional: - value: null - Hyatt: - value: 11210 - Multiple: - value: - - 1 - - 11210 - - name: business_model - in: query - description: | - Search for properties with the requested business model enabled. This parameter can be supplied multiple - times with different values, which will return all properties that match any of the requested business - models. The value must be lower case. - * `expedia_collect` - Return only properties where the payment is collected by Expedia. - * `property_collect` - Return only properties where the payment is collected at the property. - schema: - type: array - items: + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: type: string - enum: - - expedia_collect - - property_collect - examples: - Optional: - value: null - Single: - value: expedia_collect - - name: category_id - in: query - description: | - Search to include properties that have the requested - [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If - this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times - with different values, which will include properties that match any of the requested category IDs. - schema: - type: array - items: + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be + supplied once and will return all properties that match the requested supply source. An error is thrown if + the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for + more information. + required: true + schema: type: string - examples: - Optional: - value: null - Single: - value: 1 - Multiple: - value: - - 1 - - 2 - - name: category_id_exclude - in: query - description: | - Search to exclude properties that do not have the requested - [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If - this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times - with different values, which will exclude properties that match any of the requested category IDs. - schema: - type: array - items: + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: all_inclusive + in: query + description: | + Search to include properties that have the requested `all_inclusive` values equal to true. If this parameter + is not supplied, all `all_inclusive` scenarios are included. This parameter can be supplied multiple times + with different values, which will include properties that match any of the requested scenarios. + * `all_rate_plans` - Return properties where `all_inclusive.all_rate_plans` is true. + * `some_rate_plans` = Return properties where `all_inclusive.some_rate_plans` is true. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + All: + value: all_rate_plans + - name: amenity_id + in: query + description: | + The ID of the amenity you want to search for. This parameter can be supplied multiple times with different + values, which will include properties that match any of the requested amenity IDs. This is currently only + capable of searching for property level amenities. Room and rate level amenities cannot be searched on. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Elevator: + value: 8 + Multiple: + value: + - 115 + - 43 + - name: attribute_id + in: query + description: | + The ID of the attribute you want to search for. This parameter can be supplied multiple times with different + values, which will include properties that match any of the requested attribute IDs. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Pets: + value: 51 + Multiple: + value: + - 5058 + - 5059 + - name: brand_id + in: query + description: | + The ID of the brand you want to search for. This parameter can be supplied multiple times with different + values, which will include properties that match any of the requested brand IDs. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Hyatt: + value: 11210 + Multiple: + value: + - 1 + - 11210 + - name: business_model + in: query + description: | + Search for properties with the requested business model enabled. This parameter can be supplied multiple + times with different values, which will return all properties that match any of the requested business + models. The value must be lower case. + * `expedia_collect` - Return only properties where the payment is collected by Expedia. + * `property_collect` - Return only properties where the payment is collected at the property. + schema: + type: array + items: + type: string + enum: + - expedia_collect + - property_collect + examples: + Optional: + value: null + Single: + value: expedia_collect + - name: category_id + in: query + description: | + Search to include properties that have the requested + [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If + this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times + with different values, which will include properties that match any of the requested category IDs. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Single: + value: 1 + Multiple: + value: + - 1 + - 2 + - name: category_id_exclude + in: query + description: | + Search to exclude properties that do not have the requested + [category ID](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists). If + this parameter is not supplied, all category IDs are included. This parameter can be supplied multiple times + with different values, which will exclude properties that match any of the requested category IDs. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Single: + value: 1 + Multiple: + value: + - 1 + - 2 + - name: chain_id + in: query + description: | + The ID of the chain you want to search for. These chain IDs can be positive and negative numbers. This + parameter can be supplied multiple times with different values, which will include properties that match + any of the requested chain IDs. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Single: + value: -6 + Multiple: + value: + - 1 + - 2 + - name: country_code + in: query + description: | + Search for properties with the requested country code, in ISO 3166-1 alpha-2 format. This parameter can be + supplied multiple times with different values, which will include properties that match any of the + requested country codes. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Single: + value: US + Multiple: + value: + - US + - CA + - name: date_added_end + in: query + description: | + Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: type: string - examples: - Optional: - value: null - Single: - value: 1 - Multiple: - value: - - 1 - - 2 - - name: chain_id - in: query - description: | - The ID of the chain you want to search for. These chain IDs can be positive and negative numbers. This - parameter can be supplied multiple times with different values, which will include properties that match - any of the requested chain IDs. - schema: - type: array - items: + examples: + Optional: + value: null + Recent: + value: '2023-09-21' + - name: date_added_start + in: query + description: | + Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: type: string - examples: - Optional: - value: null - Single: - value: -6 - Multiple: - value: - - 1 - - 2 - - name: country_code - in: query - description: | - Search for properties with the requested country code, in ISO 3166-1 alpha-2 format. This parameter can be - supplied multiple times with different values, which will include properties that match any of the - requested country codes. - schema: - type: array - items: + examples: + Optional: + value: null + Recent: + value: '2023-09-20' + - name: date_updated_end + in: query + description: | + Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: type: string - examples: - Optional: - value: null - Single: - value: US - Multiple: - value: - - US - - CA - - name: date_added_end - in: query - description: | - Search for properties added on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: - type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-21' - - name: date_added_start - in: query - description: | - Search for properties added on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: - type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-20' - - name: date_updated_end - in: query - description: | - Search for properties updated on or before the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: - type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-21' - - name: date_updated_start - in: query - description: | - Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) - schema: - type: string - examples: - Optional: - value: null - Recent: - value: '2023-09-20' - - name: include - in: query - description: | - Each time this parameter is specified will add to the list of fields and associated objects returned in the - response. All values and field names are lower case. The values `property_ids` and `catalog` will continue - to behave as specified below for backwards compatibility. All other top level field names will add the - specified field to the list of fields returned in the response. See the response schema for a full list of - top level field names. Additionally, the field `property_id` will always be returned regardless of what - include values are passed.

    - Possible values: - * `property_ids` - ***DEPRECATED*** - Please use `property_id` which matches the response field name. - * `catalog` - Include all property catalog fields. See - [Property Catalog File endpoint](https://developers.expediagroup.com/docs/rapid/resources/rapid-api#get-/files/properties/catalog) - for a list of fields. - * `property_id` - Passing in the value `property_id` and no other values will limit the response to only - `property_id`. Not necessary to include in combination with other field name values, as it will always - be returned. - * All field names found at the top level of the property content response are now valid values for - inclusion. - schema: - type: array - items: + examples: + Optional: + value: null + Recent: + value: '2023-09-21' + - name: date_updated_start + in: query + description: | + Search for properties updated on or after the requested UTC date, in ISO 8601 format (YYYY-MM-DD) + schema: type: string - examples: - IncludeAll: - value: null - Single: - value: images - Multiple: - value: - - images - - address - - name: multi_unit - in: query - description: | - Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit - properties will be included. - * `true` - Include only properties that are multi-unit. - * `false` - Do not include properties that are multi-unit. - schema: - type: boolean - examples: - Optional: - value: null - Single: - value: false - - name: property_id - in: query - description: | - The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. - schema: - type: array - items: + examples: + Optional: + value: null + Recent: + value: '2023-09-20' + - name: include + in: query + description: | + Each time this parameter is specified will add to the list of fields and associated objects returned in the + response. All values and field names are lower case. The values `property_ids` and `catalog` will continue + to behave as specified below for backwards compatibility. All other top level field names will add the + specified field to the list of fields returned in the response. See the response schema for a full list of + top level field names. Additionally, the field `property_id` will always be returned regardless of what + include values are passed.

    + Possible values: + * `property_ids` - ***DEPRECATED*** - Please use `property_id` which matches the response field name. + * `catalog` - Include all property catalog fields. See + [Property Catalog File endpoint](https://developers.expediagroup.com/docs/rapid/resources/rapid-api#get-/files/properties/catalog) + for a list of fields. + * `property_id` - Passing in the value `property_id` and no other values will limit the response to only + `property_id`. Not necessary to include in combination with other field name values, as it will always + be returned. + * All field names found at the top level of the property content response are now valid values for + inclusion. + schema: + type: array + items: + type: string + examples: + IncludeAll: + value: null + Single: + value: images + Multiple: + value: + - images + - address + - name: multi_unit + in: query + description: | + Search for multi-unit properties. If this parameter is not supplied, both single-unit and multi-unit + properties will be included. + * `true` - Include only properties that are multi-unit. + * `false` - Do not include properties that are multi-unit. + schema: + type: boolean + examples: + Optional: + value: null + Single: + value: false + - name: property_id + in: query + description: | + The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. + schema: + type: array + items: + type: string + examples: + Single: + value: 1337 + Multiple: + value: + - 1337 + - 1 + Optional: + value: null + - name: property_rating_max + in: query + description: | + Search for properties with a property rating less than or equal to the requested rating. The highest + property rating value is 5.0. + schema: type: string - examples: - Single: - value: 1337 - Multiple: - value: - - 1337 - - 1 - Optional: - value: null - - name: property_rating_max - in: query - description: | - Search for properties with a property rating less than or equal to the requested rating. The highest - property rating value is 5.0. - schema: - type: string - examples: - Optional: - value: null - Single: - value: 5.0 - - name: property_rating_min - in: query - description: | - Search for properties with a property rating greater than or equal to the requested rating. The lowest - property rating value is 0.0. - schema: - type: string - examples: - Optional: - value: null - Single: - value: 3.5 - - name: spoken_language_id - in: query - description: | - The id of the spoken language you want to search for. This parameter can be supplied multiple times with - different values, which will include properties that match any of the requested spoken languages. The - language code as a subset of BCP47 format. - schema: - type: array - items: + examples: + Optional: + value: null + Single: + value: 5.0 + - name: property_rating_min + in: query + description: | + Search for properties with a property rating greater than or equal to the requested rating. The lowest + property rating value is 0.0. + schema: + type: string + examples: + Optional: + value: null + Single: + value: 3.5 + - name: spoken_language_id + in: query + description: | + The id of the spoken language you want to search for. This parameter can be supplied multiple times with + different values, which will include properties that match any of the requested spoken languages. The + language code as a subset of BCP47 format. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Single: + value: en + Multiple: + value: + - zh-yue + - vi + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: type: string - examples: - Optional: - value: null - Single: - value: en - Multiple: - value: - - zh-yue - - vi - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string responses: "200": description: OK @@ -621,13 +621,13 @@ paths: name: Number of indoor pools - 10 value: 10 images: - - caption: Featured Image - hero_image: true - category: 3 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + - 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: @@ -659,21 +659,21 @@ paths: name: Test Amenity - 200 value: "200" images: - - hero_image: true - category: 21001 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg - caption: Guestroom + - hero_image: true + category: 21001 + links: + "70px": + method: GET + href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + caption: Guestroom bed_groups: "37321": id: "37321" description: 1 King Bed configuration: - - type: KingBed - size: King - quantity: 1 + - type: KingBed + size: King + quantity: 1 area: square_meters: 20 square_feet: 215 @@ -910,24 +910,24 @@ paths: id: "9" name: Fitness facilities categories: - - gym + - gym "1073745320": id: "1073745320" name: Paddle boating nearby images: - - hero_image: true - category: 21001 - links: - "350px": - method: GET - href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_b.jpg - "70px": - method: GET - href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_t.jpg - "1000px": - method: GET - href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_z.jpg - caption: Room + - hero_image: true + category: 21001 + links: + "350px": + method: GET + href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_b.jpg + "70px": + method: GET + href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_t.jpg + "1000px": + method: GET + href: https://i.travelapi.com/lodging/68000000/67240000/67235700/4687248/fe7cef52_z.jpg + caption: Room onsite_payments: currency: USD dates: @@ -997,10 +997,10 @@ paths: property_manager: name: Scott Horton house_rules: - - Children welcome - - No pets - - No smoking - - No parties or events + - Children welcome + - No pets + - No smoking + - No parties or events amenities: "1": id: "1" @@ -1016,32 +1016,32 @@ paths: ipm_name: Good Company unit_configurations: "1": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "2": - - quantity: 1 - type: SLEEP_SOFA_FUTON - description: 'Sleep sofa/futon(s) - ' - - quantity: 2 - type: BUNK_BED - description: 'Bunk bed(s) - ' + - quantity: 1 + type: SLEEP_SOFA_FUTON + description: 'Sleep sofa/futon(s) - ' + - quantity: 2 + type: BUNK_BED + description: 'Bunk bed(s) - ' "3": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "4": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "5": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' "6": - - quantity: 1 - type: KING_BED - description: 'King bed(s) - ' + - quantity: 1 + type: KING_BED + description: 'King bed(s) - ' enhanced_house_rules: Pets: rule: No pets allowed @@ -1063,7 +1063,7 @@ paths: as many of them live here full time. Quiet hours are 10pm-8am. additional_information: - - "No weapons, illegal drugs, parties, disruptive guests,\ + - "No weapons, illegal drugs, parties, disruptive guests,\ \ or underage drinking is permitted." CheckIn: rule: Check in after 4:00 PM @@ -1247,13 +1247,13 @@ paths: name: Number of indoor pools - 10 value: 10 images: - - caption: Featured Image - hero_image: true - category: 3 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + - 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: @@ -1285,21 +1285,21 @@ paths: name: Test Amenity - 200 value: "200" images: - - hero_image: true - category: 21001 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg - caption: Guestroom + - hero_image: true + category: 21001 + links: + "70px": + method: GET + href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + caption: Guestroom bed_groups: "37321": id: "37321" description: 1 King Bed configuration: - - type: KingBed - size: King - quantity: 1 + - type: KingBed + size: King + quantity: 1 area: square_meters: 20 square_feet: 215 @@ -1567,13 +1567,13 @@ paths: name: Number of indoor pools - 10 value: 10 images: - - caption: Featured Image - hero_image: true - category: 3 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + - 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: @@ -1605,21 +1605,21 @@ paths: name: Test Amenity - 200 value: "200" images: - - hero_image: true - category: 21001 - links: - "70px": - method: GET - href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg - caption: Guestroom + - hero_image: true + category: 21001 + links: + "70px": + method: GET + href: https://i.travelapi.com/hotels/1000000/20000/15300/15237/bef1b976_t.jpg + caption: Guestroom bed_groups: "37321": id: "37321" description: 1 King Bed configuration: - - type: KingBed - size: King - quantity: 1 + - type: KingBed + size: King + quantity: 1 area: square_meters: 17 views: @@ -1832,47 +1832,47 @@ paths: 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,\ + - 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,\ + 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.must_be_numeric - message: "All provided property_id query parameters must be numeric\ + fields: + - name: language + type: querystring + value: xXX + - 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.above_maximum - message: A maximum of 250 property_id query parameters may be provided - to this request. - fields: - - name: property_id - type: querystring + fields: + - name: property_id + type: querystring + value: abc + - name: property_id + type: querystring + value: 123adsf + - type: property_id.above_maximum + message: A maximum of 250 property_id query parameters may be provided + to this request. + fields: + - name: property_id + type: querystring "401": description: Unauthorized headers: @@ -1892,18 +1892,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -2006,11 +2006,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/inactive: get: tags: - - Content + - Content summary: Inactive Properties description: | Request a list of properties that are inactive because they have been removed from sale since a specified @@ -2019,87 +2019,87 @@ paths: 200 response section. operationId: getInactiveProperties parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: since - in: query - description: | - Required on initial call, not accepted on subsequent paging links provided in response header.
    - The earliest date that a property became inactive to include in the results. ISO 8601 format (YYYY-MM-DD) - schema: - type: string - examples: - Initial: - value: '2023-09-20' - Paging: - value: null - - name: token - in: query - description: | - Only used for requesting additional pages of data. Provided by the `next` URL in the `Link` response header. - schema: - type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: since + in: query + description: | + Required on initial call, not accepted on subsequent paging links provided in response header.
    + The earliest date that a property became inactive to include in the results. ISO 8601 format (YYYY-MM-DD) + schema: + type: string + examples: + Initial: + value: '2023-09-20' + Paging: + value: null + - name: token + in: query + description: | + Only used for requesting additional pages of data. Provided by the `next` URL in the `Link` response header. + schema: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -2145,8 +2145,8 @@ paths: examples: Inactive Properties: value: - - property_id: "12345" - - property_id: "23456" + - property_id: "12345" + - property_id: "23456" No Results: value: [] "400": @@ -2175,19 +2175,19 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: since.required - message: The since field is required. Please provide a date in ISO - 8601 (YYYY-MM-DD) format. - fields: - - name: since - type: querystring - - type: since.invalid_date_format - message: The since field is not formatted correctly. Please provide - a date in ISO 8601 (YYYY-MM-DD) format. - fields: - - name: since - type: querystring - value: 23-1-1 + - type: since.required + message: The since field is required. Please provide a date in ISO + 8601 (YYYY-MM-DD) format. + fields: + - name: since + type: querystring + - type: since.invalid_date_format + message: The since field is not formatted correctly. Please provide + a date in ISO 8601 (YYYY-MM-DD) format. + fields: + - name: since + type: querystring + value: 23-1-1 "401": description: Unauthorized headers: @@ -2205,18 +2205,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden content: @@ -2303,11 +2303,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/guest-reviews: get: tags: - - Content + - Content summary: Property Guest Reviews description: | Note: Property Guest Reviews are only available if your account is configured for access and all launch requirements have been followed. Please find the launch requirements here [https://support.expediapartnersolutions.com/hc/en-us/articles/360008646799](https://support.expediapartnersolutions.com/hc/en-us/articles/360008646799) and contact your Account Manager for more details. @@ -2317,145 +2317,145 @@ paths: To ensure you always show the latest guest reviews, this call should be made whenever a customer looks at the details for a specific property. operationId: getPropertyGuestReviews parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Japanese: - value: ja-JP - - name: property_id - in: path - description: Expedia Property ID. - required: true - schema: - type: string - example: 12345 - - name: filter - in: query - description: | - Single filter value. Send multiple instances of this parameter to request multiple filters. - * `language` - Filters reviews to only those that match the specified `language` parameter value. Without - this filter, the matching language will be preferred, but other language results can be returned. - Specifying this filter could produce an error when there are no matching results. - schema: - type: array - items: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: type: string - enum: - - language - examples: - Optional: - value: null - Single: - value: language - - name: trip_reason - in: query - description: | - Desired reason provided for the reviewer's trip that you wish to display. This parameter can be supplied - multiple times with different values, which will include reviews that match any of the requested trip - reasons. - required: false - schema: - type: array - items: + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: type: string - enum: - - business - - leisure - - friends_and_family - - business_and_leisure - examples: - Optional: - value: null - Single: - value: business - Multiple: - value: - - business - - business_and_leisure - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string - responses: - "200": - description: OK - headers: - Rate-Limit-Day: - $ref: '#/components/headers/Rate-Limit-Day' - Rate-Limit-Day-Remaining: - $ref: '#/components/headers/Rate-Limit-Day-Remaining' - Rate-Limit-Day-Reset: - $ref: '#/components/headers/Rate-Limit-Day-Reset' + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Japanese: + value: ja-JP + - name: property_id + in: path + description: Expedia Property ID. + required: true + schema: + type: string + example: 12345 + - name: filter + in: query + description: | + Single filter value. Send multiple instances of this parameter to request multiple filters. + * `language` - Filters reviews to only those that match the specified `language` parameter value. Without + this filter, the matching language will be preferred, but other language results can be returned. + Specifying this filter could produce an error when there are no matching results. + schema: + type: array + items: + type: string + enum: + - language + examples: + Optional: + value: null + Single: + value: language + - name: trip_reason + in: query + description: | + Desired reason provided for the reviewer's trip that you wish to display. This parameter can be supplied + multiple times with different values, which will include reviews that match any of the requested trip + reasons. + required: false + schema: + type: array + items: + type: string + enum: + - business + - leisure + - friends_and_family + - business_and_leisure + examples: + Optional: + value: null + Single: + value: business + Multiple: + value: + - business + - business_and_leisure + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: @@ -2473,31 +2473,31 @@ paths: example: verified: recent: - - verification_source: Expedia verified Review - title: Definitely staying again - date_submitted: '2019-02-11T18:19:40Z' - rating: "5" - reviewer_name: Bill - stay_date: 2019-02 - trip_reason: leisure - travel_companion: self - text: "Staff very helpful and friendly. Pool was 18 meters deep,\ + - verification_source: Expedia verified Review + title: Definitely staying again + date_submitted: '2019-02-11T18:19:40Z' + rating: "5" + reviewer_name: Bill + stay_date: 2019-02 + trip_reason: leisure + travel_companion: self + text: "Staff very helpful and friendly. Pool was 18 meters deep,\ \ very strange." - - verification_source: Expedia verified Review - title: Pool much too deep - date_submitted: '2019-02-10T11:15:01Z' - rating: "2" - reviewer_name: Gregory - stay_date: 2019-01 - trip_reason: friends_and_family - travel_companion: family_with_children - text: Bottom of the 18 meter pool was too scary. Staff were nice - though. - management_responses: - - text: | - Dear Guest, Thank you for your feedback. I hope we have the opportunity to welcome you back - in the near future. Best regards, Kara (General Manager) - date: '2019-02-11T14:36:54Z' + - verification_source: Expedia verified Review + title: Pool much too deep + date_submitted: '2019-02-10T11:15:01Z' + rating: "2" + reviewer_name: Gregory + stay_date: 2019-01 + trip_reason: friends_and_family + travel_companion: family_with_children + text: Bottom of the 18 meter pool was too scary. Staff were nice + though. + management_responses: + - text: | + Dear Guest, Thank you for your feedback. I hope we have the opportunity to welcome you back + in the near future. Best regards, Kara (General Manager) + date: '2019-02-11T14:36:54Z' "400": description: Invalid Input headers: @@ -2526,31 +2526,31 @@ paths: 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,\ + - 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,\ + 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 + fields: + - name: language + type: querystring + value: xXX "401": description: Unauthorized headers: @@ -2570,18 +2570,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -2683,11 +2683,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /files/properties/catalog: get: tags: - - Content + - Content summary: Property Catalog File description: | Returns a link to download the master list of EPS's active properties in the requested language. The response includes high-level details about each property. @@ -2717,95 +2717,95 @@ paths: ``` operationId: getPropertyCatalogFile parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) - - Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - example: en-US - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) - for more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) + + Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + example: en-US + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) + for more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -2862,31 +2862,31 @@ paths: 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,\ + - 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,\ + 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 + fields: + - name: language + type: querystring + value: xXX "401": description: Unauthorized headers: @@ -2906,18 +2906,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -2957,9 +2957,9 @@ paths: type: file.not_found message: The requested file could not be found. fields: - - name: filename - type: path - value: file.jsonl.gz + - name: filename + type: path + value: file.jsonl.gz "426": description: Upgrade Required headers: @@ -3023,11 +3023,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /files/properties/content: get: tags: - - Content + - Content summary: Property Content File 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. @@ -3041,101 +3041,101 @@ paths: ``` operationId: getPropertyContentFile parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Japanese: - value: ja-JP - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) - for more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Japanese: + value: ja-JP + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) + for more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -3192,31 +3192,31 @@ paths: 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,\ + - 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,\ + 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 + fields: + - name: language + type: querystring + value: xXX "401": description: Unauthorized headers: @@ -3236,18 +3236,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -3287,9 +3287,9 @@ paths: type: file.not_found message: The requested file could not be found. fields: - - name: filename - type: path - value: file.jsonl.gz + - name: filename + type: path + value: file.jsonl.gz "426": description: Upgrade Required headers: @@ -3353,11 +3353,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /regions: get: tags: - - Geography + - Geography summary: Regions description: | Returns the geographic definition and property mappings of regions matching the specified parameters.

    @@ -3368,214 +3368,214 @@ paths: The response is a paginated list of regions. See the `Link` header in the 200 response section. operationId: getRegions parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: include - in: query - 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. - required: true - schema: - type: array - items: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: type: string - enum: - - standard - - details - - property_ids - - property_ids_expanded - examples: - Single: - value: standard - Multiple: - value: - - property_ids - - standard - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Japanese: - value: ja-JP - - name: ancestor_id - in: query - description: | - Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of - [top level regions](https://developers.expediagroup.com/docs/rapid/lodging/geography/geography-reference-lists). - schema: - type: string - examples: - Optional: - value: null - Single: - value: 602962 - - name: area - in: query - description: | - Filter the results to regions that intersect with a specified area.

    - The area may be defined in one of two ways: - * radius,region_id - * radius,latitude,longitude - - Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
    - Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
    - Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
    - When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
    - Due to the number of results, unless `point_of_interest` is specified as the only type, regions of type `point_of_interest` - will not be included in a request that filters to an area.

    - An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
    - `&type=airport&limit=3&area=50,37.227924,-93.310036` - schema: - type: string - examples: - Optional: - value: null - Area: - value: "3,602962" - - name: country_code - in: query - description: | - Filter the results to a specified ISO 3166-1 alpha-2 country code. - - For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) - schema: - type: array - items: + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: type: string - examples: - Optional: - value: null - United States: - value: US - - name: country_subdivision_code - in: query - description: Filter the results down to only the ISO 3166-2 country subdivision. - schema: - type: array - items: + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: type: string - examples: - Optional: - value: null - Missouri: - value: US-MO - - name: iata_location_code - in: query - description: | - Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. - schema: - type: string - examples: - Optional: - value: null - Springfield: - value: SGF - - name: limit - in: query - description: | - Limit the number of results returned. - Using the area parameter will impose a max value of 100 for this whether specified or not. - schema: - type: number - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. - schema: - type: string - examples: - Optional: - value: null - VRBO: - value: vrbo - - name: type - in: query - description: | - Filter the results to a specified region type. - schema: - type: array - items: + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: include + in: query + 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. + required: true + schema: + type: array + items: + type: string + enum: + - standard + - details + - property_ids + - property_ids_expanded + examples: + Single: + value: standard + Multiple: + value: + - property_ids + - standard + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Japanese: + value: ja-JP + - name: ancestor_id + in: query + description: | + Search for regions whose ancestors include the requested ancestor region ID. Refer to the list of + [top level regions](https://developers.expediagroup.com/docs/rapid/lodging/geography/geography-reference-lists). + schema: + type: string + examples: + Optional: + value: null + Single: + value: 602962 + - name: area + in: query + description: | + Filter the results to regions that intersect with a specified area.

    + The area may be defined in one of two ways: + * radius,region_id + * radius,latitude,longitude + + Radius combined with region id would search an area that extends the number of kilometers out from the boundaries of the region in all directions.
    + Radius combined with a single point, specified by a latitude, longitude pair would search an area in a circle with the specified radius and the point as the center.
    + Radius should be specified in non-negative whole kilometers, decimals will return an error. A radius of 0 is allowed.
    + When specifying the area parameter, there will be a limit of 100 results, which can be narrowed further by the limit parameter.
    + Due to the number of results, unless `point_of_interest` is specified as the only type, regions of type `point_of_interest` + will not be included in a request that filters to an area.

    + An example use case would be searching for the closest 3 airports within 50 kilometers of a specified point.
    + `&type=airport&limit=3&area=50,37.227924,-93.310036` + schema: + type: string + examples: + Optional: + value: null + Area: + value: "3,602962" + - name: country_code + in: query + description: | + Filter the results to a specified ISO 3166-1 alpha-2 country code. + + For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) + schema: + type: array + items: + type: string + examples: + Optional: + value: null + United States: + value: US + - name: country_subdivision_code + in: query + description: Filter the results down to only the ISO 3166-2 country subdivision. + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Missouri: + value: US-MO + - name: iata_location_code + in: query + description: | + Search for regions by the requested 3-character IATA location code, which will apply to both iata_airport_code and iata_airport_metro_code. The code must be upper case. + schema: + type: string + examples: + Optional: + value: null + Springfield: + value: SGF + - name: limit + in: query + description: | + Limit the number of results returned. + Using the area parameter will impose a max value of 100 for this whether specified or not. + schema: + type: number + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. + schema: + type: string + examples: + Optional: + value: null + VRBO: + value: vrbo + - name: type + in: query + description: | + Filter the results to a specified region type. + schema: + type: array + items: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string responses: "200": description: OK @@ -3643,96 +3643,96 @@ paths: examples: Regions: value: - - id: "602962" - type: multi_city_vicinity - name: Springfield - name_full: "Springfield, Missouri, United States of America" - descriptor: and vicinity - country_code: US - country_subdivision_code: US-MO - 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" - - 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 - country_subdivision_code: US-MO - 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 - - id: "4605779" - type: airport - name: "Springfield, MO (SGF-Springfield-Branson National)" - name_full: "Springfield, MO, United States (SGF-Springfield-Branson\ + name: Springfield + name_full: "Springfield, Missouri, United States of America" + descriptor: and vicinity + country_code: US + country_subdivision_code: US-MO + 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" + - 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 + country_subdivision_code: US-MO + 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 + - id: "4605779" + type: airport + name: "Springfield, MO (SGF-Springfield-Branson National)" + name_full: "Springfield, MO, United States (SGF-Springfield-Branson\ \ National)" - iata_airport_code: SGF - country_code: US - country_subdivision_code: US-MO - coordinates: - center_longitude: -93.382095 - center_latitude: 37.24233 - associations: - multi_city_vicinity: - - "6058734" - ancestors: - - id: "602962" - type: multi_city_vicinity - - id: "227" - type: province_state - - id: "201" - type: country - - id: "500001" - type: continent + iata_airport_code: SGF + country_code: US + country_subdivision_code: US-MO + coordinates: + center_longitude: -93.382095 + center_latitude: 37.24233 + associations: + multi_city_vicinity: + - "6058734" + ancestors: + - id: "602962" + type: multi_city_vicinity + - id: "227" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent No regions: value: [] "400": @@ -3785,13 +3785,13 @@ paths: 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,\ + - 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 + fields: + - name: include + type: querystring + value: STANDARD "401": description: Unauthorized headers: @@ -3811,18 +3811,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -4007,130 +4007,130 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /regions/{region_id}: get: tags: - - Geography + - Geography summary: Region description: | Returns the geographic definition and property mappings for the requested Region ID. The response is a single JSON formatted region object. operationId: getRegion parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: region_id - in: path - description: | - ID of the region to retrieve. - required: true - schema: - type: string - example: 178248 - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) - - Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - example: en-US - - name: include - in: query - 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. - required: true - style: form - explode: true - schema: - type: array - items: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: type: string - enum: + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: region_id + in: path + description: | + ID of the region to retrieve. + required: true + schema: + type: string + example: 178248 + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/) + + Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + example: en-US + - name: include + in: query + 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. + required: true + style: form + explode: true + schema: + type: array + items: + type: string + enum: + - details + - property_ids + - property_ids_expanded + example: - details - - property_ids - - property_ids_expanded - example: - - details - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. - schema: - type: string - examples: - Optional: - value: null - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the geography response. This parameter may only be supplied once and will return all properties that match the requested supply source. An error is thrown if the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) for more information. + schema: + type: string + examples: + Optional: + value: null + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -4193,64 +4193,64 @@ paths: 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 + - - - - -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: "215" - type: province_state - - id: "201" - type: country - - id: "500001" - type: continent + - id: "215" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent descendants: high_level_region: - - "6330730" + - "6330730" city: - - "10014" - - "9975" + - "10014" + - "9975" property_ids: - - "37242" - - "859343" + - "37242" + - "859343" property_ids_expanded: - - "37242" - - "859343" - - "48972" + - "37242" + - "859343" + - "48972" Airport: value: id: "4477519" @@ -4266,16 +4266,16 @@ paths: center_latitude: 41.97693 associations: multi_city_vicinity: - - "178248" + - "178248" ancestors: - - id: "178309" - type: province_state - - id: "215" - type: province_state - - id: "201" - type: country - - id: "500001" - type: continent + - id: "178309" + type: province_state + - id: "215" + type: province_state + - id: "201" + type: country + - id: "500001" + type: continent "400": description: Bad Request headers: @@ -4326,13 +4326,13 @@ paths: 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,\ + - type: include.invalid + message: "Include is invalid. Accepted include values are: [details,\ \ property_ids, property_ids_expanded]" - fields: - - name: include - type: querystring - value: DETAILS + fields: + - name: include + type: querystring + value: DETAILS "401": description: Unauthorized headers: @@ -4352,18 +4352,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -4425,9 +4425,9 @@ paths: type: region.not_found message: The requested region could not be found. fields: - - name: region_id - type: path - value: "29384729424" + - name: region_id + type: path + value: "29384729424" "426": description: Upgrade Required headers: @@ -4513,11 +4513,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/geography: post: tags: - - Geography + - Geography summary: Properties within Polygon description: | Returns the properties within an custom polygon that represents a multi-city area or smaller. @@ -4527,96 +4527,96 @@ paths: * Number of coordinates - must be <= 2000 operationId: postGeography parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: include - in: query - description: | - Options for which content to return in the response. The value must be lower case. - * property_ids - Include the property IDs. - required: true - schema: - type: string - example: property_ids - - name: supply_source - in: query - description: | - Options for which supply source you would like returned in the content response. This parameter may only be - supplied once and will return all properties that match the requested supply source. An error is thrown if - the parameter is provided multiple times. - * `expedia` - Standard Expedia supply. - * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their - profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) - for more information. - required: true - schema: - type: string - examples: - Standard: - value: expedia - VRBO: - value: vrbo - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: include + in: query + description: | + Options for which content to return in the response. The value must be lower case. + * property_ids - Include the property IDs. + required: true + schema: + type: string + example: property_ids + - name: supply_source + in: query + description: | + Options for which supply source you would like returned in the content response. This parameter may only be + supplied once and will return all properties that match the requested supply source. An error is thrown if + the parameter is provided multiple times. + * `expedia` - Standard Expedia supply. + * `vrbo` - VRBO supply - This option is restricted to partners who have VRBO supply enabled for their + profile. See [Vacation Rentals](https://developers.expediagroup.com/docs/rapid/lodging/vacation-rentals) + for more information. + required: true + schema: + type: string + examples: + Standard: + value: expedia + VRBO: + value: vrbo + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string requestBody: content: application/json: @@ -4731,8 +4731,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: polygon.coordinates_required - message: The polygon must have coordinates. + - type: polygon.coordinates_required + message: The polygon must have coordinates. "401": description: Unauthorized headers: @@ -4752,18 +4752,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -4861,11 +4861,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/availability: get: tags: - - Shopping + - Shopping 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. @@ -4874,337 +4874,337 @@ paths: * 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). operationId: getAvailability parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: checkin - in: query - description: | - Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days. - required: true - schema: - type: string - example: '2025-07-01' - - name: checkout - in: query - description: | - Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations. - required: true - schema: - type: string - example: '2025-07-03' - - name: currency - in: query - description: | - Requested currency for the rates, in ISO 4217 format

    - Currency Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options](https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options) - required: true - schema: - type: string - examples: - Dollar: - value: USD - - name: country_code - in: query - 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.
    - For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) - required: true - schema: - type: string - examples: - United States: - value: US - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
    - Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - - name: occupancy - in: query - 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 - style: form - explode: true - schema: - type: array - items: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: type: string - examples: - Two: - value: 2 - - name: property_id - in: query - description: | - The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. - required: true - style: form - explode: true - schema: - type: array - items: + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: type: string - examples: - Single: - value: - - 20321 - - name: rate_plan_count - in: query - description: | - The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized.

    - The value must be between 1 and 250. - required: true - schema: - type: number - examples: - Single: - value: 1 - - name: sales_channel - in: query - 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 - schema: - type: string - examples: - Website: - value: website - - name: sales_environment - in: query - 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 - schema: - type: string - examples: - Hotel: - value: hotel_only - - name: amenity_category - in: query - description: | - Single amenity category. Send multiple instances of this parameter to request rates that match multiple amenity categories.
    - See the Amenity Categories section of the - [Content Reference Lists](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) - for a list of values. - style: form - explode: true - schema: - type: array - items: + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: type: string - examples: - Optional: - value: null - Multiple: - value: - - swimming_pool - - name: exclusion - in: query - description: | - Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    - * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. - * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. - schema: - type: array - items: + example: TravelNow/3.30.112 + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: type: string - enum: - - refundable_damage_deposit - - card_on_file - examples: - Optional: - value: null - Single: - value: - - refundable_damage_deposit - Multiple: - value: - - refundable_damage_deposit - - card_on_file - - name: filter - in: query - 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. - * `loyalty` - Filters results to only show rates that are eligible for loyalty points. - style: form - explode: true - schema: - type: array - items: + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: type: string - enum: - - refundable - - expedia_collect - - property_collect - examples: - Optional: - value: null - Multiple: - value: - - expedia_collect - - name: include - in: query - description: | - Modify the response by including types of responses that are not provided by default.
    - * `unavailable_reason` - When a property is unavailable for an actionable reason, return a response with that reason - See [Unavailable Reason Codes](https://developers.expediagroup.com/docs/rapid/resources/reference/unavailable-reason-codes) for possible values. - * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `room.rate.sale_scenario` section of the response. - * `rooms.rates.marketing_fee_incentives` - When a rate has a marketing fee incentive applied, the response will include the `marketing_fee_incentives` array if this flag is provided in the request. - * `rooms.rates.current_refundability` - Displays the current `refundability` of a rate. - schema: - type: array - items: + - name: Test + in: header + 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` + schema: type: string enum: - - unavailable_reason - - sale_scenario.mobile_promotion - - rooms.rates.marketing_fee_incentives - - rooms.rates.current_refundability - examples: - Optional: - value: null - Multiple: - value: - - unavailable_reason - - name: rate_option - in: query - description: | - Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. - Accepted values:
    - * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. - * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. - * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. - style: form - explode: true - schema: - type: array - items: + - standard + - service_unavailable + - unknown_internal_error + - name: checkin + in: query + description: | + Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days. + required: true + schema: + type: string + example: '2025-07-01' + - name: checkout + in: query + description: | + Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations. + required: true + schema: + type: string + example: '2025-07-03' + - name: currency + in: query + description: | + Requested currency for the rates, in ISO 4217 format

    + Currency Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options](https://developers.expediagroup.com/docs/rapid/resources/reference/currency-options) + required: true + schema: + type: string + examples: + Dollar: + value: USD + - name: country_code + in: query + 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.
    + For more information see: [https://www.iso.org/obp/ui/#search/code/](https://www.iso.org/obp/ui/#search/code/) + required: true + schema: + type: string + examples: + United States: + value: US + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. See [https://www.w3.org/International/articles/language-tags/](https://www.w3.org/International/articles/language-tags/)
    + Language Options: [https://developers.expediagroup.com/docs/rapid/resources/reference/language-options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + - name: occupancy + in: query + 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 + style: form + explode: true + schema: + type: array + items: + type: string + examples: + Two: + value: 2 + - name: property_id + in: query + description: | + The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. + required: true + style: form + explode: true + schema: + type: array + items: + type: string + examples: + Single: + value: + - 20321 + - name: rate_plan_count + in: query + description: | + The number of rates to return per property. The rates with the best value will be returned, e.g. a rate_plan_count=4 will return the best 4 rates, but the rates are not ordered from lowest to highest or vice versa in the response. Generally lowest rates will be prioritized.

    + The value must be between 1 and 250. + required: true + schema: + type: number + examples: + Single: + value: 1 + - name: sales_channel + in: query + 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 + schema: + type: string + examples: + Website: + value: website + - name: sales_environment + in: query + 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 + schema: + type: string + examples: + Hotel: + value: hotel_only + - name: amenity_category + in: query + description: | + Single amenity category. Send multiple instances of this parameter to request rates that match multiple amenity categories.
    + See the Amenity Categories section of the + [Content Reference Lists](https://developers.expediagroup.com/docs/rapid/lodging/content/content-reference-lists) + for a list of values. + style: form + explode: true + schema: + type: array + items: + type: string + examples: + Optional: + value: null + Multiple: + value: + - swimming_pool + - name: exclusion + in: query + description: | + Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    + * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. + * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. + schema: + type: array + items: + type: string + enum: + - refundable_damage_deposit + - card_on_file + examples: + Optional: + value: null + Single: + value: + - refundable_damage_deposit + Multiple: + value: + - refundable_damage_deposit + - card_on_file + - name: filter + in: query + 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. + * `loyalty` - Filters results to only show rates that are eligible for loyalty points. + style: form + explode: true + schema: + type: array + items: + type: string + enum: + - refundable + - expedia_collect + - property_collect + examples: + Optional: + value: null + Multiple: + value: + - expedia_collect + - name: include + in: query + description: | + Modify the response by including types of responses that are not provided by default.
    + * `unavailable_reason` - When a property is unavailable for an actionable reason, return a response with that reason - See [Unavailable Reason Codes](https://developers.expediagroup.com/docs/rapid/resources/reference/unavailable-reason-codes) for possible values. + * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `room.rate.sale_scenario` section of the response. + * `rooms.rates.marketing_fee_incentives` - When a rate has a marketing fee incentive applied, the response will include the `marketing_fee_incentives` array if this flag is provided in the request. + * `rooms.rates.current_refundability` - Displays the current `refundability` of a rate. + schema: + type: array + items: + type: string + enum: + - unavailable_reason + - sale_scenario.mobile_promotion + - rooms.rates.marketing_fee_incentives + - rooms.rates.current_refundability + examples: + Optional: + value: null + Multiple: + value: + - unavailable_reason + - name: rate_option + in: query + description: | + Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. + Accepted values:
    + * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. + * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. + * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. + style: form + explode: true + schema: + type: array + items: + type: string + enum: + - member + - net_rates + - cross_sell + - name: travel_purpose + in: query + description: | + This parameter is to specify the travel purpose of the booking. This may impact available rate plans, pricing, or tax calculations. + * `leisure` + * `business` + schema: type: string enum: - - member - - net_rates - - cross_sell - - name: travel_purpose - in: query - description: | - This parameter is to specify the travel purpose of the booking. This may impact available rate plans, pricing, or tax calculations. - * `leisure` - * `business` - schema: - type: string - enum: - - leisure - - business - examples: - Optional: - value: null - Single: - value: leisure - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - leisure + - business + examples: + Optional: + value: null + Single: + value: leisure + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -5256,559 +5256,559 @@ paths: examples: Availability: value: - - property_id: "19248" - status: available - rooms: - - id: 123abc - room_name: Fancy Queen Room - rates: - - id: 333abc - status: available - available_rooms: 12 - refundable: true - current_refundability: partially_refundable - member_deal_available: true - sale_scenario: - package: false - member: false - corporate: false - distribution: false - mobile_promotion: false - merchant_of_record: expedia - amenities: - "1234": - id: "1234" - name: Free Wireless Internet - links: - payment_options: - method: GET - href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL - bed_groups: - "12345": - links: - price_check: - method: GET - href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL - expires: '2019-03-05T07:23:14.000Z' - id: "12345" - description: 1 Queen Bed - configuration: - - type: Bed - size: Queen - quantity: 1 - cancel_penalties: - - currency: USD - start: '2018-02-12T11:59:00.000-08:00' - end: '2018-02-12T11:59:00.000-08:00' - amount: "10.00" - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - marketing_fee_incentives: - - source: property - start: '2022-02-02' - end: '2022-02-02' - occupancy_pricing: - "2": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - property_inclusive: - billable_currency: - value: "717.00" - currency: CAD - request_currency: - value: "539.00" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "490.00" - currency: USD - property_inclusive_strikethrough: - billable_currency: - value: "750.00" - currency: CAD - request_currency: - value: "565.00" + - property_id: "19248" + status: available + rooms: + - id: 123abc + room_name: Fancy Queen Room + rates: + - id: 333abc + status: available + available_rooms: 12 + refundable: true + current_refundability: partially_refundable + member_deal_available: true + sale_scenario: + package: false + member: false + corporate: false + distribution: false + mobile_promotion: false + merchant_of_record: expedia + amenities: + "1234": + id: "1234" + name: Free Wireless Internet + links: + payment_options: + method: GET + href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL + bed_groups: + "12345": + links: + price_check: + method: GET + href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL + expires: '2019-03-05T07:23:14.000Z' + id: "12345" + description: 1 Queen Bed + configuration: + - type: Bed + size: Queen + quantity: 1 + cancel_penalties: + - currency: USD + start: '2018-02-12T11:59:00.000-08:00' + end: '2018-02-12T11:59:00.000-08:00' + amount: "10.00" + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + marketing_fee_incentives: + - source: property + start: '2022-02-02' + end: '2022-02-02' + occupancy_pricing: + "2": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + property_inclusive: + billable_currency: + value: "717.00" + currency: CAD + request_currency: + value: "539.00" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "490.00" + currency: USD + property_inclusive_strikethrough: + billable_currency: + value: "750.00" + currency: CAD + request_currency: + value: "565.00" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "9.00" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + "1-7,10": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "490.00" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "10.00" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.00" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "9.00" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.00" + currency: USD + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + category: entertainment + offer_type: credit + frequency: per_stay + person_count: 1 + deal: + id: 999abc + description: Book early and save 15% + card_on_file_limit: + value: "500.00" + currency: USD + refundable_damage_deposit: + value: "500.00" + currency: USD + deposits: + - value: "70.00" + due: '2025-12-21' currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" + links: + additional_rates: + method: GET + href: /v3/properties/12345/availability?token=MY5S3j36cOcL + score: 10052 + Availability and Unavailable Reason: + value: + - property_id: "824739" + status: partially_unavailable + score: 12345 + unavailable_reason: + code: adults_exceed_threshold + data: "2" + - property_id: "19248" + status: available + rooms: + - id: 123abc + room_name: Fancy Queen Room + rates: + - id: 333abc + status: available + available_rooms: 12 + refundable: true + member_deal_available: true + sale_scenario: + package: false + member: false + corporate: false + distribution: false + mobile_promotion: false + merchant_of_record: expedia + amenities: + "1234": + id: "1234" + name: Free Wireless Internet + links: + payment_options: + method: GET + href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL + bed_groups: + "12345": + links: + price_check: + method: GET + href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL + expires: '2019-03-05T07:23:14.000Z' + id: "12345" + description: 1 Queen Bed + configuration: + - type: Bed + size: Queen + quantity: 1 + cancel_penalties: + - currency: USD + start: '2018-02-12T11:59:00.000-08:00' + end: '2018-02-12T11:59:00.000-08:00' + amount: "10.00" + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + occupancy_pricing: + "2": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + "1-7,10": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + category: entertainment + offer_type: credit + frequency: per_stay + person_count: 1 + deal: + id: 999abc + description: Book early and save 15% + card_on_file_limit: + value: "500.00" + currency: USD + refundable_damage_deposit: + value: "500.00" + currency: USD + deposits: + - value: "70.00" + due: '2025-12-21' currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "9.00" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - "1-7,10": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "490.00" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "10.00" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.00" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "9.00" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.00" - currency: USD - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - category: entertainment - offer_type: credit - frequency: per_stay - person_count: 1 - deal: - id: 999abc - description: Book early and save 15% - card_on_file_limit: - value: "500.00" - currency: USD - refundable_damage_deposit: - value: "500.00" - currency: USD - deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD - links: - additional_rates: - method: GET - href: /v3/properties/12345/availability?token=MY5S3j36cOcL - score: 10052 - Availability and Unavailable Reason: - value: - - property_id: "824739" - status: partially_unavailable - score: 12345 - unavailable_reason: - code: adults_exceed_threshold - data: "2" - - property_id: "19248" - status: available - rooms: - - id: 123abc - room_name: Fancy Queen Room - rates: - - id: 333abc - status: available - available_rooms: 12 - refundable: true - member_deal_available: true - sale_scenario: - package: false - member: false - corporate: false - distribution: false - mobile_promotion: false - merchant_of_record: expedia - amenities: - "1234": - id: "1234" - name: Free Wireless Internet - links: - payment_options: - method: GET - href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL - bed_groups: - "12345": - links: - price_check: - method: GET - href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL - expires: '2019-03-05T07:23:14.000Z' - id: "12345" - description: 1 Queen Bed - configuration: - - type: Bed - size: Queen - quantity: 1 - cancel_penalties: - - currency: USD - start: '2018-02-12T11:59:00.000-08:00' - end: '2018-02-12T11:59:00.000-08:00' - amount: "10.00" - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - occupancy_pricing: - "2": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - "1-7,10": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - category: entertainment - offer_type: credit - frequency: per_stay - person_count: 1 - deal: - id: 999abc - description: Book early and save 15% - card_on_file_limit: - value: "500.00" - currency: USD - refundable_damage_deposit: - value: "500.00" - currency: USD - deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD - links: - additional_rates: - method: GET - href: /v3/properties/12345/availability?token=MY5S3j36cOcL - score: 10052 + links: + additional_rates: + method: GET + href: /v3/properties/12345/availability?token=MY5S3j36cOcL + score: 10052 No availability: value: [] "400": @@ -5861,36 +5861,36 @@ paths: 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: checkout.invalid_length_of_stay_too_long_vrbo - message: | - Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. - fields: - - name: checkin - type: querystring - value: '2024-09-21' - - name: checkout - type: querystring - value: '2025-10-21' - - type: number_of_occupancies.invalid_above_maximum - message: Number of occupancies must be less than 9. - fields: - - name: occupancy - type: querystring - value: "9" - - type: include.not_supported - message: | - Include value not supported. Supported include values are: [unavailable_reason] - fields: - - name: include - type: querystring - value: free_money + - 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: checkout.invalid_length_of_stay_too_long_vrbo + message: | + Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. + fields: + - name: checkin + type: querystring + value: '2024-09-21' + - name: checkout + type: querystring + value: '2025-10-21' + - type: number_of_occupancies.invalid_above_maximum + message: Number of occupancies must be less than 9. + fields: + - name: occupancy + type: querystring + value: "9" + - type: include.not_supported + message: | + Include value not supported. Supported include values are: [unavailable_reason] + fields: + - name: include + type: querystring + value: free_money "401": description: Unauthorized headers: @@ -5910,18 +5910,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -6019,11 +6019,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/availability: get: tags: - - Shopping + - Shopping summary: Get additional property room rates and availability description: | Returns additional rates on available room types, using the parameters of the previous call. The response includes rate details such as promos, whether the rate is refundable, cancellation penalties and a full price breakdown to meet the price display requirements for your market. @@ -6031,242 +6031,242 @@ paths: * 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). operationId: getAdditionalAvailability parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - 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` - * `no_availability` - * `forbidden` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - no_availability - - forbidden - - name: property_id - in: path - description: | - Expedia Property ID.
    - required: true - schema: - type: string - example: 19248 - - name: token - in: query - description: "A hashed collection of query parameters. Used to maintain state\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + 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` + * `no_availability` + * `forbidden` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - no_availability + - forbidden + - name: property_id + in: path + description: | + Expedia Property ID.
    + required: true + schema: + type: string + example: 19248 + - name: token + in: query + description: "A hashed collection of query parameters. Used to maintain state\ \ across calls. This token is provided as part of the `additional_rates`\ \ link from the shop response, or the `shop` link on a `sold_out` price\ \ check response. It is also provided from the `shop_for_change` link on\ \ an itinerary retrieve." - required: true - schema: - type: string - - name: checkin - in: query - description: | - Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days.
    - Note: Only needed for hard change if desired check-in date is different than original booking. - If specified must also specify `checkout`. - schema: - type: string - example: '2025-07-01' - - name: checkout - in: query - description: | - Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations.
    - Note: Only needed for hard change if desired check-out date is different than original booking. - If specified must also specify `checkin`.
    - schema: - type: string - example: '2025-07-03' - - name: exclusion - in: query - description: | - Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    - Note: Optional parameter for use with hard change requests.
    - * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. - * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. - style: form - explode: true - schema: - type: array - items: + required: true + schema: type: string - enum: - - refundable_damage_deposit - - card_on_file - examples: - Optional: - value: null - Single: - value: - - refundable_damage_deposit - Multiple: - value: - - refundable_damage_deposit - - card_on_file - - name: filter - in: query - description: | - Single filter type. Send multiple instances of this parameter to request multiple filters.
    - Note: Optional parameter for use with hard change requests.
    - This parameter cannot be set to `property_collect` if the existing booking is `expedia_collect` and vice versa.
    - * `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. - * `loyalty` - Filters results to only show rates that are eligible for loyalty points. - style: form - explode: true - schema: - type: array - items: + - name: checkin + in: query + description: | + Check-in date, in ISO 8601 format (YYYY-MM-DD). This can be up to 365 days in the future. Some partner configurations may extend this up to 500 days.
    + Note: Only needed for hard change if desired check-in date is different than original booking. + If specified must also specify `checkout`. + schema: type: string - enum: - - refundable - - expedia_collect - - property_collect - examples: - Optional: - value: null - Refundable: - value: refundable - ExpediaCollect: - value: expedia_collect - Multiple: - value: - - refundable - - expedia_collect - - name: include - in: query - description: | - Modify the response by including types of responses that are not provided by default.
    - * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `sale_scenario` section of the response. - schema: - type: array - items: + example: '2025-07-01' + - name: checkout + in: query + description: | + Check-out date, in ISO 8601 format (YYYY-MM-DD). Total length of stay cannot exceed 28 nights or 365 nights depending on Vacation Rental configurations.
    + Note: Only needed for hard change if desired check-out date is different than original booking. + If specified must also specify `checkin`.
    + schema: type: string - enum: - - sale_scenario.mobile_promotion - examples: - Optional: - value: null - MobilePromotion: - value: sale_scenario.mobile_promotion - - name: occupancy - in: query - 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.
    - Note: Only needed for hard change if desired occupancy is different than original booking.
    - Examples: - * 2 adults, one 9-year-old and one 4-year-old would be represented by `occupancy=2-9,4`.
    - * A multi-room request to lodge an additional 2 adults would be represented by `occupancy=2-9,4&occupancy=2` - style: form - explode: true - schema: - type: array - items: + example: '2025-07-03' + - name: exclusion + in: query + description: | + Single exclusion type. Send multiple instances of this parameter to request multiple exclusions.
    + Note: Optional parameter for use with hard change requests.
    + * `refundable_damage_deposit` - Excludes Rapid supplied Vrbo rates with refundable damage deposits from the response. + * `card_on_file` - Excludes Rapid supplied Vrbo rates with card-on-file damage collection from the response. + style: form + explode: true + schema: + type: array + items: + type: string + enum: + - refundable_damage_deposit + - card_on_file + examples: + Optional: + value: null + Single: + value: + - refundable_damage_deposit + Multiple: + value: + - refundable_damage_deposit + - card_on_file + - name: filter + in: query + description: | + Single filter type. Send multiple instances of this parameter to request multiple filters.
    + Note: Optional parameter for use with hard change requests.
    + This parameter cannot be set to `property_collect` if the existing booking is `expedia_collect` and vice versa.
    + * `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. + * `loyalty` - Filters results to only show rates that are eligible for loyalty points. + style: form + explode: true + schema: + type: array + items: + type: string + enum: + - refundable + - expedia_collect + - property_collect + examples: + Optional: + value: null + Refundable: + value: refundable + ExpediaCollect: + value: expedia_collect + Multiple: + value: + - refundable + - expedia_collect + - name: include + in: query + description: | + Modify the response by including types of responses that are not provided by default.
    + * `sale_scenario.mobile_promotion` - Enable the `mobile_promotion` flag under the `sale_scenario` section of the response. + schema: + type: array + items: + type: string + enum: + - sale_scenario.mobile_promotion + examples: + Optional: + value: null + MobilePromotion: + value: sale_scenario.mobile_promotion + - name: occupancy + in: query + 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.
    + Note: Only needed for hard change if desired occupancy is different than original booking.
    + Examples: + * 2 adults, one 9-year-old and one 4-year-old would be represented by `occupancy=2-9,4`.
    + * A multi-room request to lodge an additional 2 adults would be represented by `occupancy=2-9,4&occupancy=2` + style: form + explode: true + schema: + type: array + items: + type: string + - name: rate_option + in: query + description: | + Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. + Note: Optional parameter for use with hard change requests.
    + Accepted values:
    + * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. + * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. + * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. + style: form + explode: true + schema: + type: array + items: + type: string + enum: + - member + - net_rates + - cross_sell + examples: + Optional: + value: null + Member: + value: member + NetRates: + value: net_rates + Multiple: + value: + - member + - net_rates + - name: sales_channel + in: query + description: | + Provide the sales channel if you wish to override the sales_channel provided in the previous call. EPS dynamically provides the best content for optimal conversion on each sales channel.
    + Note: Must specify this value for hard change requests.
    + * `website` - Standard website accessed from the customer's computer + * `agent_tool` - Your own agent tool used by your call center or retail store agent + * `mobile_app` - An application installed on a phone or tablet device + * `mobile_web` - A web browser application on a phone or tablet device + * `meta` - Rates will be passed to and displayed on a 3rd party comparison website + * `cache` - Rates will be used to populate a local cache + schema: type: string - - name: rate_option - in: query - description: | - Request specific rate options for each property. Send multiple instances of this parameter to request multiple rate options. - Note: Optional parameter for use with hard change requests.
    - Accepted values:
    - * `member` - Return member rates for each property. This feature must be enabled and requires a user to be logged in to request these rates. - * `net_rates` - Return net rates for each property. This feature must be enabled to request these rates. - * `cross_sell` - Identify if the traffic is coming from a cross sell booking. Where the traveler has booked another service (flight, car, activities...) before hotel. - style: form - explode: true - schema: - type: array - items: + - name: currency + in: query + description: | + Determines the returned currency type throughout the response
    + Note: This parameter is only valid for hard change requests and is ignored in all other cases + schema: type: string - enum: - - member - - net_rates - - cross_sell - examples: - Optional: - value: null - Member: - value: member - NetRates: - value: net_rates - Multiple: - value: - - member - - net_rates - - name: sales_channel - in: query - description: | - Provide the sales channel if you wish to override the sales_channel provided in the previous call. EPS dynamically provides the best content for optimal conversion on each sales channel.
    - Note: Must specify this value for hard change requests.
    - * `website` - Standard website accessed from the customer's computer - * `agent_tool` - Your own agent tool used by your call center or retail store agent - * `mobile_app` - An application installed on a phone or tablet device - * `mobile_web` - A web browser application on a phone or tablet device - * `meta` - Rates will be passed to and displayed on a 3rd party comparison website - * `cache` - Rates will be used to populate a local cache - schema: - type: string - - name: currency - in: query - description: | - Determines the returned currency type throughout the response
    - Note: This parameter is only valid for hard change requests and is ignored in all other cases - schema: - type: string responses: "200": description: OK @@ -6318,274 +6318,274 @@ paths: examples: Availability: value: - - property_id: 19248 - rooms: - - id: 123abc - room_name: Fancy Queen Room - rates: - - id: 333abc - status: available - available_rooms: 12 - refundable: true - member_deal_available: true - sale_scenario: - package: false - member: false - corporate: false - distribution: false - mobile_promotion: false - merchant_of_record: expedia - amenities: - "1234": - id: 1234 - name: Free Wireless Internet - links: - payment_options: - method: GET - href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL - bed_groups: - "12345": - links: - price_check: - method: GET - href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL - expires: '2019-03-05T07:23:14.000Z' - id: "12345" - description: 1 Queen Bed - configuration: - - type: Bed - size: Queen - quantity: 1 - cancel_penalties: - - currency: USD - start: '2018-02-12T11:59:00.000-08:00' - end: '2018-02-12T11:59:00.000-08:00' - amount: "10.00" - nights: 1 - percent: 30% - occupancy_pricing: - "2": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - "1-7,10": - nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD - stay: - - type: extra_person_fee - value: "10.00" - currency: CAD - totals: - inclusive: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - exclusive: - billable_currency: - value: "628.00" - currency: CAD - request_currency: - value: "475.00" - currency: USD - inclusive_strikethrough: - billable_currency: - value: "726.63" - currency: CAD - request_currency: - value: "549.60" - currency: USD - strikethrough: - billable_currency: - value: "650.00" - currency: CAD - request_currency: - value: "491.64" - currency: USD - marketing_fee: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - gross_profit: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - minimum_selling_price: - billable_currency: - value: "702.00" - currency: CAD - request_currency: - value: "530.97" - currency: USD - property_fees: - billable_currency: - value: "15.00" - currency: CAD - request_currency: - value: "11.34" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - resort_fee: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" - currency: USD - mandatory_tax: - billable_currency: - value: "5.00" - currency: CAD - request_currency: - value: "3.78" + - property_id: 19248 + rooms: + - id: 123abc + room_name: Fancy Queen Room + rates: + - id: 333abc + status: available + available_rooms: 12 + refundable: true + member_deal_available: true + sale_scenario: + package: false + member: false + corporate: false + distribution: false + mobile_promotion: false + merchant_of_record: expedia + amenities: + "1234": + id: 1234 + name: Free Wireless Internet + links: + payment_options: + method: GET + href: /v3/properties/19248/payment-options?token=MY5S3j36cOcL + bed_groups: + "12345": + links: + price_check: + method: GET + href: /v3/properties/19248/rooms/abc123/rates/abc123?token=MY5S3j36cOcL + expires: '2019-03-05T07:23:14.000Z' + id: "12345" + description: 1 Queen Bed + configuration: + - type: Bed + size: Queen + quantity: 1 + cancel_penalties: + - currency: USD + start: '2018-02-12T11:59:00.000-08:00' + end: '2018-02-12T11:59:00.000-08:00' + amount: "10.00" + nights: 1 + percent: 30% + occupancy_pricing: + "2": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + "1-7,10": + nightly: + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD + stay: + - type: extra_person_fee + value: "10.00" + currency: CAD + totals: + inclusive: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + exclusive: + billable_currency: + value: "628.00" + currency: CAD + request_currency: + value: "475.00" + currency: USD + inclusive_strikethrough: + billable_currency: + value: "726.63" + currency: CAD + request_currency: + value: "549.60" + currency: USD + strikethrough: + billable_currency: + value: "650.00" + currency: CAD + request_currency: + value: "491.64" + currency: USD + marketing_fee: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + gross_profit: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + minimum_selling_price: + billable_currency: + value: "702.00" + currency: CAD + request_currency: + value: "530.97" + currency: USD + property_fees: + billable_currency: + value: "15.00" + currency: CAD + request_currency: + value: "11.34" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + resort_fee: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + mandatory_tax: + billable_currency: + value: "5.00" + currency: CAD + request_currency: + value: "3.78" + currency: USD + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + category: entertainment + offer_type: credit + frequency: per_stay + person_count: 1 + deal: + id: 999abc + description: Book early and save 15% + card_on_file_limit: + value: "500.00" + currency: USD + refundable_damage_deposit: + value: "500.00" + currency: USD + deposits: + - value: "70.00" + due: '2025-12-21' currency: USD - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - category: entertainment - offer_type: credit - frequency: per_stay - person_count: 1 - deal: - id: 999abc - description: Book early and save 15% - card_on_file_limit: - value: "500.00" - currency: USD - refundable_damage_deposit: - value: "500.00" - currency: USD - deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD - links: - additional_rates: - method: GET - href: /v3/properties/12345/availability?token=MY5S3j36cOcL - score: 10052 + links: + additional_rates: + method: GET + href: /v3/properties/12345/availability?token=MY5S3j36cOcL + score: 10052 No availability: value: [] "400": @@ -6638,35 +6638,35 @@ paths: 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: checkout.invalid_length_of_stay_too_long_vrbo - message: | - Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. - fields: - - name: checkin - type: querystring - value: '2024-09-21' - - name: checkout - type: querystring - value: '2025-10-21' - - type: number_of_occupancies.invalid_above_maximum - message: Number of occupancies must be less than 9. - fields: - - name: occupancy - type: querystring - value: 9 - - type: filter.mismatch - message: "Existing booking is expedia_collect, this cannot be changed." - fields: - - name: filter - type: querystring - value: property_collect + - 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: checkout.invalid_length_of_stay_too_long_vrbo + message: | + Invalid date range. Checkin and checkout dates cannot differ by more than 365 days. + fields: + - name: checkin + type: querystring + value: '2024-09-21' + - name: checkout + type: querystring + value: '2025-10-21' + - type: number_of_occupancies.invalid_above_maximum + message: Number of occupancies must be less than 9. + fields: + - name: occupancy + type: querystring + value: 9 + - type: filter.mismatch + message: "Existing booking is expedia_collect, this cannot be changed." + fields: + - name: filter + type: querystring + value: property_collect "401": description: Unauthorized headers: @@ -6686,18 +6686,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -6792,109 +6792,109 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/rooms/{room_id}/rates/{rate_id}: get: tags: - - Shopping + - Shopping summary: Price-Check description: | Confirms the price returned by the Property Availability response. Use this API to verify a previously-selected rate is still valid before booking. If the price is matched, the response returns a link to request a booking. If the price has changed, the response returns new price details and a booking link for the new price. If the rate is no longer available, the response will return a new Property Availability request link to search again for different rates. In the event of a price change, go back to Property Availability and book the property at the new price or return to additional rates for the property. operationId: priceCheck parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - description: | - Price check calls have a test header that can be used to return set responses with the following keywords: - * `available` - * `price_changed` - * `sold_out` - * `service_unavailable` - * `unknown_internal_error` - schema: - type: string - enum: - - available - - price_changed - - sold_out - - service_unavailable - - unknown_internal_error - - name: property_id - in: path - description: | - Expedia Property ID.
    - required: true - schema: - type: string - example: 19248 - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: rate_id - in: path - description: | - Rate ID of a room.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - description: A hashed collection of query parameters. Used to maintain state - across calls. This token is provided as part of the price check link from - the shop response. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + description: | + Price check calls have a test header that can be used to return set responses with the following keywords: + * `available` + * `price_changed` + * `sold_out` + * `service_unavailable` + * `unknown_internal_error` + schema: + type: string + enum: + - available + - price_changed + - sold_out + - service_unavailable + - unknown_internal_error + - name: property_id + in: path + description: | + Expedia Property ID.
    + required: true + schema: + type: string + example: 19248 + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: rate_id + in: path + description: | + Rate ID of a room.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + description: A hashed collection of query parameters. Used to maintain state + across calls. This token is provided as part of the price check link from + the shop response. + required: true + schema: + type: string responses: "200": description: OK @@ -6948,12 +6948,12 @@ paths: occupancy_pricing: "2": nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD totals: inclusive: billable_currency: @@ -6984,9 +6984,9 @@ paths: value: "500.00" currency: USD deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD + - value: "70.00" + due: '2025-12-21' + currency: USD links: book: method: POST @@ -6998,12 +6998,12 @@ paths: occupancy_pricing: "2": nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD totals: inclusive: billable_currency: @@ -7029,20 +7029,20 @@ paths: currency: USD trader_information: traders: - - name: Test Property Name - address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" - country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf links: book: @@ -7055,12 +7055,12 @@ paths: occupancy_pricing: "2": nightly: - - - type: base_rate - value: "309.00" - currency: CAD - - type: tax_and_service_fee - value: "37.00" - currency: CAD + - - type: base_rate + value: "309.00" + currency: CAD + - type: tax_and_service_fee + value: "37.00" + currency: CAD totals: inclusive: billable_currency: @@ -7091,9 +7091,9 @@ paths: value: "500.00" currency: USD deposits: - - value: "70.00" - due: '2025-12-21' - currency: USD + - value: "70.00" + due: '2025-12-21' + currency: USD amount_owed: billable_currency: value: "132.56" @@ -7249,8 +7249,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -7270,18 +7270,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -7379,75 +7379,75 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /properties/{property_id}/payment-options: get: tags: - - Shopping + - Shopping summary: Get Accepted Payment Types - EPS MOR Only description: | Returns the accepted payment options. Use this API to power your checkout page and display valid forms of payment, ensuring a smooth booking. operationId: getPaymentOptions parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: property_id - in: path - description: | - Expedia Property ID.
    - required: true - schema: - type: string - example: 19248 - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: property_id + in: path + description: | + Expedia Property ID.
    + required: true + schema: + type: string + example: 19248 + - name: token + in: query + 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. + required: true + schema: + type: string responses: "200": description: OK @@ -7500,9 +7500,9 @@ paths: credit_card: name: Credit Card card_options: - - name: AmericanExpress - - name: MasterCard - processing_country: US + - name: AmericanExpress + - name: MasterCard + processing_country: US merchant: name: TRAVEL RESERVATION "400": @@ -7555,8 +7555,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "404": description: Not Found headers: @@ -7607,15 +7607,15 @@ paths: message: The requested property returned no payment options that are enabled for this point of sale. fields: - - name: property_id - type: path - value: "1337" - - name: token.currency - type: querystring - value: USD - - name: token.country_code - type: querystring - value: US + - name: property_id + type: path + value: "1337" + - name: token.currency + type: querystring + value: USD + - name: token.country_code + type: querystring + value: US "426": description: Upgrade Required headers: @@ -7698,11 +7698,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /calendars/availability: get: tags: - - Shopping + - Shopping summary: Get a calendar of availability dates for properties. This is currently a Vrbo property only feature. description: | @@ -7711,88 +7711,88 @@ paths: and information regarding the stay constraints. operationId: getCalendarAvailability parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Authorization - in: header - description: "The custom generated authentication header. Refer to our [signature\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Authorization + in: header + description: "The custom generated authentication header. Refer to our [signature\ \ authentication](https://developer.expediapartnersolutions.com/reference/signature-authentication)\ \ page for full details." - required: true - schema: - type: string - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: property_id - in: query - description: | - The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. - required: true - style: form - explode: true - schema: - type: array - items: + required: true + schema: type: string - examples: - Single: - value: 1234 - Multiple: - value: - - 1234 - - 5678 - - name: start_date - in: query - description: | - The first day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD), up to 500 days in the future from the current date. - required: true - schema: - type: string - format: date - example: '2025-07-15' - - name: end_date - in: query - description: | - The last day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD). This must be 365 days or less from the start_date. - required: true - schema: - type: string - format: date - example: '2026-01-17' + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: property_id + in: query + description: | + The ID of the property you want to search for. You can provide 1 to 250 property_id parameters. + required: true + style: form + explode: true + schema: + type: array + items: + type: string + examples: + Single: + value: 1234 + Multiple: + value: + - 1234 + - 5678 + - name: start_date + in: query + description: | + The first day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD), up to 500 days in the future from the current date. + required: true + schema: + type: string + format: date + example: '2025-07-15' + - name: end_date + in: query + description: | + The last day of availability information to be returned, in ISO 8601 format (YYYY-MM-DD). This must be 365 days or less from the start_date. + required: true + schema: + type: string + format: date + example: '2026-01-17' responses: "200": description: OK @@ -7844,42 +7844,42 @@ paths: examples: Single Property Availability: value: - - property_id: "1234" - days: - - date: '2022-09-20' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 14 - - date: '2022-09-21' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 14 + - property_id: "1234" + days: + - date: '2022-09-20' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 14 + - date: '2022-09-21' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 14 Multi Property Availability: value: - - property_id: "1234" - days: - - date: '2022-09-20' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 14 - - property_id: "5678" - days: - - date: '2022-09-20' - available: true - checkin: CHECKIN_VALID - checkout: CHECKOUT_VALID - stay_constraints: - min_stay: 1 - max_stay: 5 + - property_id: "1234" + days: + - date: '2022-09-20' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 14 + - property_id: "5678" + days: + - date: '2022-09-20' + available: true + checkin: CHECKIN_VALID + checkout: CHECKOUT_VALID + stay_constraints: + min_stay: 1 + max_stay: 5 No Results: value: [] "400": @@ -7932,19 +7932,19 @@ paths: 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" + - 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" "401": description: Unauthorized headers: @@ -7964,18 +7964,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -8073,91 +8073,91 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /payment-sessions: post: tags: - - Bookings + - Bookings summary: Register Payments description: | This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
    This link will be available in the Price Check response if payment registration is required. It returns a payment session ID and a link to create a booking. This will be the first step in the booking flow only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. Learn more with our [PSD2 Overview](https://developers.expediagroup.com/docs/rapid/lodging/booking/psd2-regulation) operationId: postPaymentSessions parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: token - in: query - 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. - required: true - schema: - type: string - requestBody: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: token + in: query + 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. + required: true + schema: + type: string + requestBody: content: application/json: schema: @@ -8267,11 +8267,11 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: payments.required - message: Payment is required. - fields: - - name: payments - type: body + - type: payments.required + message: Payment is required. + fields: + - name: payments + type: body "401": description: Unauthorized headers: @@ -8291,18 +8291,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -8400,11 +8400,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries: get: tags: - - Manage Booking + - Manage Booking summary: Search for and retrieve Bookings with Affiliate Reference Id description: | This can be called directly without a token when an affiliate reference id is provided. It returns details about bookings associated with an affiliate reference id, along with cancel links to cancel the bookings. @@ -8412,88 +8412,88 @@ paths: Note: Newly created itineraries may sometimes have a small delay between the time of creation and the time that the itinerary can be retrieved. If you receive no results while trying to search for an itinerary that was successfully created, or if you receive a response with two fields, namely, `itinerary_id` and `creation_date_time`, then please wait a few minutes before trying to search for the itinerary again. operationId: getReservation parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - 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. - * `degraded_response` - Requires valid test booking - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: affiliate_reference_id - in: query - description: | - The affilliate reference id value. This field supports a maximum of 28 characters. - required: true - schema: - type: string - examples: - Single: - value: 111A222BB33344CC5555 - - name: email - in: query - description: | - Email associated with the booking. Special characters in the local part or domain should be encoded.
    - required: true - schema: - type: string - examples: - Single: - value: test@example.com - - name: include - in: query - description: "Options for which information to return in the response. The\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + 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. + * `degraded_response` - Requires valid test booking + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: affiliate_reference_id + in: query + description: | + The affilliate reference id value. This field supports a maximum of 28 characters. + required: true + schema: + type: string + examples: + Single: + value: 111A222BB33344CC5555 + - name: email + in: query + description: | + Email associated with the booking. Special characters in the local part or domain should be encoded.
    + required: true + schema: + type: string + examples: + Single: + value: test@example.com + - name: include + in: query + description: "Options for which information to return in the response. The\ \ value must be lower case.\n* `history` - Include itinerary history, showing\ \ details of the changes made to this itinerary. Changes from the property/supplier\ \ have an event_source equal to `other` in the response. \n* `history_v2`\ @@ -8501,18 +8501,18 @@ paths: \ itinerary. Changes from the property/supplier have an event_source equal\ \ to `supplier` in the response. See the [Itinerary history](https://developers.expediagroup.com/docs/rapid/lodging/manage-booking/itinerary-history#overview)\ \ for details.\n" - required: false - schema: - type: array - items: - type: string - enum: - - history - examples: - Optional: - value: null - History: - value: history + required: false + schema: + type: array + items: + type: string + enum: + - history + examples: + Optional: + value: null + History: + value: history responses: "200": description: OK @@ -8564,128 +8564,870 @@ paths: examples: Itineraries: value: - - itinerary_id: "8999989898988" + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + non_vat_expedia_invoice: + method: GET + href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + trader_information: + traders: + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply + terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + invoicing: + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + point_of_sale_display: Global Travel Site + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itineraries with Property Collect: + value: + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + non_vat_expedia_invoice: + method: GET + href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: property + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + trader_information: + traders: + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply + terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itinerary with History and Change - Extend Stay: + value: + - itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" property_id: "8150374" links: cancel: method: DELETE href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - non_vat_expedia_invoice: - method: GET - href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m email: smith@example.com phone: country_code: "1" area_code: "487" number: "5550077" rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: -65.98 - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -8698,10 +9440,10 @@ paths: postal_code: "98121" country_code: US adjustment: - value: -100.0 + value: "-32.10" type: base_rate currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' + creation_date_time: '2017-08-15T15:32:55.523Z' affiliate_reference_id: 4480ABC affiliate_metadata: This booking was made with EPS. conversations: @@ -8709,29 +9451,31 @@ paths: property: method: GET href: https://www.example.com?key=123abd456 - travel_purpose: business - trader_information: - traders: - - name: Test Property Name - address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" - country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply - terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + travel_purpose: unspecified supplier_transparency: point_of_sale_display_to_share: Global Travel Site company_name_to_share: Traveler's Company consent_to_share: true + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' invoicing: + consent_to_share: true company_name: alphaDemandPartner company_address: line_1: 555 1st St @@ -8741,1508 +9485,764 @@ paths: state_province_code: WA postal_code: "98121" country_code: US - point_of_sale_display: Global Travel Site email: chucktesta@mydomain.com vat_number: "1234567890" - Itineraries with Property Collect: - value: - - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - non_vat_expedia_invoice: - method: GET - href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: property - refundable: true - cancel_refund: - amount: -65.98 - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" currency: USD - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" currency: USD - - type: sales_tax - value: "11.12" + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: canceled + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + No itineraries: + value: [] + "206": + description: Partial Content + headers: + Rate-Limit-Day: + description: Reserved for future use. Optional header for request capacity + per day. + schema: + type: number + Rate-Limit-Day-Remaining: + description: "Optional header for the remaining capacity, as a percentage,\ + \ for the daily time window." + schema: + type: number + Rate-Limit-Day-Reset: + description: "Optional header for the timestamp, as the number of milliseconds\ + \ since the Unix Epoch, when the daily capacity resets." + schema: + type: number + Rate-Limit-Minute: + description: Reserved for future use. Optional header for request capacity + per minute. + schema: + type: number + Rate-Limit-Minute-Remaining: + description: "Optional header for the remaining capacity, as a percentage,\ + \ for the per minute time window." + schema: + type: number + Rate-Limit-Minute-Reset: + description: "Optional header for the timestamp, as the number of milliseconds\ + \ since the Unix Epoch, when the per minute capacity resets." + schema: + type: number + Rate-Limit-Reduction-Status: + description: "Optional header that indicates the state (inactive, active)\ + \ of minute capacity reduction triggered once all daily capacity has\ + \ been used." + schema: + type: string + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Itinerary' + examples: + Itineraries: + value: + - itinerary_id: "8999989898988" + property_id: "8150374" links: cancel: method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + non_vat_expedia_invoice: method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: business - trader_information: - traders: - - name: Test Property Name + href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' + deposits: + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply - terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf - supplier_transparency: - point_of_sale_display_to_share: Global Travel Site - company_name_to_share: Traveler's Company - consent_to_share: true - additional_handling: - authorized_expenses: total_plus_incidentals - specified_incidental_expenses: - - breakfast - - internet - total_charges_allowed: - value: "875.00" + adjustment: + value: -100.0 + type: base_rate currency: USD - is_cvc_required: true - authorizing_company: Conferma - card_contact: + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US email: chucktesta@mydomain.com - phone: - country_code: "1" - area_code: "555" - number: "5555555" - payment_allowable_period_start: '2024-01-01' - payment_allowable_period_end: '2025-08-01' - invoicing: - consent_to_share: true - company_name: alphaDemandPartner - company_address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - email: chucktesta@mydomain.com - vat_number: "1234567890" + vat_number: "1234567890" + trader_information: + traders: + - name: Test Property Name + address: + line_1: 123 Main St + city: Springfield + state_province_code: MO + postal_code: "65804" + country_code: US + business_register_name: A Real Registry + business_register_number: 72973910d + self_certification: true + phone: 1-417-555-1212 + right_to_withdraw_message: | + The right of withdrawal under European consumer law does not apply when you book + accommodation. Supplier cancellation policy will apply + terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing Itinerary with History and Change - Extend Stay: value: - - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD + - itinerary_id: "8999989898988" + property_id: "8150374" links: cancel: method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - supplier_transparency: - point_of_sale_display_to_share: Global Travel Site - company_name_to_share: Traveler's Company - consent_to_share: true - additional_handling: - authorized_expenses: total_plus_incidentals - specified_incidental_expenses: - - breakfast - - internet - total_charges_allowed: - value: "875.00" + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + rate: + id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate currency: USD - is_cvc_required: true - authorizing_company: Conferma - card_contact: - email: chucktesta@mydomain.com - phone: - country_code: "1" - area_code: "555" - number: "5555555" - payment_allowable_period_start: '2024-01-01' - payment_allowable_period_end: '2025-08-01' - invoicing: - consent_to_share: true - company_name: alphaDemandPartner - company_address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - email: chucktesta@mydomain.com - vat_number: "1234567890" - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - supplier_transparency: - point_of_sale_display_to_share: Global Travel Site - company_name_to_share: Traveler's Company - consent_to_share: true - additional_handling: - authorized_expenses: total_plus_incidentals - specified_incidental_expenses: - - breakfast - - internet - total_charges_allowed: - value: "875.00" - currency: USD - is_cvc_required: true - authorizing_company: Conferma - card_contact: - email: chucktesta@mydomain.com - phone: - country_code: "1" - area_code: "555" - number: "5555555" - payment_allowable_period_start: '2024-01-01' - payment_allowable_period_end: '2025-08-01' - invoicing: - consent_to_share: true - company_name: alphaDemandPartner - company_address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - email: chucktesta@mydomain.com - vat_number: "1234567890" - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: canceled - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - No itineraries: - value: [] - "206": - description: Partial Content - headers: - Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number - Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number - Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number - Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number - Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number - Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number - Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string - Region: - $ref: '#/components/headers/Region' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Itinerary' - examples: - Itineraries: - value: - - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - non_vat_expedia_invoice: - method: GET - href: /v3/itineraries/8999989898988/invoice?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: business - additional_handling: - authorized_expenses: total_plus_incidentals - specified_incidental_expenses: - - breakfast - - internet - total_charges_allowed: - value: "875.00" - currency: USD - is_cvc_required: true - authorizing_company: Conferma - card_contact: - email: chucktesta@mydomain.com - phone: - country_code: "1" - area_code: "555" - number: "5555555" - payment_allowable_period_start: '2024-01-01' - payment_allowable_period_end: '2025-08-01' - invoicing: - consent_to_share: true - company_name: alphaDemandPartner - company_address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - email: chucktesta@mydomain.com - vat_number: "1234567890" - trader_information: - traders: - - name: Test Property Name - address: - line_1: 123 Main St - city: Springfield - state_province_code: MO - postal_code: "65804" - country_code: US - business_register_name: A Real Registry - business_register_number: 72973910d - self_certification: true - phone: 1-417-555-1212 - right_to_withdraw_message: | - The right of withdrawal under European consumer law does not apply when you book - accommodation. Supplier cancellation policy will apply - terms_and_conditions: https://forever.travel-assets.com/flex/flexmanager/mediaasset/618796-0_2-UnitedKingdom_en.pdf + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - Itinerary with History and Change - Extend Stay: - value: - - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: billable_currency: - value: "20.00" + value: "244.70" currency: USD - mandatory_tax: + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD Itinerary with History V2 - Traveler No Show: value: itinerary_id: "8999989898988" @@ -10257,166 +10257,29 @@ paths: area_code: "487" number: "5550077" rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" + - id: "926784314" confirmation_id: - expedia: "664637628" - property: COR8729347BB + expedia: "1234567890" + property: BEF23123AA bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 checkin: '2018-09-21' - checkout: '2018-09-22' + checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD rate: id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -10427,117 +10290,31 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" + - - type: base_rate + value: "111.23" currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" + - type: sales_tax + value: "11.12" currency: USD - resort_fee: - billable_currency: - value: "20.00" + - - type: base_rate + value: "111.23" currency: USD - mandatory_tax: - billable_currency: - value: "11.95" + - type: sales_tax + value: "11.12" currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: canceled - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -10568,6 +10345,229 @@ paths: billable_currency: value: "11.95" currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: canceled + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD No itineraries: value: [] "400": @@ -10620,12 +10620,12 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: email.invalid - message: Customer email address is invalid. - fields: - - name: email - type: querystring - value: thisisabademail + - type: email.invalid + message: Customer email address is invalid. + fields: + - name: email + type: querystring + value: thisisabademail "401": description: Unauthorized headers: @@ -10645,18 +10645,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -10754,95 +10754,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] post: tags: - - Bookings + - Bookings summary: Create Booking description: | This link will be available in the Price Check response or in the register payments response when Two-Factor Authentication is used. It returns an itinerary id and links to retrieve reservation details, cancel a held booking, resume a held booking or complete payment session. Please note that depending on the state of the booking, the response will contain only the applicable link(s). operationId: postItinerary parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The book call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - * `complete_payment_session` - * `service_unavailable` - * `internal_server_error` - * `price_mismatch` - * `cc_declined` - * `rooms_unavailable` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - price_mismatch - - cc_declined - - rooms_unavailable - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The book call has a test header that can be used to return set responses with the following keywords:
    + * `standard` + * `complete_payment_session` + * `service_unavailable` + * `internal_server_error` + * `price_mismatch` + * `cc_declined` + * `rooms_unavailable` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - price_mismatch + - cc_declined + - rooms_unavailable + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: content: application/json: @@ -10859,39 +10859,39 @@ paths: area_code: "487" number: "5550077" rooms: - - given_name: John - family_name: Smith - smoking: false - special_request: Top floor or away from street please - loyalty_id: ABC123 - payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John + - given_name: John family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - enrollment_date: '2018-09-15' - third_party_authentication: - cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= - eci: "05" - three_ds_version: 2.2.0 - ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de - pa_res_status: "Y" - ve_res_status: C - xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 - cavv_algorithm: "3" - ucaf_indicator: "0" + smoking: false + special_request: Top floor or away from street please + loyalty_id: ABC123 + payments: + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + enrollment_date: '2018-09-15' + third_party_authentication: + cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= + eci: "05" + three_ds_version: 2.2.0 + ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de + pa_res_status: "Y" + ve_res_status: C + xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 + cavv_algorithm: "3" + ucaf_indicator: "0" affiliate_metadata: data_point_1:123|data_point2:This is data. tax_registration_number: "12345678910" traveler_handling_instructions: Please use the card provided for @@ -10907,50 +10907,50 @@ paths: hold: false email: john@example.com phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - given_name: John - family_name: Smith - smoking: false - special_request: Top floor or away from street please - loyalty_id: ABC123 - payments: - - type: virtual_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - additional_handling: - authorized_expenses: total_plus_incidentals - specified_incidental_expenses: - - breakfast - - internet - total_charges_allowed: - value: "875.00" - currency: USD - is_cvc_required: true - authorizing_company: Conferma - card_contact: - email: chucktesta@mydomain.com - phone: - country_code: "1" - area_code: "555" - number: "5555555" - payment_allowable_period_start: '2024-01-01' - payment_allowable_period_end: '2025-08-01' + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - given_name: John + family_name: Smith + smoking: false + special_request: Top floor or away from street please + loyalty_id: ABC123 + payments: + - type: virtual_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" + currency: USD + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' invoicing: consent_to_share: true company_name: alphaDemandPartner @@ -11096,25 +11096,25 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: address.country_code.invalid - message: Address country code is invalid. - fields: - - name: country_code - type: body - value: ABCD + - type: address.country_code.invalid + message: Address country code is invalid. + fields: + - name: country_code + type: body + value: ABCD Duplicate Itinerary Example: value: type: invalid_input message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: duplicate_itinerary - message: An itinerary already exists with this affiliate reference - id. - fields: - - name: affiliate_reference_id - type: body - value: ABCD + - type: duplicate_itinerary + message: An itinerary already exists with this affiliate reference + id. + fields: + - name: affiliate_reference_id + type: body + value: ABCD "401": description: Unauthorized headers: @@ -11134,18 +11134,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -11208,12 +11208,12 @@ paths: 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" + - name: payments.amount + type: body + value: "100.00" + - name: price.amount + type: body + value: "120.00" "410": description: Sold Out headers: @@ -11347,11 +11347,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}: get: tags: - - Manage Booking + - Manage Booking summary: Retrieve Booking description: | This API call returns itinerary details and links to resume or cancel the booking. There are two methods to retrieve a booking: @@ -11361,93 +11361,93 @@ paths: 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, or if you receive a response with two fields, namely, `itinerary_id` and `creation_date_time`, then please wait a few minutes before trying to retrieve the itinerary again. operationId: getReservationByItineraryId parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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. - * `degraded_response` - Requires valid test booking - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - schema: - type: string - - name: email - in: query - description: | - Email associated with the booking. Special characters in the local part or domain should be encoded. (Email is required if the token is not provided the request)
    - schema: - type: string - examples: - Optional: - value: null - Single: - value: test@example.com - - name: include - in: query - description: "Options for which information to return in the response. The\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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. + * `degraded_response` - Requires valid test booking + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + schema: + type: string + - name: email + in: query + description: | + Email associated with the booking. Special characters in the local part or domain should be encoded. (Email is required if the token is not provided the request)
    + schema: + type: string + examples: + Optional: + value: null + Single: + value: test@example.com + - name: include + in: query + description: "Options for which information to return in the response. The\ \ value must be lower case.\n* `history` - Include itinerary history, showing\ \ details of the changes made to this itinerary. Changes from the property/supplier\ \ have an event_source equal to `other` in the response. \n* `history_v2`\ @@ -11455,18 +11455,18 @@ paths: \ itinerary. Changes from the property/supplier have an event_source equal\ \ to `supplier` in the response. See the [Itinerary history](https://developers.expediagroup.com/docs/rapid/lodging/manage-booking/itinerary-history#overview)\ \ for details.\n" - required: false - schema: - type: array - items: - type: string - enum: - - history - examples: - Optional: - value: null - History: - value: history + required: false + schema: + type: array + items: + type: string + enum: + - history + examples: + Optional: + value: null + History: + value: history responses: "200": description: OK @@ -11510,355 +11510,11 @@ paths: Region: $ref: '#/components/headers/Region' content: - application/json: - schema: - $ref: '#/components/schemas/Itinerary' - examples: - Itinerary No History: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - loyalty_id: ABC123 - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: -65.98 - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: business - supplier_transparency: - point_of_sale_display_to_share: Global Travel Site - company_name_to_share: Traveler's Company - consent_to_share: true - invoicing: - company_name: alphaDemandPartner - company_address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - point_of_sale_display: Global Travel Site - email: chucktesta@mydomain.com - vat_number: "1234567890" - Itinerary No History with Property Collect: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - loyalty_id: ABC123 - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: -65.98 - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: business - supplier_transparency: - point_of_sale_display_to_share: Global Travel Site - company_name_to_share: Traveler's Company - consent_to_share: true - additional_handling: - authorized_expenses: total_plus_incidentals - specified_incidental_expenses: - - breakfast - - internet - total_charges_allowed: - value: "875.00" - currency: USD - is_cvc_required: true - authorizing_company: Conferma - card_contact: - email: chucktesta@mydomain.com - phone: - country_code: "1" - area_code: "555" - number: "5555555" - payment_allowable_period_start: '2024-01-01' - payment_allowable_period_end: '2025-08-01' - invoicing: - consent_to_share: true - company_name: alphaDemandPartner - company_address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - email: chucktesta@mydomain.com - vat_number: "1234567890" - Itinerary with History: + application/json: + schema: + $ref: '#/components/schemas/Itinerary' + examples: + Itinerary No History: value: itinerary_id: "8999989898988" property_id: "8150374" @@ -11872,176 +11528,34 @@ paths: area_code: "487" number: "5550077" rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - supplier_transparency: - point_of_sale_display_to_share: Global Travel Site - company_name_to_share: Traveler's Company - consent_to_share: true - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" + - id: "926784314" confirmation_id: - expedia: "664637628" - property: COR8729347BB + expedia: "1234567890" + property: BEF23123AA bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 checkin: '2018-09-21' - checkout: '2018-09-22' + checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD + loyalty_id: ABC123 rate: id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -12052,40 +11566,48 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: - value: "244.70" + value: "368.15" currency: USD exclusive: billable_currency: - value: "234.68" + value: "345.91" currency: USD marketing_fee: billable_currency: - value: "5.14" + value: "7.75" currency: USD property_fees: billable_currency: @@ -12104,12 +11626,72 @@ paths: billable_currency: value: "11.95" currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + invoicing: + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + point_of_sale_display: Global Travel Site + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itinerary No History with Property Collect: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -12118,19 +11700,25 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD + loyalty_id: ABC123 rate: id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: -65.98 + currency: USD + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -12141,28 +11729,36 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -12193,127 +11789,16 @@ paths: billable_currency: value: "11.95" currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - refundable: true - cancel_refund: - amount: "-65.98" - currency: USD - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - cancel_penalties: - - start: '2018-01-01T01:01:01.000-08:00' - end: '2018-12-12T01:01:01.000-08:00' - amount: "250.75" - currency: USD - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - shop_for_change: - method: GET - href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -12326,10 +11811,10 @@ paths: postal_code: "98121" country_code: US adjustment: - value: "-32.10" + value: -100.0 type: base_rate currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' + creation_date_time: '2017-08-17T13:31:15.523Z' affiliate_reference_id: 4480ABC affiliate_metadata: This booking was made with EPS. conversations: @@ -12337,46 +11822,83 @@ paths: property: method: GET href: https://www.example.com?key=123abd456 - travel_purpose: unspecified + travel_purpose: business supplier_transparency: point_of_sale_display_to_share: Global Travel Site company_name_to_share: Traveler's Company consent_to_share: true - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" + additional_handling: + authorized_expenses: total_plus_incidentals + specified_incidental_expenses: + - breakfast + - internet + total_charges_allowed: + value: "875.00" currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" + is_cvc_required: true + authorizing_company: Conferma + card_contact: + email: chucktesta@mydomain.com + phone: + country_code: "1" + area_code: "555" + number: "5555555" + payment_allowable_period_start: '2024-01-01' + payment_allowable_period_end: '2025-08-01' + invoicing: + consent_to_share: true + company_name: alphaDemandPartner + company_address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + email: chucktesta@mydomain.com + vat_number: "1234567890" + Itinerary with History: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" confirmation_id: - expedia: "664637628" - property: COR8729347BB + expedia: "1234567890" + property: BEF23123AA bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 checkin: '2018-09-21' - checkout: '2018-09-22' + checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD rate: id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -12387,40 +11909,48 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: - value: "244.70" + value: "368.15" currency: USD exclusive: billable_currency: - value: "234.68" + value: "345.91" currency: USD marketing_fee: billable_currency: - value: "5.14" + value: "7.75" currency: USD property_fees: billable_currency: @@ -12439,12 +11969,245 @@ paths: billable_currency: value: "11.95" currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -12453,19 +12216,24 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo - status: canceled + status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD rate: id: "035943984" + merchant_of_record: expedia + refundable: true + cancel_refund: + amount: "-65.98" + currency: USD + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -12476,28 +12244,36 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + cancel_penalties: + - start: '2018-01-01T01:01:01.000-08:00' + end: '2018-12-12T01:01:01.000-08:00' + amount: "250.75" + currency: USD + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -12528,6 +12304,230 @@ paths: billable_currency: value: "11.95" currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + shop_for_change: + method: GET + href: /v3/properties/8150374/availability?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + supplier_transparency: + point_of_sale_display_to_share: Global Travel Site + company_name_to_share: Traveler's Company + consent_to_share: true + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: canceled + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD "206": description: Partial Content headers: @@ -12583,311 +12583,35 @@ paths: method: DELETE href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - loyalty_id: ABC123 - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - nonrefundable_date_ranges: - - start: '2022-02-02' - end: '2022-02-02' - deposits: - - currency: USD - value: "220.75" - due: '2018-12-12T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: -100.0 - type: base_rate - currency: USD - creation_date_time: '2017-08-17T13:31:15.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: business - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - Itinerary with History: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - adjustment: - value: "-32.10" - type: base_rate - currency: USD - creation_date_time: '2017-08-15T15:32:55.523Z' - affiliate_reference_id: 4480ABC - affiliate_metadata: This booking was made with EPS. - conversations: - links: - property: - method: GET - href: https://www.example.com?key=123abd456 - travel_purpose: unspecified - impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing - itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" - room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" confirmation_id: - expedia: "664637628" - property: COR8729347BB + expedia: "1234567890" + property: BEF23123AA bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 checkin: '2018-09-21' - checkout: '2018-09-22' + checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD + loyalty_id: ABC123 rate: id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -12898,40 +12622,43 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + nonrefundable_date_ranges: + - start: '2022-02-02' + end: '2022-02-02' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-12-12T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: - value: "244.70" + value: "368.15" currency: USD exclusive: billable_currency: - value: "234.68" + value: "345.91" currency: USD marketing_fee: billable_currency: - value: "5.14" + value: "7.75" currency: USD property_fees: billable_currency: @@ -12950,12 +12677,58 @@ paths: billable_currency: value: "11.95" currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: modified - event_source: rapid_api - change_reference_id: v1-Givenne - room_id: "926784314" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: -100.0 + type: base_rate + currency: USD + creation_date_time: '2017-08-17T13:31:15.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: business + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + Itinerary with History: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -12964,19 +12737,20 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD rate: id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -12987,28 +12761,31 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -13039,115 +12816,13 @@ paths: billable_currency: value: "11.95" currency: USD - Itinerary with History V2 - Traveler No Show: - value: - itinerary_id: "8999989898988" - property_id: "8150374" - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - email: smith@example.com - phone: - country_code: "1" - area_code: "487" - number: "5550077" - rooms: - - id: "926784314" - confirmation_id: - expedia: "1234567890" - property: BEF23123AA - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-23' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - rate: - id: "035943984" - merchant_of_record: expedia - amenities: - - "12345" - - "678" - - "9999" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - nonrefundable_date_ranges: - - start: '2018-09-14' - end: '2018-09-23' - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" - currency: USD - totals: - inclusive: - billable_currency: - value: "368.15" - currency: USD - exclusive: - billable_currency: - value: "345.91" - currency: USD - marketing_fee: - billable_currency: - value: "7.75" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" - currency: USD - mandatory_tax: - billable_currency: - value: "11.95" - currency: USD - links: - cancel: - method: DELETE - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - change: - method: PUT - href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m billing_contact: given_name: John family_name: Smith @@ -13173,114 +12848,212 @@ paths: href: https://www.example.com?key=123abd456 travel_purpose: unspecified impacted_fields: - - rooms.rate.cancel_refund - - rooms.rate.refundable - - rooms.rate.cancel_penalties - - rooms.links.shop_for_change - - rooms.links.pricing + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing itinerary_history: - - history_id: "802737048" - event_timestamp: '2017-09-17T13:31:15.523Z' - event_type: adjustment - amount: - value: "-32.10" - currency: USD - agent_id: "10203" + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" room_history: - - - history_id: "928364986296" - event_timestamp: '2017-08-15T15:32:55.523Z' - event_type: created - event_source: rapid_api - room_id: "926784314" - confirmation_id: - expedia: "664637628" - property: COR8729347BB - bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 - checkin: '2018-09-21' - checkout: '2018-09-22' - number_of_adults: 2 - child_ages: - - 2 - - 3 - given_name: Givenne - family_name: Nameo - status: booked - special_request: Please give me extra towels. - smoking: false - amount_charged: - billable_currency: - value: "244.70" - currency: USD - rate: - id: "035943984" - promotions: - value_adds: - "123abc": - id: 123abc - description: 10 USD credit on activities and sports - for your stay. - "3x4mp13": - id: 3x4mp13 - description: 20% discount on theme park tickets purchased - through the concierge desk. - deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' - pricing: - nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - stay: - - type: base_rate - value: "123.45" + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" currency: USD - totals: - inclusive: - billable_currency: - value: "244.70" - currency: USD - exclusive: - billable_currency: - value: "234.68" - currency: USD - marketing_fee: - billable_currency: - value: "5.14" - currency: USD - property_fees: - billable_currency: - value: "36.95" - currency: USD - fees: - mandatory_fee: - billable_currency: - value: "5.00" - currency: USD - resort_fee: - billable_currency: - value: "20.00" + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" currency: USD - mandatory_tax: - billable_currency: - value: "11.95" + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: modified + event_source: rapid_api + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" currency: USD - - history_id: "30303030" - event_timestamp: '2017-08-17T13:31:15.523Z' - event_type: canceled_no_show - event_source: supplier - change_reference_id: v1-Givenne - room_id: "926784314" + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + Itinerary with History V2 - Traveler No Show: + value: + itinerary_id: "8999989898988" + property_id: "8150374" + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + email: smith@example.com + phone: + country_code: "1" + area_code: "487" + number: "5550077" + rooms: + - id: "926784314" confirmation_id: expedia: "1234567890" property: BEF23123AA @@ -13289,19 +13062,20 @@ paths: checkout: '2018-09-23' number_of_adults: 2 child_ages: - - 2 - - 3 + - 2 + - 3 given_name: Givenne family_name: Nameo - status: canceled + status: booked special_request: Please give me extra towels. smoking: false - amount_charged: - billable_currency: - value: "123.45" - currency: USD rate: id: "035943984" + merchant_of_record: expedia + amenities: + - "12345" + - "678" + - "9999" promotions: value_adds: "123abc": @@ -13312,28 +13086,31 @@ paths: id: 3x4mp13 description: 20% discount on theme park tickets purchased through the concierge desk. + nonrefundable_date_ranges: + - start: '2018-09-14' + end: '2018-09-23' deposits: - - currency: USD - value: "220.75" - due: '2018-08-24T01:01:01.000-08:00' + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' pricing: nightly: - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD - - - type: base_rate - value: "111.23" - currency: USD - - type: sales_tax - value: "11.12" - currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD stay: - - type: base_rate - value: "123.45" - currency: USD + - type: base_rate + value: "123.45" + currency: USD totals: inclusive: billable_currency: @@ -13364,6 +13141,229 @@ paths: billable_currency: value: "11.95" currency: USD + links: + cancel: + method: DELETE + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + change: + method: PUT + href: /v3/itineraries/8999989898988/rooms/d08572fc-82d2-4d5d-ad30-60f5be7fb53e?token=MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + adjustment: + value: "-32.10" + type: base_rate + currency: USD + creation_date_time: '2017-08-15T15:32:55.523Z' + affiliate_reference_id: 4480ABC + affiliate_metadata: This booking was made with EPS. + conversations: + links: + property: + method: GET + href: https://www.example.com?key=123abd456 + travel_purpose: unspecified + impacted_fields: + - rooms.rate.cancel_refund + - rooms.rate.refundable + - rooms.rate.cancel_penalties + - rooms.links.shop_for_change + - rooms.links.pricing + itinerary_history: + - history_id: "802737048" + event_timestamp: '2017-09-17T13:31:15.523Z' + event_type: adjustment + amount: + value: "-32.10" + currency: USD + agent_id: "10203" + room_history: + - - history_id: "928364986296" + event_timestamp: '2017-08-15T15:32:55.523Z' + event_type: created + event_source: rapid_api + room_id: "926784314" + confirmation_id: + expedia: "664637628" + property: COR8729347BB + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-22' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: booked + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "244.70" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "244.70" + currency: USD + exclusive: + billable_currency: + value: "234.68" + currency: USD + marketing_fee: + billable_currency: + value: "5.14" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD + - history_id: "30303030" + event_timestamp: '2017-08-17T13:31:15.523Z' + event_type: canceled_no_show + event_source: supplier + change_reference_id: v1-Givenne + room_id: "926784314" + confirmation_id: + expedia: "1234567890" + property: BEF23123AA + bed_group_id: d395b56d-d31d-4a84-ad2b-66820b1d48e2 + checkin: '2018-09-21' + checkout: '2018-09-23' + number_of_adults: 2 + child_ages: + - 2 + - 3 + given_name: Givenne + family_name: Nameo + status: canceled + special_request: Please give me extra towels. + smoking: false + amount_charged: + billable_currency: + value: "123.45" + currency: USD + rate: + id: "035943984" + promotions: + value_adds: + "123abc": + id: 123abc + description: 10 USD credit on activities and sports + for your stay. + "3x4mp13": + id: 3x4mp13 + description: 20% discount on theme park tickets purchased + through the concierge desk. + deposits: + - currency: USD + value: "220.75" + due: '2018-08-24T01:01:01.000-08:00' + pricing: + nightly: + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + - - type: base_rate + value: "111.23" + currency: USD + - type: sales_tax + value: "11.12" + currency: USD + stay: + - type: base_rate + value: "123.45" + currency: USD + totals: + inclusive: + billable_currency: + value: "368.15" + currency: USD + exclusive: + billable_currency: + value: "345.91" + currency: USD + marketing_fee: + billable_currency: + value: "7.75" + currency: USD + property_fees: + billable_currency: + value: "36.95" + currency: USD + fees: + mandatory_fee: + billable_currency: + value: "5.00" + currency: USD + resort_fee: + billable_currency: + value: "20.00" + currency: USD + mandatory_tax: + billable_currency: + value: "11.95" + currency: USD "400": description: Bad Request headers: @@ -13414,8 +13414,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -13435,18 +13435,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -13592,88 +13592,88 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] put: tags: - - Bookings + - Bookings summary: Resume Booking description: | This link will be available in the booking response after creating a held booking. operationId: putResumeBooking parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - Returns the HTTP 202 response caused by partial service unavailablity. - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` - Returns the HTTP 202 response caused by partial service unavailablity. + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + required: true + schema: + type: string responses: "202": description: Accepted - Request is valid but the state of the booking is @@ -13810,8 +13810,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -13831,18 +13831,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -13988,90 +13988,90 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] delete: tags: - - Manage Booking + - Manage Booking summary: Cancel Held Booking description: | This link will be available in a held booking response. operationId: deleteHeldBooking parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - post_stay_cancel - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - post_stay_cancel + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + required: true + schema: + type: string responses: "202": description: Accepted - Request is valid but the state of the booking is @@ -14211,8 +14211,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. Room Already Cancelled Example: value: type: room_already_cancelled @@ -14236,18 +14236,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -14393,11 +14393,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/invoice: get: tags: - - Manage Booking + - Manage Booking summary: Booking Receipt description: | A link to the booking receipt will be provided in the retrieve response if partner configuration enabled. This @@ -14405,95 +14405,95 @@ paths: tracking purposes. operationId: getBookingReceipt parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/pdf`. - required: true - schema: - type: string - example: application/pdf - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location - and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: Test - in: header - description: | - The booking receipt call has a test header that can be used to return set responses with the following - keywords: - * `standard` - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This path variable will be provided as part of the link. This specifies which itinerary the booking receipt - request pertains to. - required: true - schema: - type: string - example: 8955599932111 - - name: token - in: query - 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. - required: true - schema: - type: string - example: MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m - - name: branding - in: query - description: | - This parameter specifies which branding should be present on the generated PDF. Default behavior will be to - provide the booking receipt with `expedia_group` branding. Some partner configurations may change the default to unbranded. - schema: - type: string - enum: - - expedia_group - - unbranded - example: unbranded + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/pdf`. + required: true + schema: + type: string + example: application/pdf + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location + and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: Test + in: header + description: | + The booking receipt call has a test header that can be used to return set responses with the following + keywords: + * `standard` + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This path variable will be provided as part of the link. This specifies which itinerary the booking receipt + request pertains to. + required: true + schema: + type: string + example: 8955599932111 + - name: token + in: query + 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. + required: true + schema: + type: string + example: MY5S3j36cOcLfLBZjPYQ1abhfc8CqmjmFVzkk7euvWaunE57LLeDgaxm516m + - name: branding + in: query + description: | + This parameter specifies which branding should be present on the generated PDF. Default behavior will be to + provide the booking receipt with `expedia_group` branding. Some partner configurations may change the default to unbranded. + schema: + type: string + enum: + - expedia_group + - unbranded + example: unbranded responses: "200": description: Invoice provided as body in PDF binary form. @@ -14591,13 +14591,13 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: branding.invalid - message: "Branding not supported. Supported branding values are:\ + - type: branding.invalid + message: "Branding not supported. Supported branding values are:\ \ [expedia_group, unbranded]" - fields: - - name: branding - type: querystring - value: custom_branding + fields: + - name: branding + type: querystring + value: custom_branding "401": description: Unauthorized headers: @@ -14617,18 +14617,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -14774,90 +14774,90 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/payment-sessions: put: tags: - - Bookings + - Bookings summary: Complete Payment Session description: | This link only applies to transactions where EPS takes the customer's payment information. This includes both Expedia Collect and Property Collect transactions.
    This link will be available in the booking response only if you've opted into Two-Factor Authentication to comply with the September 2019 EU Regulations for PSD2. It should be called after Two-Factor Authentication has been completed by the customer in order to finalize the payment and complete the booking or hold attempt. Learn more with our [PSD2 Overview](https://developers.expediagroup.com/docs/rapid/lodging/booking/psd2-regulation) operationId: putCompletePaymentSession parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The payment-sessions call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - * `service_unavailable` - * `internal_server_error` - schema: - type: string - enum: - - standard - - service_unavailable - - internal_server_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The payment-sessions call has a test header that can be used to return set responses with the following keywords:
    + * `standard` + * `service_unavailable` + * `internal_server_error` + schema: + type: string + enum: + - standard + - service_unavailable + - internal_server_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: token + in: query + 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. + required: true + schema: + type: string responses: "200": description: Payment Session Completed @@ -14975,8 +14975,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -14996,18 +14996,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -15153,105 +15153,105 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/rooms/{room_id}: put: tags: - - Manage Booking + - Manage Booking summary: Change details of a room. description: | This link will be available in the retrieve response. Changes in smoking preference and special request will be passed along to the property and are not guaranteed. operationId: changeRoomDetails parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The change call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - Requires valid test booking. - * `service_unavailable` - * `unknown_internal_error` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - 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. - required: true - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The change call has a test header that can be used to return set responses with the following keywords:
    + * `standard` - Requires valid test booking. + * `service_unavailable` + * `unknown_internal_error` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: description: "The request body is required, but only the fields that are being\ \ changed need to be passed in. Fields that are not being changed should\ @@ -15397,8 +15397,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -15418,18 +15418,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -15573,100 +15573,100 @@ paths: $ref: '#/components/schemas/Error' example: type: service_unavailable - message: This service is currently unavailable. - security: - - rapidAuth: [] - delete: - tags: - - Manage Booking - summary: Cancel a room. - description: | - This link will be available in the retrieve response. - operationId: deleteRoom - parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - 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` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - post_stay_cancel - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - 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. - required: true - schema: - type: string + message: This service is currently unavailable. + security: + - rapidAuth: [] + delete: + tags: + - Manage Booking + summary: Cancel a room. + description: | + This link will be available in the retrieve response. + operationId: deleteRoom + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + 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` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - post_stay_cancel + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + 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. + required: true + schema: + type: string responses: "202": description: Accepted - Request is valid but the state of the booking is @@ -15804,8 +15804,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -15825,18 +15825,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -15982,11 +15982,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /itineraries/{itinerary_id}/rooms/{room_id}/pricing: put: tags: - - Manage Booking + - Manage Booking summary: Commit a change of itinerary that may require additional payment or refund. description: "This link will be available in the change response to confirm\ @@ -15995,103 +15995,103 @@ paths: \ is not supported at this time.\n" operationId: commitChange parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: Authorization - in: header - description: "The custom generated authentication header. Refer to our [signature\ + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: Authorization + in: header + description: "The custom generated authentication header. Refer to our [signature\ \ authentication](https://developer.expediapartnersolutions.com/reference/signature-authentication)\ \ page for full details." - required: true - schema: - type: string - - name: Content-Type - in: header - description: | - This parameter is to specify what format the request body is in. The only supported value is application/json. - required: true - schema: - type: string - example: application/json - - name: Customer-Ip - in: header - description: | - IP address of the customer, as captured by your integration.
    - Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    - Also used for fraud recovery and other important analytics. - required: true - schema: - type: string - example: 5.5.5.5 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Test - in: header - description: | - The change call has a test header that can be used to return set responses with the following keywords:
    - * `standard` - Requires valid test booking. - * `service_unavailable` - * `unknown_internal_error` - schema: - type: string - enum: - - standard - - service_unavailable - - unknown_internal_error - - name: itinerary_id - in: path - description: | - This parameter is used only to prefix the token value - no ID value is used.
    - required: true - schema: - type: string - example: "8955599932111" - - name: room_id - in: path - description: | - Room ID of a property.
    - required: true - schema: - type: string - example: 123abc - - name: token - in: query - 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. - required: true - schema: - type: string + required: true + schema: + type: string + - name: Content-Type + in: header + description: | + This parameter is to specify what format the request body is in. The only supported value is application/json. + required: true + schema: + type: string + example: application/json + - name: Customer-Ip + in: header + description: | + IP address of the customer, as captured by your integration.
    + Ensure your integration passes the customer's IP, not your own. This value helps determine their location and assign the correct payment gateway.
    + Also used for fraud recovery and other important analytics. + required: true + schema: + type: string + example: 5.5.5.5 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Test + in: header + description: | + The change call has a test header that can be used to return set responses with the following keywords:
    + * `standard` - Requires valid test booking. + * `service_unavailable` + * `unknown_internal_error` + schema: + type: string + enum: + - standard + - service_unavailable + - unknown_internal_error + - name: itinerary_id + in: path + description: | + This parameter is used only to prefix the token value - no ID value is used.
    + required: true + schema: + type: string + example: "8955599932111" + - name: room_id + in: path + description: | + Room ID of a property.
    + required: true + schema: + type: string + example: 123abc + - name: token + in: query + 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. + required: true + schema: + type: string requestBody: description: | The request body is required if additional payment is necessary. The body can optionally contain the `change_reference_id`. @@ -16236,8 +16236,8 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: link.invalid - message: Link is invalid. + - type: link.invalid + message: Link is invalid. "401": description: Unauthorized headers: @@ -16257,18 +16257,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -16379,12 +16379,12 @@ paths: 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" + - name: payments.amount + type: body + value: "100.00" + - name: price.amount + type: body + value: "120.00" "410": description: Sold Out headers: @@ -16518,95 +16518,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/amenities: get: tags: - - Content + - Content summary: Amenities Reference description: | Returns a complete collection of amenities available in the Rapid API. operationId: getAmenitiesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -16682,15 +16682,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -16710,18 +16710,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -16797,95 +16797,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/categories: get: tags: - - Content + - Content summary: Categories Reference description: | Returns a complete collection of categories available in the Rapid API. operationId: getCategoriesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -16953,15 +16953,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -16981,18 +16981,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17068,11 +17068,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /chains: get: tags: - - Content + - Content summary: Chain Reference ***DEPRECATED*** description: | ***DEPRECATED*** Please use `/references/chains` @@ -17087,69 +17087,69 @@ paths:
    Chain and brand names are provided in English only. operationId: getChainReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17270,18 +17270,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17357,11 +17357,11 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/chains: get: tags: - - Content + - Content summary: Chains Reference description: | Returns a complete collection of chains recognized by the Rapid API. @@ -17375,69 +17375,69 @@ paths:
    Chain and brand names are provided in English only. operationId: getChainsReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17558,18 +17558,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17645,95 +17645,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/general-attributes: get: tags: - - Content + - Content summary: General Attributes Reference - description: | - Returns a complete collection of general attributes available in the Rapid API. - operationId: getGeneralAttributesReference - parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + description: | + Returns a complete collection of general attributes available in the Rapid API. + operationId: getGeneralAttributesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -17805,15 +17805,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -17833,18 +17833,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -17920,95 +17920,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/images: get: tags: - - Content + - Content summary: Images Reference description: | Returns a complete collection of images available in the Rapid API. operationId: getImagesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18076,15 +18076,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18104,18 +18104,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18191,95 +18191,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/onsite-payment-types: get: tags: - - Content + - Content summary: Onsite Payment Types Reference description: | Returns a complete collection of onsite payment types available in the Rapid API. operationId: getOnsitePaymentTypesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18347,15 +18347,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18375,18 +18375,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18462,95 +18462,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/pet-attributes: get: tags: - - Content + - Content summary: Pet Attributes Reference description: | Returns a complete collection of pet attributes available in the Rapid API. operationId: getPetAttributesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18622,15 +18622,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18650,18 +18650,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -18737,95 +18737,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/rate-amenities: get: tags: - - Content + - Content summary: Rate Amenities Reference description: | Returns a complete collection of rate amenities available in the Rapid API. operationId: getRateAmenitiesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -18901,15 +18901,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -18929,18 +18929,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19016,95 +19016,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/room-amenities: get: tags: - - Content + - Content summary: Room Amenities Reference description: | Returns a complete collection of roomo amenities available in the Rapid API. operationId: getRoomAmenitiesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19180,15 +19180,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19208,18 +19208,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19285,105 +19285,105 @@ paths: "503": description: Service Unavailable headers: - Region: - $ref: '#/components/headers/Region' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - example: - type: service_unavailable - message: This service is currently unavailable. - security: - - rapidAuth: [] - /references/room-images: - get: - tags: - - Content - summary: Room Images Reference - description: | - Returns a complete collection of room images available in the Rapid API. - operationId: getRoomImagesReference - parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [] + /references/room-images: + get: + tags: + - Content + summary: Room Images Reference + description: | + Returns a complete collection of room images available in the Rapid API. + operationId: getRoomImagesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19451,15 +19451,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19479,18 +19479,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19566,95 +19566,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/room-views: get: tags: - - Content + - Content summary: Room Views Reference description: | Returns a complete collection of room views available in the Rapid API. operationId: getRoomViewsReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19722,15 +19722,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -19750,18 +19750,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -19837,95 +19837,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/spoken-languages: get: tags: - - Content + - Content summary: Spoken Languages Reference description: | Returns a complete collection of spoken languages available in the Rapid API. operationId: getSpokenLanguagesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -19990,15 +19990,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -20018,18 +20018,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -20105,95 +20105,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/statistics: get: tags: - - Content + - Content summary: Statistics Reference description: | Returns a complete collection of statistics available in the Rapid API. operationId: getStatisticsReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -20265,15 +20265,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -20293,18 +20293,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -20380,95 +20380,95 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /references/themes: get: tags: - - Content + - Content summary: Themes Reference description: | Returns a complete collection of themes available in the Rapid API. operationId: getThemesReference parameters: - - name: Accept - in: header - description: | - Specifies the response format that the client would like to receive back. This must be `application/json`. - required: true - schema: - type: string - example: application/json - - name: Accept-Encoding - in: header - description: | - Specifies the response encoding that the client would like to receive back. This must be `gzip`. - required: true - schema: - type: string - example: gzip - - name: User-Agent - in: header - 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}`. - required: true - schema: - type: string - example: TravelNow/3.30.112 - - name: Customer-Session-Id - in: header - 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. - schema: - type: string - - name: language - in: query - 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. -

    Reference: - * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) - * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) - required: true - schema: - type: string - examples: - English: - value: en-US - Cantonese: - value: zh-HK - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + 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}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + 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. + schema: + type: string + - name: language + in: query + 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 ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

    Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -20536,15 +20536,15 @@ paths: 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,\ + - 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 + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -20564,18 +20564,18 @@ paths: inaccurate. 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 + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 "403": description: Forbidden headers: @@ -20651,52 +20651,52 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [] /notifications: get: tags: - - Notifications + - Notifications summary: Request Undelivered Notifications description: | Use this API to fetch undelivered notifications. Up to 25 notifications are returned with each call. Each undelivered notification will be returned only once. operationId: requestUndeliveredNotifications parameters: - - name: undeliverable - in: query - description: Undeliverable notifications are returned when this parameter - is set to `true`. - required: true - schema: - type: boolean - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: undeliverable + in: query + description: Undeliverable notifications are returned when this parameter + is set to `true`. + required: true + schema: + type: boolean + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string responses: "200": description: OK @@ -20710,59 +20710,59 @@ paths: items: $ref: '#/components/schemas/Notification' example: - - event_id: e02d6f41-4708-476f-915d-8a7032942e94 - event_type: itinerary.agent.change - event_time: '2018-04-28T20:31:03.423Z' - itinerary_id: "1204309424793" - email: alice@example.com - message: An agent changed this itinerary. - affiliate_reference_id: R194193582 - - event_id: fe97op1b-595a-406e-8e0e-90108d5cb4a1 - event_type: itinerary.agent.cancel - event_time: '2018-05-24T04:08:50.839Z' - itinerary_id: "1204329124126" - email: bob@example.com - message: An agent canceled one or more rooms on this itinerary. - affiliate_reference_id: "" + - event_id: e02d6f41-4708-476f-915d-8a7032942e94 + event_type: itinerary.agent.change + event_time: '2018-04-28T20:31:03.423Z' + itinerary_id: "1204309424793" + email: alice@example.com + message: An agent changed this itinerary. + affiliate_reference_id: R194193582 + - event_id: fe97op1b-595a-406e-8e0e-90108d5cb4a1 + event_type: itinerary.agent.cancel + event_time: '2018-05-24T04:08:50.839Z' + itinerary_id: "1204329124126" + email: bob@example.com + message: An agent canceled one or more rooms on this itinerary. + affiliate_reference_id: "" security: - - rapidAuth: [] + - rapidAuth: [] post: tags: - - Notifications + - Notifications summary: Request Test Notification description: | This request triggers a test notification according to the specified event_type. All event types supported by the Notifications API are available to test. operationId: requestTestNotification parameters: - - name: billing_terms - in: query - 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 separately. - schema: - type: string - - name: partner_point_of_sale - in: query - description: | - This parameter is to specify what point of sale is being used to shop and book. If this field is needed, - the value for this will be provided to you separately. - schema: - type: string - - name: payment_terms - in: query - 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 separately. - schema: - type: string - - name: platform_name - in: query - description: | - This parameter is to specify what platform is being used to shop and book. If this field is needed, the - value for this will be provided to you separately. - schema: - type: string + - name: billing_terms + in: query + 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 separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + 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 separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string requestBody: content: application/json: @@ -20790,15 +20790,15 @@ paths: message: "An invalid request was sent in, please check the nested\ \ errors for details." errors: - - type: event_type.not_supported - message: "Event type is not supported. Supported event types are:\ + - type: event_type.not_supported + message: "Event type is not supported. Supported event types are:\ \ [itinerary.agent.create, itinerary.agent.change, itinerary.agent.cancel,\ \ itinerary.supplier.confirm, itinerary.supplier.cancel, itinerary.fraud.cancel]" - fields: - - name: event_type - type: path + fields: + - name: event_type + type: path security: - - rapidAuth: [] + - rapidAuth: [] components: schemas: PropertyContent: @@ -21522,12 +21522,12 @@ components: Children: rule: Children allowed additional_information: - - Children allowed under age 13. - - Multiple children must sleep on cots. + - Children allowed under age 13. + - Multiple children must sleep on cots. Pets: rule: Pets allowed additional_information: - - Pets must be kept on the balcony. + - Pets must be kept on the balcony. amenities: $ref: '#/components/schemas/Amenity' vrbo_srp_id: @@ -21560,20 +21560,20 @@ components: is the unit location. example: "1": - - type: TWIN_SINGLE_BED - description: Twin/Single bed(s) - - quantity: 1 - - type: CHILD_BED - description: Child bed(s) - - quantity: 1 + - type: TWIN_SINGLE_BED + description: Twin/Single bed(s) - + quantity: 1 + - type: CHILD_BED + description: Child bed(s) - + quantity: 1 "2": - - type: QUEEN_BED - description: Queen bed(s) - - quantity: 1 + - type: QUEEN_BED + description: Queen bed(s) - + quantity: 1 Other1: - - type: CHILD_BED - description: Child bed(s) - - quantity: 3 + - type: CHILD_BED + description: Child bed(s) - + quantity: 3 free_text: type: string description: A free text description that could contain significantly unstructured @@ -21621,8 +21621,8 @@ components: type: array description: List of strings detailing further information about the rule. example: - - Children allowed ages 13-17 - - Three children are possible if one is in a cot + - Children allowed ages 13-17 + - Three children are possible if one is in a cot items: type: string UnitConfiguration: @@ -21746,21 +21746,21 @@ components: type: string description: The reason category for this reviewer's trip. enum: - - business - - leisure - - friends_and_family - - business_and_leisure + - business + - leisure + - friends_and_family + - business_and_leisure TravelCompanion: type: string description: The companion category for any travelers that accompanied this reviewer. enum: - - family - - family_with_children - - partner - - self - - friends - - pet + - family + - family_with_children + - partner + - self + - friends + - pet ManagementResponse: type: object properties: @@ -21891,11 +21891,11 @@ components: Polygon: title: Polygon allOf: - - $ref: '#/components/schemas/BoundingPolygon' - - type: object - properties: - coordinates: - $ref: '#/components/schemas/PolygonCoordinates' + - $ref: '#/components/schemas/BoundingPolygon' + - type: object + properties: + coordinates: + $ref: '#/components/schemas/PolygonCoordinates' PolygonCoordinates: type: array description: "An array of linear ring coordinate arrays that combine to make\ @@ -21919,16 +21919,16 @@ components: MultiPolygon: title: MultiPolygon allOf: - - $ref: '#/components/schemas/BoundingPolygon' - - type: object - properties: - coordinates: - type: array - description: "An array of multiple polygon(s) that combine to make a full\ + - $ref: '#/components/schemas/BoundingPolygon' + - type: object + properties: + coordinates: + type: array + description: "An array of multiple polygon(s) that combine to make a full\ \ [MultiPolygon](https://www.rfc-editor.org/rfc/rfc7946#section-3.1.7)\ \ in geojson format." - items: - $ref: '#/components/schemas/PolygonCoordinates' + items: + $ref: '#/components/schemas/PolygonCoordinates' Ancestors: type: object properties: @@ -21941,8 +21941,8 @@ components: description: A region ancestor. PropertiesGeoJsonRequest: required: - - coordinates - - type + - coordinates + - type type: object properties: type: @@ -21954,30 +21954,30 @@ components: example: 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 + - - - -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 PropertyGeography: type: object properties: @@ -21995,8 +21995,8 @@ components: type: string description: Helps determine which type of property response is returned. enum: - - available - - partially_unavailable + - available + - partially_unavailable score: type: number description: A score to sort properties where the higher the value the better. @@ -22009,17 +22009,17 @@ components: partially_unavailable: '#/components/schemas/PropertyUnavailability' PropertyAvailability: allOf: - - $ref: '#/components/schemas/Property' - - type: object - properties: - rooms: - type: array - description: Array of objects containing room information. - items: - $ref: '#/components/schemas/RoomAvailability' - links: - $ref: '#/components/schemas/PropertyAvailabilityLinks' - description: The rooms and rates for a property. + - $ref: '#/components/schemas/Property' + - type: object + properties: + rooms: + type: array + description: Array of objects containing room information. + items: + $ref: '#/components/schemas/RoomAvailability' + links: + $ref: '#/components/schemas/PropertyAvailabilityLinks' + description: The rooms and rates for a property. RoomAvailability: type: object properties: @@ -22058,9 +22058,9 @@ components: description: Indicates the current refundability of the rate. This is a more detailed version of the `refundable` field. enum: - - refundable - - non_refundable - - partially_refundable + - refundable + - non_refundable + - partially_refundable member_deal_available: type: boolean description: Indicates if a "Member Only Deal" is available for this rate. @@ -22133,9 +22133,9 @@ components: price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. enum: - - available - - price_changed - - sold_out + - available + - price_changed + - sold_out SaleScenario: type: object properties: @@ -22274,12 +22274,12 @@ components: href: /v3/properties/12345/availability?token=MY5S3j36cOcL PropertyUnavailability: allOf: - - $ref: '#/components/schemas/Property' - - type: object - properties: - unavailable_reason: - $ref: '#/components/schemas/UnavailableReason' - description: "Response with a property that has no available rates for the\ + - $ref: '#/components/schemas/Property' + - type: object + properties: + unavailable_reason: + $ref: '#/components/schemas/UnavailableReason' + description: "Response with a property that has no available rates for the\ \ given request parameters, but `include=unavailable_reason` was requested." UnavailableReason: type: object @@ -22306,23 +22306,23 @@ components: * `partial_inventory_available` - Some of the dates have no inventory available for the specified duration. `data` will contain the unavailable dates separated by pipe `|`. eg. `2023-10-21|2023-10-23` * `no_inventory_available` - No inventory is available for the specified duration. enum: - - adults_exceed_threshold - - children_exceed_threshold - - infants_exceed_threshold - - minimum_child_age - - maximum_occupancy - - checkin_not_allowed - - checkout_not_allowed - - minimum_stay - - maximum_stay - - restricted_dates - - same_day_restrictions - - maximum_rooms - - children_not_supported - - minimum_advance_purchase - - maximum_advance_purchase - - partial_inventory_available - - no_inventory_available + - adults_exceed_threshold + - children_exceed_threshold + - infants_exceed_threshold + - minimum_child_age + - maximum_occupancy + - checkin_not_allowed + - checkout_not_allowed + - minimum_stay + - maximum_stay + - restricted_dates + - same_day_restrictions + - maximum_rooms + - children_not_supported + - minimum_advance_purchase + - maximum_advance_purchase + - partial_inventory_available + - no_inventory_available data: type: string description: An associated value that provides helpful information for some @@ -22366,9 +22366,9 @@ components: price then price_changed will be returned. If the rate is no longer available at all then sold_out will be returned. enum: - - available - - price_changed - - sold_out + - available + - price_changed + - sold_out RoomPriceCheckLinks: type: object properties: @@ -22513,13 +22513,13 @@ components: example: 14 PaymentSessionsRequest: required: - - browser_accept_header - - customer_account_details - - encoded_browser_metadata - - merchant_url - - payments - - preferred_challenge_window_size - - version + - browser_accept_header + - customer_account_details + - encoded_browser_metadata + - merchant_url + - payments + - preferred_challenge_window_size + - version type: object properties: version: @@ -22542,11 +22542,11 @@ components: * `large`: 500 x 600 * `full_screen`: Full screen enum: - - extra_small - - small - - medium - - large - - full_screen + - extra_small + - small + - medium + - large + - full_screen merchant_url: type: string description: Fully qualified URL of merchant website or customer care site. @@ -22571,23 +22571,23 @@ components: add_card_attempts: 1 account_purchases: 1 payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - enrollment_date: '2018-09-15' + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + enrollment_date: '2018-09-15' PaymentSessionsRequestCustomerAccountDetails: type: object properties: @@ -22595,12 +22595,12 @@ components: type: string description: Mechanism used by the cardholder to authenticate to the merchant. enum: - - guest - - own_credentials - - federated_id - - issuer_credentials - - third_party_authentication - - fido_authentication + - guest + - own_credentials + - federated_id + - issuer_credentials + - third_party_authentication + - fido_authentication authentication_timestamp: type: string description: "Date and time in UTC of the cardholder authentication, in\ @@ -22627,8 +22627,8 @@ components: previous six months. PaymentRequest: required: - - billing_contact - - type + - billing_contact + - type type: object properties: type: @@ -22637,10 +22637,10 @@ components: Identifier for the type of payment. If affiliate_collect, card information is not required as EPS will not be processing the payment. However, billing contact information is still required. enum: - - corporate_card - - customer_card - - virtual_card - - affiliate_collect + - corporate_card + - customer_card + - virtual_card + - affiliate_collect number: type: string description: Card number. Required for credit card transactions. @@ -22669,9 +22669,9 @@ components: $ref: '#/components/schemas/AdditionalHandling' BillingContactRequest: required: - - address - - family_name - - given_name + - address + - family_name + - given_name type: object properties: given_name: @@ -22688,7 +22688,7 @@ components: $ref: '#/components/schemas/BillingContactRequestAddress' BillingContactRequestAddress: required: - - country_code + - country_code type: object properties: line_1: @@ -22730,10 +22730,10 @@ components: \ are allowed." ThirdPartyAuthRequest: required: - - cavv - - ds_transaction_id - - eci - - three_ds_version + - cavv + - ds_transaction_id + - eci + - three_ds_version type: object properties: cavv: @@ -22782,7 +22782,7 @@ components: 2 - Fully authenticated SecureCode transaction AdditionalHandling: required: - - authorized_expenses + - authorized_expenses type: object properties: authorized_expenses: @@ -22801,10 +22801,10 @@ components: * `see_authorization_form` - Indicates that a property should refer to the authorization form that will be sent either by the card provider or the authorizing company. enum: - - prestay_expenses_only - - total_booking_amount - - total_plus_incidentals - - see_authorization_form + - prestay_expenses_only + - total_booking_amount + - total_plus_incidentals + - see_authorization_form specified_incidental_expenses: type: array description: | @@ -22817,16 +22817,16 @@ components: type: string description: The type of incidental expense authorized. enum: - - breakfast - - entertainment - - internet - - meeting_expenses - - other_food_beverage - - parking - - phone - - taxes - - transfer - - other + - breakfast + - entertainment + - internet + - meeting_expenses + - other_food_beverage + - parking + - phone + - taxes + - transfer + - other total_charges_allowed: $ref: '#/components/schemas/Amount' is_cvc_required: @@ -22954,9 +22954,9 @@ components: Value potentially passed in during the availability request to indicate the purpose of the trip designated by the traveler. enum: - - leisure - - business - - unspecified + - leisure + - business + - unspecified supplier_transparency: $ref: '#/components/schemas/SupplierTransparency' additional_handling: @@ -23059,9 +23059,9 @@ components: type: string description: The booking status of the room. enum: - - pending - - booked - - canceled + - pending + - booked + - canceled Loyalty: type: object properties: @@ -23359,8 +23359,8 @@ components: event_type: type: string enum: - - adjustment - - coupon + - adjustment + - coupon amount: $ref: '#/components/schemas/Amount' agent_id: @@ -23386,10 +23386,10 @@ components: \ is `history`. However, it is `canceled_no_show` when the `include` request\ \ parameter is `history_v2`." enum: - - created - - modified - - canceled - - canceled_no_show + - created + - modified + - canceled + - canceled_no_show event_source: type: string description: "The source of the event. If `voyager_agent`, `agent_id` will\ @@ -23397,10 +23397,10 @@ components: \ event_source is `other` when the `include` request parameter is `history`.\ \ However, it is `supplier` when the `include` request parameter is `history_v2`." enum: - - rapid_api - - voyager_agent - - other - - supplier + - rapid_api + - voyager_agent + - other + - supplier change_reference_id: type: string description: Optional identifier provided during changes via Rapid. @@ -23479,9 +23479,9 @@ components: description: The rate information associated with the itinerary. CreateItineraryRequest: required: - - email - - phone - - rooms + - email + - phone + - rooms type: object properties: affiliate_reference_id: @@ -23543,42 +23543,42 @@ components: area_code: "487" number: "5550077" rooms: - - given_name: John - family_name: Smith - smoking: false - special_request: Top floor or away from street please - loyalty_id: ABC123 - loyalty: - member_id: ABD123 - program_id: SN - payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John + - given_name: John family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - enrollment_date: '2018-09-15' - third_party_authentication: - cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= - eci: "05" - three_ds_version: 2.2.0 - ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de - pa_res_status: "Y" - ve_res_status: C - xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 - cavv_algorithm: "3" - ucaf_indicator: "0" + smoking: false + special_request: Top floor or away from street please + loyalty_id: ABC123 + loyalty: + member_id: ABD123 + program_id: SN + payments: + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + enrollment_date: '2018-09-15' + third_party_authentication: + cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= + eci: "05" + three_ds_version: 2.2.0 + ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de + pa_res_status: "Y" + ve_res_status: C + xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 + cavv_algorithm: "3" + ucaf_indicator: "0" affiliate_metadata: data_point_1:123|data_point2:This is data. tax_registration_number: "12345678910" traveler_handling_instructions: Please use the card provided for payment. @@ -23603,8 +23603,8 @@ components: vat_number: "1234567890" PhoneRequest: required: - - country_code - - number + - country_code + - number type: object properties: country_code: @@ -23625,8 +23625,8 @@ components: in this object. The entire phone number should not exceed 25 characters. CreateItineraryRequestRoom: required: - - family_name - - given_name + - family_name + - given_name type: object properties: given_name: @@ -23765,37 +23765,37 @@ components: example: change_reference_id: v1-John payments: - - type: customer_card - number: "4111111111111111" - security_code: "123" - expiration_month: "08" - expiration_year: "2025" - billing_contact: - given_name: John - family_name: Smith - address: - line_1: 555 1st St - line_2: 10th Floor - line_3: Unit 12 - city: Seattle - state_province_code: WA - postal_code: "98121" - country_code: US - third_party_authentication: - cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= - eci: "05" - three_ds_version: 2.2.0 - ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de - pa_res_status: "Y" - ve_res_status: C - xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 - cavv_algorithm: "3" - ucaf_indicator: "0" - enrollment_date: '2018-09-15' + - type: customer_card + number: "4111111111111111" + security_code: "123" + expiration_month: "08" + expiration_year: "2025" + billing_contact: + given_name: John + family_name: Smith + address: + line_1: 555 1st St + line_2: 10th Floor + line_3: Unit 12 + city: Seattle + state_province_code: WA + postal_code: "98121" + country_code: US + third_party_authentication: + cavv: jELUbgG+Tgj0AREBDMLeCad+oIs= + eci: "05" + three_ds_version: 2.2.0 + ds_transaction_id: ac01cc2b-c1a1-4981-8c6f-400d4eec88de + pa_res_status: "Y" + ve_res_status: C + xid: 47133847-13be-4ae3-9be9-e4053b9c83c0 + cavv_algorithm: "3" + ucaf_indicator: "0" + enrollment_date: '2018-09-15' PaymentRequestWithPhone: required: - - billing_contact - - type + - billing_contact + - type type: object properties: type: @@ -23804,10 +23804,10 @@ components: \ cardholder information is not required as EPS will not be processing\ \ the payment." enum: - - corporate_card - - customer_card - - virtual_card - - affiliate_collect + - corporate_card + - customer_card + - virtual_card + - affiliate_collect number: type: string description: Card number. Required for credit card transactions. @@ -23833,9 +23833,9 @@ components: \ account with the merchant, in ISO 8601 format (YYYY-MM-DD)." BillingContactRequestWithPhone: required: - - address - - family_name - - given_name + - address + - family_name + - given_name type: object properties: given_name: @@ -23933,7 +23933,7 @@ components: description: A notification. TestNotificationRequest: required: - - event_type + - event_type type: object properties: event_type: @@ -23982,8 +23982,8 @@ components: * `expedia` - Payment is taken by Expedia. * `property` - Payment is taken by the property. enum: - - expedia - - property + - expedia + - property CancelPenalty: type: object properties: @@ -24072,14 +24072,14 @@ components: "Taxes and Fees" * `traveler_service_fee` - Fee charged by Vrbo to support use of online tools, services and functions on its platform which enable guest self service. May be displayed as 'Traveler Service Fee' or 'Service Fee' any time fees are broken out for display on partner sites. enum: - - base_rate - - tax_and_service_fee - - extra_person_fee - - property_fee - - sales_tax - - adjustment - - recovery_charges_and_fees - - traveler_service_fee + - base_rate + - tax_and_service_fee + - extra_person_fee + - property_fee + - sales_tax + - adjustment + - recovery_charges_and_fees + - traveler_service_fee Stay: type: object properties: @@ -24096,14 +24096,14 @@ components: type: string description: The price breakout type. enum: - - base_rate - - tax_and_service_fee - - extra_person_fee - - property_fee - - sales_tax - - adjustment - - recovery_charges_and_fees - - traveler_service_fee + - base_rate + - tax_and_service_fee + - extra_person_fee + - property_fee + - sales_tax + - adjustment + - recovery_charges_and_fees + - traveler_service_fee Totals: type: object properties: @@ -24206,34 +24206,34 @@ components: type: string description: The general category that this value add promotion falls into. enum: - - food_and_beverage - - entertainment - - service - - activity - - credit + - food_and_beverage + - entertainment + - service + - activity + - credit OfferType: type: string description: The type of offer this value add promotion is. enum: - - buy_one_get_one_free - - credit - - discount - - free - - voucher + - buy_one_get_one_free + - credit + - discount + - free + - voucher Frequency: type: string description: The frequency of when this applies. enum: - - unknown - - per_night - - per_day - - per_stay - - per_week - - round_trip - - one_way + - unknown + - per_night + - per_day + - per_stay + - per_week + - round_trip + - one_way TraderInformation: required: - - terms_and_conditions + - terms_and_conditions type: object properties: traders: From 608279d82096d79ded7ff4b4b34bc3e3166147c8 Mon Sep 17 00:00:00 2001 From: OmarAlJarrah Date: Tue, 22 Apr 2025 14:35:10 +0300 Subject: [PATCH 3/3] chore: mark deprecated fields in specs.yaml --- specs.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specs.yaml b/specs.yaml index 40091cce3e..31fa69f128 100644 --- a/specs.yaml +++ b/specs.yaml @@ -17074,6 +17074,7 @@ paths: tags: - Content summary: Chain Reference ***DEPRECATED*** + deprecated: true description: | ***DEPRECATED*** Please use `/references/chains`
    Returns a complete collection of chains recognized by the Rapid API. @@ -23038,6 +23039,7 @@ components: loyalty_id: type: string description: Deprecated. Please use the loyalty id inside the loyalty object. + deprecated: true loyalty: $ref: '#/components/schemas/Loyalty' rate: @@ -23654,6 +23656,7 @@ components: loyalty_id: type: string description: Deprecated. Please use the loyalty id inside the loyalty object. + deprecated: true loyalty: $ref: '#/components/schemas/Loyalty' ItineraryCreation: @@ -23739,6 +23742,7 @@ components: loyalty_id: type: string description: Deprecated. Please use the loyalty id inside the loyalty object. + deprecated: true loyalty: $ref: '#/components/schemas/Loyalty' example: