Metasearch partner interface onto TUI's accommodation portfolio for the Central region (Germany). Two documented operations — GET /hotel_inventory returns the hotels portfolio and POST /hotel_availability checks availability against search criteria. Meta partners must complete onboarding before access is granted; OAuth 2.0 client credentials.
openapi: 3.0.0
info:
title: Meta-Search-Generic API
version: 0.3.1
contact:
email: pip-meta@tui.com
name: meta.search.team
url: https://source.tui/osp/pip/meta-layer/api/meta-search-generic-api
description: The Meta-Search-Generic API that allows meta partners to access portfolio and offers information.
servers:
- url: https://pre-prod.api.tui/sales/pip/germany/tui/generic
- url: https://prod.api.tui/sales/pip/germany/tui/generic
tags:
- name: Hotel Inventory
description: Operations to manage hotel inventory related information
- name: Hotel Availability
description: Operations around hotel availability details
paths:
/hotel_inventory:
get:
tags:
- Hotel Inventory
summary: Retrieves hotels portfolio
description: Returns the list of all the hotels available in the portfolio.
operationId: getHotelInventory
security:
- OAuth2PreProdPublic: []
- OAuth2ProdPublic: []
parameters:
- in: query
name: api_version
required: true
schema:
type: string
example: v1
description: API version to be used
- in: query
name: language
required: true
schema:
type: string
example: en_GB
description: Language to be used by the API
responses:
'200':
description: Successfully retrieved the hotel inventory.
content:
application/json:
schema:
$ref: '#/components/schemas/HotelInventoryResponse'
'400':
description: Bad Request - invalid input parameters or malformed request data.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'404':
description: Not Found - The requested resource could not be found.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal Server Error - An unexpected occurred while processing the request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/hotel_inventory/send/{fileName}:
post:
tags:
- Hotel Inventory
summary: Sends hotels portfolio to SFTP server.
description: Sends hotels portfolio to SFTP server.
operationId: sendHotelInventory
security:
- OAuth2PreProdPublic: []
- OAuth2ProdPublic: []
parameters:
- in: query
name: api_version
required: true
schema:
type: string
example: v1
description: API version to be used
- in: query
name: language
required: true
schema:
type: string
example: en_GB
description: Language to be used by the API
- in: path
name: fileName
required: true
schema:
type: string
example: hotel_inventory.json
description: Name of the file to be sent. The file can have the extensions .json, or .zip
responses:
'202':
description: Successfully sent the hotel inventory to the SFTP server.
'400':
description: Bad Request - invalid input parameters or malformed request data.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'404':
description: Not Found - The requested resource could not be found.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal Server Error - An unexpected occurred while processing the request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
/hotel_availability:
post:
tags:
- Hotel Availability
summary: Checks hotels availability
description: Returns the hotel availability based on the provided criteria.
operationId: getHotelAvailability
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HotelAvailabilityRequest'
security:
- OAuth2PreProdPublic: []
- OAuth2ProdPublic: []
responses:
'200':
description: Successfully updated the existing MetaSearchGeneric with the provided data.
content:
application/json:
schema:
$ref: '#/components/schemas/HotelAvailabilityResponse'
'400':
description: Bad Request - invalid input parameters or malformed request data.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'404':
description: Not Found - The requested resource could not be found.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'500':
description: Internal Server Error - An unexpected occurred while processing the request.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
components:
securitySchemes:
OAuth2PreProdPublic:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://pre-prod.api.tui/oauth2/token
scopes: {}
OAuth2ProdPublic:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://prod.api.tui/oauth2/token
scopes: {}
schemas:
Address:
type: object
title: Address
description: The hotel address details
properties:
street:
type: string
description: The street name.
example: Main Street
city:
type: string
description: The city name.
example: Bad Reichenhall
region:
type: string
description: The region or state if applicable.
example: Bavaria
country:
type: string
description: The country code according to ISO 3166-2.
example: DE
postal_code:
type: string
description: The postal code.
example: '12345'
Hotel:
title: InventoryHotel
type: object
description: The hotel details.
properties:
hotel_id:
type: string
description: The hotel identifier.
example: '76460'
name:
type: string
description: The hotel name.
example: Fancy Hotel
address:
$ref: '#/components/schemas/Address'
latitude:
type: string
format: decimal
description: The latitude coordinate.
example: '48.123456'
longitude:
type: string
format: decimal
description: The longitude coordinate.
example: '48.123456'
phone_number:
type: string
description: The phone number including country code.
example: '+49123456789'
star_rating:
type: string
format: decimal
description: The star rating of the hotel.
example: '4.5'
url:
type: string
description: The generic url for the hotel.
example: https://www.domain.com/fancy-hotel
required:
- hotel_id
- name
- address
- latitude
- longitude
- phone_number
- url
HotelInventoryResponse:
title: HotelInventoryResponse
type: object
description: The successful response payload containing the hotel inventory.
properties:
api_version:
type: string
description: The API current version.
example: v1
language:
type: string
description: The language in the API response.
example: en_GB
hotels:
type: array
items:
$ref: '#/components/schemas/Hotel'
required:
- api_version
- language
- hotels
Problem:
type: object
properties:
type:
type: string
format: uri-reference
description: |
A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-9457, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
default: about:blank
example: /some/uri-reference
title:
type: string
description: |
A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
example: some title for the error situation
status:
type: integer
format: int32
description: |
The HTTP status code generated by the origin server for this occurrence of the problem.
minimum: 100
maximum: 600
exclusiveMaximum: true
detail:
type: string
description: |
A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
example: some description for the error situation
instance:
type: string
format: uri-reference
description: |
A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
example: /some/uri-reference#specific-occurrence-context
Party:
type: object
required:
- adults
properties:
adults:
type: integer
minimum: 1
description: The number of adults.
example: 2
children_ages:
type: array
items:
type: integer
description: The ages of the children.
example:
- 5
- 10
HotelAvailabilityRequest:
type: object
required:
- api_version
- language
- hotel_ids
- check_in_date
- check_out_date
- number_of_rooms
- party
- currency
properties:
api_version:
type: string
description: The API current version.
example: v1
language:
type: string
description: The language in the API response.
example: en_GB
hotel_ids:
type: array
items:
type: string
example: A1954871
description: The list of hotel IDs.
check_in_date:
type: string
format: date
description: The check-in date in the format YYYY-MM-DD.
example: '2023-07-22'
check_out_date:
type: string
format: date
description: The check-out date in the format YYYY-MM-DD.
example: '2023-07-30'
number_of_rooms:
type: integer
description: The number of rooms.
example: 1
party:
type: array
items:
$ref: '#/components/schemas/Party'
currency:
type: string
description: The currency code.
example: EUR
rate_model:
type: string
description: The rate model - AI, GROSS, NET.
example: AI
Room:
type: object
required:
- room_name
- party
- price_per_room
- currency
- breakfast_included
- free_cancellation
- local_tax
- payment_type
- room_code
- rate_type
- meal_code
properties:
room_name:
type: string
description: The room type name.
example: double bedroom
party:
$ref: '#/components/schemas/Party'
price_per_room:
type: string
format: decimal
description: The price of the specific room
example: '105.0'
currency:
type: string
description: The currency code.
example: EUR
breakfast_included:
type: boolean
description: Whether breakfast is included.
example: false
free_cancellation:
type: boolean
description: Whether the room is free cancellation.
example: false
local_tax:
type: string
format: decimal
description: The local tax.
example: '0.0'
payment_type:
type: string
description: The payment type.
example: prepaid
room_code:
type: string
description: The room code.
example: adde03b2-9a69-45c7-85e3-ac63c9b247ca
rate_type:
type: string
description: The rate type.
example: DEFAULT
meal_code:
type: string
description: The meal code.
example: GT06-RO
resort_fee:
type: string
format: decimal
description: The resort fee.
example: '0.0'
Offer:
type: object
properties:
total_price:
type: string
format: decimal
description: The total price of the offer.
example: '105.0'
currency:
type: string
description: The currency code.
example: EUR
rooms:
type: array
items:
$ref: '#/components/schemas/Room'
description: The rooms.
url:
type: string
description: The URL.
example: Deeplink URL
required:
- total_price
- currency
- rooms
- url
Hotels:
type: object
required:
- hotel_id
- cheapest_offer
properties:
hotel_id:
type: string
description: The hotel ID.
example: A1954871
cheapest_offer:
items:
$ref: '#/components/schemas/Offer'
description: The cheapest offer.
HotelAvailabilityResponse:
type: object
required:
- api_version
- language
- currency
- hotel_ids
- check_in_date
- check_out_date
- number_of_rooms
- hotels
properties:
api_version:
type: string
description: The API current version.
example: v1
language:
type: string
description: The language in the API response.
example: en_GB
currency:
type: string
description: The currency code.
example: EUR
hotel_ids:
type: array
items:
type: string
example: A1954871
description: The list of hotel IDs.
check_in_date:
type: string
format: date
description: The check-in date in the format YYYY-MM-DD.
example: '2023-07-22'
check_out_date:
type: string
format: date
description: The check-out date in the format YYYY-MM-DD.
example: '2023-07-30'
number_of_rooms:
type: integer
description: The number of rooms.
example: 1
hotels:
type: array
items:
$ref: '#/components/schemas/Hotels'