object (Query object for request) | |
initialPageSize | integer <int32> (Initial Page Size) The number of results to return, e.g. the amount of results that each page should have. The number is required to be specified and should be less or equal to 50. |
{- "query": {
- "market": "string",
- "locale": "string",
- "currency": "string",
- "entityId": "string",
- "checkinDate": {
- "year": 0,
- "month": 0,
- "day": 0
}, - "checkoutDate": {
- "year": 0,
- "month": 0,
- "day": 0
}, - "adults": 0,
- "childrenAges": [
- 0
], - "rooms": 0,
- "includedAgentsIds": [
- "string"
], - "excludedAgentsIds": [
- "string"
]
}, - "initialPageSize": 0
}
{- "sessionToken": "string",
- "status": "RESULT_STATUS_UNSPECIFIED",
- "content": {
- "totalHotelResultCount": 0,
- "results": {
- "hotelsPricingOptions": {
- "property1": {
- "id": "string",
- "agentId": "string",
- "hotelId": "string",
- "roomName": "string",
- "roomType": "ROOM_TYPE_UNSPECIFIED",
- "cancellationPolicy": "CANCELLATION_POLICY_TYPE_UNSPECIFIED",
- "mealPlan": "MEAL_PLAN_TYPE_UNSPECIFIED",
- "price": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "priceWithoutDiscount": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "deeplink": "string",
- "paymentType": "PAYMENT_TYPE_UNSPECIFIED"
}, - "property2": {
- "id": "string",
- "agentId": "string",
- "hotelId": "string",
- "roomName": "string",
- "roomType": "ROOM_TYPE_UNSPECIFIED",
- "cancellationPolicy": "CANCELLATION_POLICY_TYPE_UNSPECIFIED",
- "mealPlan": "MEAL_PLAN_TYPE_UNSPECIFIED",
- "price": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "priceWithoutDiscount": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "deeplink": "string",
- "paymentType": "PAYMENT_TYPE_UNSPECIFIED"
}
}, - "agents": {
- "property1": {
- "id": "string",
- "logoUrl": "string",
- "agentType": "AGENT_TYPE_UNSPECIFIED",
- "name": "string"
}, - "property2": {
- "id": "string",
- "logoUrl": "string",
- "agentType": "AGENT_TYPE_UNSPECIFIED",
- "name": "string"
}
}, - "hotelInfo": {
- "property1": {
- "hotelId": "string",
- "distanceFromTarget": {
- "value": 0,
- "unit": "DISTANCE_UNIT_UNSPECIFIED"
}, - "deeplink": "string"
}, - "property2": {
- "hotelId": "string",
- "distanceFromTarget": {
- "value": 0,
- "unit": "DISTANCE_UNIT_UNSPECIFIED"
}, - "deeplink": "string"
}
}, - "hotelContent": {
- "property1": {
- "hotelId": "string",
- "hotelName": "string",
- "stars": "STARS_UNSPECIFIED",
- "accommodationType": "ACCOM_TYPE_UNSPECIFIED",
- "chainGroup": {
- "chainId": 0,
- "chainName": "string",
- "groupId": 0,
- "groupName": "string"
}, - "coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "hotelImages": [
- {
- "id": "string",
- "type": "IMAGE_TYPE_UNSPECIFIED",
- "thumbnailUrl": "string",
- "galleryUrl": "string",
- "fullUrl": "string",
- "dynamicUrl": "string"
}
]
}, - "property2": {
- "hotelId": "string",
- "hotelName": "string",
- "stars": "STARS_UNSPECIFIED",
- "accommodationType": "ACCOM_TYPE_UNSPECIFIED",
- "chainGroup": {
- "chainId": 0,
- "chainName": "string",
- "groupId": 0,
- "groupName": "string"
}, - "coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "hotelImages": [
- {
- "id": "string",
- "type": "IMAGE_TYPE_UNSPECIFIED",
- "thumbnailUrl": "string",
- "galleryUrl": "string",
- "fullUrl": "string",
- "dynamicUrl": "string"
}
]
}
}, - "sortOptions": {
- "hotel": {
- "type": "SORT_ORDER_TYPE_UNSPECIFIED",
- "direction": "SORT_ORDER_DIRECTION_UNSPECIFIED",
- "sortItems": [
- {
- "itemId": "string",
- "value": 0.1
}
]
}, - "pricingOption": {
- "type": "SORT_ORDER_TYPE_UNSPECIFIED",
- "direction": "SORT_ORDER_DIRECTION_UNSPECIFIED",
- "sortItems": [
- {
- "itemId": "string",
- "value": 0.1
}
]
}
}
}
}
}
sessionToken required | string Session Token The token is usually provided by the create search response and has to be re-used for all poll calls until complete set of results is provided |
object (Sort) Message to specify sorting type and order | |
object (Pagination Options) A message specifying pagination parameters used across APIs. This message allows clients to request a specific subset of results by defining how many items to skip and how many to return. | |
Array of objects (Filters) Filters to be applied on the query. Any filter added will discard any offers that don't satisfy the specific filter conditions. |
{- "sort": {
- "type": "SORT_ORDER_TYPE_UNSPECIFIED",
- "order": "SORT_ORDER_DIRECTION_UNSPECIFIED"
}, - "pagination": {
- "offset": 0,
- "limit": 0
}, - "filters": [
- {
- "starsFilter": {
- "values": [
- "STARS_UNSPECIFIED"
]
}, - "chainIdFilter": {
- "values": [
- "string"
]
}, - "hotelGroupFilter": {
- "values": [
- "string"
]
}, - "priceRangeFilter": {
- "minValue": 0.1,
- "maxValue": 0.1
}, - "hotelAmenitiesFilter": {
- "values": [
- "HOTEL_AMENITY_UNSPECIFIED"
]
}, - "hotelGuestTypeFilter": {
- "values": [
- "GUEST_TYPE_UNSPECIFIED"
]
}, - "accommodationTypeFilter": {
- "values": [
- "ACCOM_TYPE_UNSPECIFIED"
]
}, - "mealPlanFilter": {
- "values": [
- "MEAL_PLAN_TYPE_UNSPECIFIED"
]
}, - "cancellationTypeFilter": {
- "values": [
- "CANCELLATION_POLICY_TYPE_UNSPECIFIED"
]
}, - "paymentTypeFilter": {
- "values": [
- "PAYMENT_TYPE_UNSPECIFIED"
]
}, - "geoAreaFilter": {
- "coordinates": [
- {
- "latitude": 0.1,
- "longitude": 0.1
}
]
}, - "agentFilter": {
- "values": [
- "string"
]
}
}
]
}
{- "sessionToken": "string",
- "status": "RESULT_STATUS_UNSPECIFIED",
- "content": {
- "totalHotelResultCount": 0,
- "results": {
- "hotelsPricingOptions": {
- "property1": {
- "id": "string",
- "agentId": "string",
- "hotelId": "string",
- "roomName": "string",
- "roomType": "ROOM_TYPE_UNSPECIFIED",
- "cancellationPolicy": "CANCELLATION_POLICY_TYPE_UNSPECIFIED",
- "mealPlan": "MEAL_PLAN_TYPE_UNSPECIFIED",
- "price": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "priceWithoutDiscount": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "deeplink": "string",
- "paymentType": "PAYMENT_TYPE_UNSPECIFIED"
}, - "property2": {
- "id": "string",
- "agentId": "string",
- "hotelId": "string",
- "roomName": "string",
- "roomType": "ROOM_TYPE_UNSPECIFIED",
- "cancellationPolicy": "CANCELLATION_POLICY_TYPE_UNSPECIFIED",
- "mealPlan": "MEAL_PLAN_TYPE_UNSPECIFIED",
- "price": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "priceWithoutDiscount": {
- "currency": "string",
- "price": 0.1,
- "basePrice": 0.1,
- "taxesAndFees": [
- {
- "feeType": "TAX_AND_FEE_TYPE_UNSPECIFIED",
- "value": 0.1,
- "payType": "PAYMENT_TYPE_UNSPECIFIED"
}
]
}, - "deeplink": "string",
- "paymentType": "PAYMENT_TYPE_UNSPECIFIED"
}
}, - "agents": {
- "property1": {
- "id": "string",
- "logoUrl": "string",
- "agentType": "AGENT_TYPE_UNSPECIFIED",
- "name": "string"
}, - "property2": {
- "id": "string",
- "logoUrl": "string",
- "agentType": "AGENT_TYPE_UNSPECIFIED",
- "name": "string"
}
}, - "hotelInfo": {
- "property1": {
- "hotelId": "string",
- "distanceFromTarget": {
- "value": 0,
- "unit": "DISTANCE_UNIT_UNSPECIFIED"
}, - "deeplink": "string"
}, - "property2": {
- "hotelId": "string",
- "distanceFromTarget": {
- "value": 0,
- "unit": "DISTANCE_UNIT_UNSPECIFIED"
}, - "deeplink": "string"
}
}, - "hotelContent": {
- "property1": {
- "hotelId": "string",
- "hotelName": "string",
- "stars": "STARS_UNSPECIFIED",
- "accommodationType": "ACCOM_TYPE_UNSPECIFIED",
- "chainGroup": {
- "chainId": 0,
- "chainName": "string",
- "groupId": 0,
- "groupName": "string"
}, - "coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "hotelImages": [
- {
- "id": "string",
- "type": "IMAGE_TYPE_UNSPECIFIED",
- "thumbnailUrl": "string",
- "galleryUrl": "string",
- "fullUrl": "string",
- "dynamicUrl": "string"
}
]
}, - "property2": {
- "hotelId": "string",
- "hotelName": "string",
- "stars": "STARS_UNSPECIFIED",
- "accommodationType": "ACCOM_TYPE_UNSPECIFIED",
- "chainGroup": {
- "chainId": 0,
- "chainName": "string",
- "groupId": 0,
- "groupName": "string"
}, - "coordinates": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "hotelImages": [
- {
- "id": "string",
- "type": "IMAGE_TYPE_UNSPECIFIED",
- "thumbnailUrl": "string",
- "galleryUrl": "string",
- "fullUrl": "string",
- "dynamicUrl": "string"
}
]
}
}, - "sortOptions": {
- "hotel": {
- "type": "SORT_ORDER_TYPE_UNSPECIFIED",
- "direction": "SORT_ORDER_DIRECTION_UNSPECIFIED",
- "sortItems": [
- {
- "itemId": "string",
- "value": 0.1
}
]
}, - "pricingOption": {
- "type": "SORT_ORDER_TYPE_UNSPECIFIED",
- "direction": "SORT_ORDER_DIRECTION_UNSPECIFIED",
- "sortItems": [
- {
- "itemId": "string",
- "value": 0.1
}
]
}
}
}
}
}