TripAdvisor ids that were not able to be mapped to known hotel chain and property codes. Only shows if tripadvisor_ids are included in the request.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Selfbook API","colors":{"primary":"#0D9373","light":"#00D4C8","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/selfbook-48d94d82/4o1J15JpGQHeig9p/logo/Selfbook-Logo-Black.svg?fit=max\u0026auto=format\u0026n=4o1J15JpGQHeig9p\u0026q=85\u0026s=cf8e815f68d046c09d6a143cf4791abf","dark":"https://mintcdn.com/selfbook-48d94d82/4o1J15JpGQHeig9p/logo/Selfbook-Logo-White.svg?fit=max\u0026auto=format\u0026n=4o1J15JpGQHeig9p\u0026q=85\u0026s=99d2bf1a912aec5f347bf9e84e227e14"},"favicon":"https://mintcdn.com/selfbook-48d94d82/4o1J15JpGQHeig9p/favicon.svg?fit=max\u0026auto=format\u0026n=4o1J15JpGQHeig9p\u0026q=85\u0026s=e72fcfc3327cfecbbd5a1c14c51077fd","api":{"openapi":"api-reference/openapi.yaml"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"selfbook-48d94d82","hasAudioNarration":false,"actualSubdomain":"selfbook-48d94d82","customDomains":["docs.selfbook.com"],"gitSource":{"type":"github","owner":"selfbook","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abaac42cc4e50481ed92d25","collectionId":"ab4c7aad-d309-4609-a752-fa7cc051f578","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abaac42cc4e50481ed92d25"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"REMOVE_BRANDING":{"status":"DISABLED"}},"buildId":"6abaac42cc4e50481ed92d25","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"Reservations","count":5},{"language":"default","tag":"API Documentation","count":4},{"language":"default","tag":"Search Use Cases","count":4},{"language":"default","tag":"Booking Use Cases","count":3},{"language":"default","tag":"Hotels","count":2},{"language":"default","tag":"Destinations","count":1},{"language":"default","tag":"Changelog","count":1},{"language":"default","tag":"Get Started","count":1},{"language":"default","tag":"Postman","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"sidebar-group-icon{border:1px solid transparent;border-radius:6px;padding:2px;transition:border-color .15s ease,color .15s ease}sidebar-group-header:hover sidebar-group-icon,sidebar-group:hover sidebar-group-icon{color:#0d9373;border-color:#0d9373}"}],"page":{"pagePath":"api-reference/endpoint/post-hotel-search","slug":"/api-reference/endpoint/post-hotel-search","pageMetadata":{"title":"Hotel Search","openapi":"post /rest/v1/hotel/search","description":"Returns hotel search results\n","href":"/api-reference/endpoint/post-hotel-search"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns hotel search results\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Hotel Search","openapi":"post /rest/v1/hotel/search","description":"Returns hotel search results\n","href":"/api-reference/endpoint/post-hotel-search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Returns hotel search results\n","operationId":"GetAvailability","security":["92b8bd3a-bb0e-430c-8f55-e07197cd07ca"],"requestBody":"91ab0bfe-61b5-4fec-ba44-aec1e1d936b7","responses":{"200":"0d35abab-b53c-4835-9daa-688647bb5f6c","400":"a1560f01-f778-484c-92c5-957d9b86e313","401":"d3d30680-d5ff-4003-b5a9-18f414af9e57","403":"2fc3bd21-a1cc-4a1c-9d88-52e2e0e385ba"},"method":"post","type":"path","servers":["50778eea-7065-405a-bf8d-4753b0e60a35","6e867da0-ab6e-4213-9d00-569531f53446"],"path":"/rest/v1/hotel/search","baseUrlOptions":["https://sandbox.travel.selfbook.com","https://travel.selfbook.com"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stay_info":{"description":"Parameters related to stay duration and guest count","type":"object","properties":{"check_in_date":{"description":"A date in 'YYYY-MM-DD' format","example":"2024-11-20","type":"string","uniqueKey":"stay_info.check_in_date","typeLabel":"string"},"check_out_date":{"description":"A date in 'YYYY-MM-DD' format","example":"2024-11-21","type":"string","uniqueKey":"stay_info.check_out_date","typeLabel":"string"},"guests":{"type":"object","properties":{"adults":{"description":"Number of adults","type":"integer","example":1,"uniqueKey":"stay_info.guests.adults","typeLabel":"integer"},"children":{"description":"Number of children","type":"integer","example":1,"uniqueKey":"stay_info.guests.children","typeLabel":"integer"}},"uniqueKey":"stay_info.guests","typeLabel":"object"}},"uniqueKey":"stay_info","typeLabel":"object"},"filter":{"description":"Parameters related to filtering by location or hotel information","type":"object","properties":{"location":{"description":"Location filtering parameters","type":"object","properties":{"type":{"description":"Location filter type. Either 'iata_code' or 'coordinates'","type":"string","enum":["iata_code","coordinates"],"example":"iata_code","uniqueKey":"filter.location.type","typeLabel":"enum\u003cstring>"},"details":{"description":"Detail parameters related to location filter type","type":"object","properties":{"iata_code":{"description":"City or airport iata code for location based search. Note - only used when location type is set to iata_code.","type":"string","example":"ORD","uniqueKey":"filter.location.details.iata_code","typeLabel":"string"},"latitude":{"description":"Latitude value used for gps point of location based search. Note - only used when location type is set to coordinates.","type":"string","example":40.7580033,"uniqueKey":"filter.location.details.latitude","typeLabel":"string"},"longitude":{"description":"Longitude value used for gps point of location based search. Note - only used when location type is set to coordinates.","type":"string","example":-73.9868562,"uniqueKey":"filter.location.details.longitude","typeLabel":"string"}},"uniqueKey":"filter.location.details","typeLabel":"object"},"radius":{"description":"Search radius parameters","type":"object","properties":{"value":{"description":"Numerical value used for location radius","type":"integer","example":5,"minimum":1,"maximum":35,"uniqueKey":"filter.location.radius.value","typeLabel":"integer"},"type":{"description":"Unit type for distance calculation. Note either mi for miles or km for kilometers.","type":"string","example":"km","uniqueKey":"filter.location.radius.type","typeLabel":"string"}},"uniqueKey":"filter.location.radius","typeLabel":"object"}},"uniqueKey":"filter.location","typeLabel":"object"},"hotel":{"oneOf":[{"type":"object","title":"Single-property search","description":"Search by a specific hotel chain and property code. A name can be included for additional filtering.","properties":{"name":{"description":"Hotel name filter. Can be a partial string. Minimum three characters for filtering to work.","type":"string","example":"Holiday Inn","uniqueKey":"filter.hotel.oneOf.0.name","typeLabel":"string"},"chain_code":{"description":"Hotel chain code","example":"HI","type":"string","uniqueKey":"filter.hotel.oneOf.0.chain_code","typeLabel":"string"},"property_code":{"description":"Hotel property code","example":"E8597","type":"string","uniqueKey":"filter.hotel.oneOf.0.property_code","typeLabel":"string"}},"uniqueKey":"filter.hotel.oneOf.0","typeLabel":"Single-property search · object"},{"type":"array","items":{"type":"object","properties":{"chain_code":{"description":"Hotel chain code","example":"HI","type":"string","uniqueKey":"filter.hotel.oneOf.1.items.[INDEX].chain_code","typeLabel":"string"},"property_code":{"description":"Hotel property code","example":"E8597","type":"string","uniqueKey":"filter.hotel.oneOf.1.items.[INDEX].property_code","typeLabel":"string"}},"uniqueKey":"filter.hotel.oneOf.1.items.[INDEX]","typeLabel":"object"},"title":"Multiple-property search","description":"Provide an array of hotel chain and property codes. Additional filtering unsupported.","uniqueKey":"filter.hotel.oneOf.1","typeLabel":"Multiple-property search · object[]"}],"uniqueKey":"filter.hotel","typeLabel":"Single-property search · object | Multiple-property search · object[]"},"ignore_availability":{"type":"boolean","description":"Return hotel data even if there is no availability. NOTE - no rates will be returned if this is true.","example":false,"uniqueKey":"filter.ignore_availability","typeLabel":"boolean"},"tripadvisor_ids":{"type":"array","items":{"type":"string","description":"A TripAdvisor ID string","uniqueKey":"filter.tripadvisor_ids.items.[INDEX]","typeLabel":"string"},"example":["248749"],"uniqueKey":"filter.tripadvisor_ids","typeLabel":"string[]"},"rates":{"description":"Parameters related to filtering by rate type","type":"object","properties":{"type":{"description":"Restrict results to a single rate type. 'public' returns public rates only; 'private' returns private rates and program (negotiated) rates; 'program' returns program (negotiated) rates only. Omit for no rate-type filtering.","type":"string","enum":["public","private","program"],"example":"private","uniqueKey":"filter.rates.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"filter.rates","typeLabel":"object"}},"uniqueKey":"filter","typeLabel":"object"},"pagination":{"type":"object","properties":{"pagination_token":{"type":"string","description":"Token used to retrieve paginated search results. It's a UUID, so it's unique to each query.","example":"103f701e-39ad-4453-a375-2a9510b4d1c3","uniqueKey":"pagination.pagination_token","typeLabel":"string"},"page_number":{"type":"number","description":"Current page number","example":1,"uniqueKey":"pagination.page_number","typeLabel":"number"}},"uniqueKey":"pagination","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Search for hotels near Chicago O'Hare airport":{"title":"Search for hotels near Chicago O'Hare airport","value":{"stay_info":{"check_in_date":"2024-11-20","check_out_date":"2024-11-21","guests":{"adults":1}},"filter":{"location":{"type":"iata_code","details":{"iata_code":"ORD"},"radius":{"value":5,"type":"mi"}}}}},"Search for hotels near Times Square by lat/long":{"title":"Search for hotels near Times Square by lat/long","value":{"stay_info":{"check_in_date":"2024-11-20","check_out_date":"2024-11-21","guests":{"adults":1}},"filter":{"location":{"type":"coordinates","details":{"latitude":40.7580033,"longitude":-73.9868562},"radius":{"value":5,"type":"mi"}}}}},"Search for Holiday Inn locations near Times Square by lat/long and name":{"title":"Search for Holiday Inn locations near Times Square by lat/long and name","value":{"stay_info":{"check_in_date":"2024-11-20","check_out_date":"2024-11-21","guests":{"adults":1}},"filter":{"location":{"type":"coordinates","details":{"latitude":40.7580033,"longitude":-73.9868562},"radius":{"value":5,"type":"mi"}},"hotel":{"name":"holiday inn"}}}},"Search for Holiday Inn locations in Des Moines by name":{"title":"Search for Holiday Inn locations in Des Moines by name","value":{"stay_info":{"check_in_date":"2024-11-20","check_out_date":"2024-11-21","guests":{"adults":1}},"filter":{"location":{"type":"iata_code","details":{"iata_code":"DSM"},"radius":{"value":5,"type":"mi"}},"hotel":{"name":"holiday inn"}}}},"Look up the Holiday Inn Express Downtown Omaha by hotel code":{"title":"Look up the Holiday Inn Express Downtown Omaha by hotel code","value":{"stay_info":{"check_in_date":"2024-11-20","check_out_date":"2024-11-21","guests":{"adults":1}},"filter":{"hotel":{"chain_code":"HI","property_code":"E8597"}}}},"Search for availability at multiple, specific properties":{"title":"Search for availability at multiple, specific properties","value":{"stay_info":{"check_in_date":"2024-11-20","check_out_date":"2024-11-21","guests":{"adults":1}},"filter":{"hotel":[{"chain_code":"HI","property_code":"E8597"},{"chain_code":"WA","property_code":"51768"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"0d35abab-b53c-4835-9daa-688647bb5f6c":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"page_number":{"type":"number","description":"Current page number","example":1,"uniqueKey":"pagination.page_number","typeLabel":"number"},"page_size":{"type":"number","description":"Number of items per page","example":25,"uniqueKey":"pagination.page_size","typeLabel":"number"},"total_pages":{"type":"number","description":"Total number of pages returned for search query","example":3,"uniqueKey":"pagination.total_pages","typeLabel":"number"},"total_items":{"type":"number","description":"Total number of items available for search query","example":63,"uniqueKey":"pagination.total_items","typeLabel":"number"},"pagination_token":{"type":"string","description":"Token used to retrieve paginated search results. It's a UUID, so it's unique to each query.","example":"103f701e-39ad-4453-a375-2a9510b4d1c3","uniqueKey":"pagination.pagination_token","typeLabel":"string"}},"uniqueKey":"pagination","typeLabel":"object"},"currency_exchange_rates":{"type":"array","items":{"type":"object","properties":{"conversion_factor":{"description":"Conversion rate used to calculate conversion to USD. Conversions should always be treated as estimates.","example":1.1037528,"type":"number","uniqueKey":"currency_exchange_rates.items.[INDEX].conversion_factor","typeLabel":"number"},"source_currency":{"description":"ISO 4217 currency code of source rates. Source rates are those returned in the search results, e.g. the rate in the hotel's local currency.","example":"EUR","type":"string","uniqueKey":"currency_exchange_rates.items.[INDEX].source_currency","typeLabel":"string"},"target_currency":{"description":"ISO 4217 currency code of target rate. Always USD.","example":"USD","type":"string","uniqueKey":"currency_exchange_rates.items.[INDEX].target_currency","typeLabel":"string"}},"uniqueKey":"currency_exchange_rates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"currency_exchange_rates","typeLabel":"object[]"},"results":{"type":"array","items":{"type":"object","properties":{"chain_code":{"description":"Hotel chain code identifier","type":"string","example":"HI","uniqueKey":"results.items.[INDEX].chain_code","typeLabel":"string"},"property_code":{"description":"Hotel property code identifier","type":"string","example":"E8597","uniqueKey":"results.items.[INDEX].property_code","typeLabel":"string"},"name":{"description":"Hotel name","type":"string","example":"HOLIDAY INN EXP STES DTWN OLD MARKE","uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"address":{"description":"Property address object","type":"object","properties":{"street":{"description":"Street address","type":"string","example":"2431 FARNAM STREET","uniqueKey":"results.items.[INDEX].address.street","typeLabel":"string"},"city":{"description":"City","type":"string","example":"OMAHA","uniqueKey":"results.items.[INDEX].address.city","typeLabel":"string"},"state_providence":{"description":"State or Province","type":"string","example":"NE","uniqueKey":"results.items.[INDEX].address.state_providence","typeLabel":"string"},"country_code":{"description":"Country code","type":"string","example":"US","uniqueKey":"results.items.[INDEX].address.country_code","typeLabel":"string"},"postal_code":{"description":"Postal code","type":"string","example":"68131","uniqueKey":"results.items.[INDEX].address.postal_code","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].address","typeLabel":"object"},"geolocation":{"description":"Property geolocation information","type":"object","properties":{"latitude":{"description":"Property latitude value","type":"number","example":41.2573,"uniqueKey":"results.items.[INDEX].geolocation.latitude","typeLabel":"number"},"longitude":{"description":"Property longitude value","type":"number","example":-95.9484,"uniqueKey":"results.items.[INDEX].geolocation.longitude","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].geolocation","typeLabel":"object"},"availability":{"description":"Does the hotel have availability based on the search query?","type":"boolean","example":true,"uniqueKey":"results.items.[INDEX].availability","typeLabel":"boolean"},"email":{"description":"Property email. This may or may not be returned.","type":"string","example":"admin@hoteldomain.com","uniqueKey":"results.items.[INDEX].email","typeLabel":"string"},"phone":{"description":"Property phone number","type":"string","example":"14025093451","uniqueKey":"results.items.[INDEX].phone","typeLabel":"string"},"fax":{"description":"Property fax number","type":"string","example":"14025093461","uniqueKey":"results.items.[INDEX].fax","typeLabel":"string"},"ada_compliant":{"description":"Is this property ADA compliant?","type":"boolean","example":true,"uniqueKey":"results.items.[INDEX].ada_compliant","typeLabel":"boolean"},"check_in_time_local":{"description":"Local check in time (24h format)","type":"string","example":"15:00","uniqueKey":"results.items.[INDEX].check_in_time_local","typeLabel":"string"},"check_out_time_local":{"description":"Local check out time (24h format)","type":"string","example":"11:00","uniqueKey":"results.items.[INDEX].check_out_time_local","typeLabel":"string"},"lowest_rate":{"description":"Lowest available rate based on the search query","type":"object","properties":{"total_price":{"description":"Total price","type":"number","example":122.89,"uniqueKey":"results.items.[INDEX].lowest_rate.total_price","typeLabel":"number"},"base_price":{"description":"Base price","type":"number","example":104,"uniqueKey":"results.items.[INDEX].lowest_rate.base_price","typeLabel":"number"},"total_taxes":{"description":"Total taxes","type":"number","example":18.89,"uniqueKey":"results.items.[INDEX].lowest_rate.total_taxes","typeLabel":"number"},"taxes_and_fees_included":{"description":"Signify whether a `base_price` includes the taxes and fees.","example":false,"type":"boolean","uniqueKey":"results.items.[INDEX].lowest_rate.taxes_and_fees_included","typeLabel":"boolean"},"currency_code":{"description":"Currency code","type":"string","example":"USD","uniqueKey":"results.items.[INDEX].lowest_rate.currency_code","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].lowest_rate","typeLabel":"object"},"rating":{"description":"Hotel rating","type":"object","properties":{"value":{"description":"Hotel rating value","type":"number","example":2,"uniqueKey":"results.items.[INDEX].rating.value","typeLabel":"number"},"provider":{"description":"Hotel rating provider","type":"string","example":"NTM","uniqueKey":"results.items.[INDEX].rating.provider","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].rating","typeLabel":"object"},"michelin_keys_rating":{"description":"Michelin Keys rating value","type":"string","uniqueKey":"results.items.[INDEX].michelin_keys_rating","typeLabel":"string"},"forbes_travel_guide_rating":{"description":"Forbes Travel Guide rating value","type":"string","uniqueKey":"results.items.[INDEX].forbes_travel_guide_rating","typeLabel":"string"},"hotel_network_affiliation":{"description":"Hotel network affiliation value","type":"string","uniqueKey":"results.items.[INDEX].hotel_network_affiliation","typeLabel":"string"},"images":{"description":"Hotel images data","type":"array","items":{"description":"Hotel image item","type":"object","properties":{"url":{"description":"Image URL","type":"string","example":"https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg","uniqueKey":"results.items.[INDEX].images.items.[INDEX].url","typeLabel":"string"},"caption":{"description":"Image caption","type":"string","example":"Hotel Exterior","uniqueKey":"results.items.[INDEX].images.items.[INDEX].caption","typeLabel":"string"},"size":{"description":"Image size. Valid values include: ExtraLarge, Large, Medium, Small","type":"string","example":"ExtraLarge","uniqueKey":"results.items.[INDEX].images.items.[INDEX].size","typeLabel":"string"},"category":{"description":"Image category identifier","type":"number","example":1,"uniqueKey":"results.items.[INDEX].images.items.[INDEX].category","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].images","typeLabel":"object[]"},"amenities":{"description":"Hotel amenities data","type":"array","items":{"description":"Hotel amenity item","type":"object","properties":{"description":{"description":"Amenity description","type":"string","example":"Ice machine","uniqueKey":"results.items.[INDEX].amenities.items.[INDEX].description","typeLabel":"string"},"code":{"description":"Amenity code. See the [Code Reference](/api-reference/code-references#hotel-amenity-codes) for all values and meanings.","type":"number","example":52,"uniqueKey":"results.items.[INDEX].amenities.items.[INDEX].code","typeLabel":"number"},"category":{"description":"Amenity category name","type":"string","example":"Bar / Lounge","uniqueKey":"results.items.[INDEX].amenities.items.[INDEX].category","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].amenities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].amenities","typeLabel":"object[]"},"rooms":{"description":"Hotel rooms data.","type":"array","items":{"description":"Hotel room information.","type":"object","properties":{"room_name":{"description":"Room name without bed information","type":"string","example":"Standard Room Garden Views with Balcony","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_name","typeLabel":"string"},"room_name_with_beds":{"description":"Room name including bed information","type":"string","example":"Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_name_with_beds","typeLabel":"string"},"room_type_ota_code":{"description":"Room type OTA code","type":"number","example":82,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_type_ota_code","typeLabel":"number"},"bed_types":{"description":"Bed types for room","type":"array","items":{"description":"Bed type information","type":"object","properties":{"bed_type":{"description":"Bed type","type":"string","example":"Queen Bed(s)","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].bed_types.items.[INDEX].bed_type","typeLabel":"string"},"quantity":{"description":"Bed type quantity","type":"number","example":2,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].bed_types.items.[INDEX].quantity","typeLabel":"number"},"size":{"description":"Bed size","type":"string","example":"160 cm X 200 cm","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].bed_types.items.[INDEX].size","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].bed_types.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].bed_types","typeLabel":"object[]"},"room_amenities":{"description":"Hotel room amenities","type":"array","items":{"description":"Room amenity information","type":"object","properties":{"description":{"description":"Room amenity description","type":"string","example":"Non-smoking","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_amenities.items.[INDEX].description","typeLabel":"string"},"code":{"description":"Room amenity code. See the [Code Reference](/api-reference/code-references#room-amenity-codes) for all values and meanings.","type":"number","example":74,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_amenities.items.[INDEX].code","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_amenities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_amenities","typeLabel":"object[]"},"max_occupancy":{"description":"Maximum room occupancy","type":"number","example":5,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].max_occupancy","typeLabel":"number"},"room_characteristics":{"description":"Hotel room characteristics","type":"object","properties":{"category":{"description":"Hotel room category characteristic","type":"object","properties":{"description":{"description":"Category description","type":"string","example":"Room","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.category.description","typeLabel":"string"},"code":{"description":"Category code. See the [Code Reference](/api-reference/code-references#room-category-codes) for all values and meanings.","type":"number","example":42,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.category.code","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.category","typeLabel":"object"},"class":{"description":"Hotel room class characteristic","type":"object","properties":{"description":{"description":"Class description","type":"string","example":"Standard","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.class.description","typeLabel":"string"},"code":{"description":"Class code. See the [Code Reference](/api-reference/code-references#room-class-codes) for all values and meanings.","type":"number","example":82,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.class.code","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.class","typeLabel":"object"},"view":{"description":"Hotel room view characteristic","type":"object","properties":{"description":{"description":"View description","type":"string","example":"City views","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.view.description","typeLabel":"string"},"code":{"description":"View code. See the [Code Reference](/api-reference/code-references#room-view-codes) for all values and meanings.","type":"number","example":3,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.view.code","typeLabel":"number"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.view","typeLabel":"object"},"other_features":{"description":"Hotel room other features characteristic","type":"array","items":{"description":"Other features items","type":"string","example":"Walk In Shower","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.other_features.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics.other_features","typeLabel":"string[]"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_characteristics","typeLabel":"object"},"room_images":{"description":"Hotel room images data","type":"array","items":{"description":"Hotel room image item","type":"object","properties":{"url":{"description":"Image URL","type":"string","example":"https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].url","typeLabel":"string"},"caption":{"oneOf":[{"description":"Image caption. Can be null if no caption is available.","type":"string","example":"Hotel Exterior","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].caption.oneOf.0","typeLabel":"string"},{"description":"Image caption. Can be null if no caption is available.","type":"null","example":"Hotel Exterior","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].caption.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].caption","typeLabel":"string | null"},"size":{"description":"Image size. Valid values include: ExtraLarge, Large, Medium, Small","type":"string","example":"ExtraLarge","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].size","typeLabel":"string"},"category":{"oneOf":[{"description":"Image category. Can be null if no category is available.","type":"string","example":"Room","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"description":"Image category. Can be null if no category is available.","type":"null","example":"Room","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX].category","typeLabel":"string | null"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].room_images","typeLabel":"object[]"},"rates":{"description":"Hotel room rate data","type":"array","items":{"description":"Room rate information. You should pass this entire object to Selfbook to create a reservation.","type":"object","properties":{"booking_code":{"description":"Booking code for room rate","type":"string","example":"2QN57JU","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].booking_code","typeLabel":"string"},"channel_code":{"description":"Channel code for room rate","type":"string","example":"SBT1","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].channel_code","typeLabel":"string"},"rate_type":{"description":"Rate type identifier. Currently can be flexible_rate, lowest_rate, or private_access_rate","type":"string","example":"flexible_rate","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].rate_type","typeLabel":"string"},"pcc":{"description":"Internal rate identifier","type":"string","example":"KR5","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].pcc","typeLabel":"string"},"rate_name":{"description":"Rate name. Currently can be Flexible Rate, Lowest Rate, or Private Access Rate","type":"string","example":"Flexible Rate","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].rate_name","typeLabel":"string"},"room_name":{"description":"Room name without bed information","type":"string","example":"Standard Room Garden Views with Balcony","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].room_name","typeLabel":"string"},"room_name_with_beds":{"description":"Room name including bed information","type":"string","example":"Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].room_name_with_beds","typeLabel":"string"},"price":{"description":"Price information for room rate","type":"object","properties":{"total_price":{"description":"Total price","type":"number","example":164.24,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.total_price","typeLabel":"number"},"base_price":{"description":"Base price","type":"number","example":139,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.base_price","typeLabel":"number"},"total_taxes":{"description":"Total taxes","type":"number","example":25.24,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.total_taxes","typeLabel":"number"},"additional_fees":{"description":"Additional fees","type":"number","example":0,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.additional_fees","typeLabel":"number"},"taxes_and_fees_included":{"description":"Signify whether a `base_price` includes the taxes and fees.","example":false,"type":"boolean","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.taxes_and_fees_included","typeLabel":"boolean"},"currency_code":{"description":"Currency code","type":"string","example":"USD","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.currency_code","typeLabel":"string"},"nightly_breakdown":{"description":"Array of the rate's nightly breakdowns","type":"array","items":{"type":"object","properties":{"date":{"description":"The date the nightly breakdown applies to","type":"string","example":"2024-09-12","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.nightly_breakdown.items.[INDEX].date","typeLabel":"string"},"total_price":{"description":"The total for the night.","type":"string","example":1501.25,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.nightly_breakdown.items.[INDEX].total_price","typeLabel":"string"},"currency_code":{"description":"Currency code","type":"string","example":"USD","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.nightly_breakdown.items.[INDEX].currency_code","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.nightly_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price.nightly_breakdown","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].price","typeLabel":"object"},"terms":{"description":"Rate and payment terms","type":"object","properties":{"rate_payment_info":{"description":"Type of rate payment (usually PrePay or PostPay)","type":"string","example":"PrePay","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.rate_payment_info","typeLabel":"string"},"guarantee_type":{"description":"Type of guarantee required","example":"DepositRequired","type":"string","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.guarantee_type","typeLabel":"string"},"refundable":{"description":"Is the rate refundable?","type":"boolean","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.refundable","typeLabel":"boolean"},"cancel_note":{"description":"Note left if cancel penalties are unavailable","type":"string","example":"","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_note","typeLabel":"string"},"cancel_penalties":{"description":"Penalties for cancellation","type":"array","items":{"type":"object","properties":{"deadline_local":{"description":"Local date time deadline for when the cancellation fee will be enforced","type":"string","example":"2024-09-17T00:00:00-05:00","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].deadline_local","typeLabel":"string"},"cancel_short_description":{"description":"Short description of the cancellation policy and penalties","type":"string","example":"An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago].","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].cancel_short_description","typeLabel":"string"},"penalty":{"description":"Object describing the penalty amount.","type":"object","properties":{"estimated_amount":{"description":"Is the penalty amount estimated?","type":"boolean","example":true,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].penalty.estimated_amount","typeLabel":"boolean"},"currency_amount":{"description":"Amount of currency for the penalty","type":"object","properties":{"amount":{"description":"Amount","type":"number","example":177.44,"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].penalty.currency_amount.amount","typeLabel":"number"},"currency":{"description":"Currency code","type":"string","example":"USD","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].penalty.currency_amount.currency","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].penalty.currency_amount","typeLabel":"object"},"original_penalty_info":{"description":"Original penalty information","type":"string","example":"100%","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].penalty.original_penalty_info","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX].penalty","typeLabel":"object"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms.cancel_penalties","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].terms","typeLabel":"object"},"included_perks":{"description":"Included perks for room rate","type":"object","additionalProperties":{"type":"string","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].included_perks.additionalProperties","typeLabel":"string"},"example":{"Complimentary Wi-Fi":"Complimentary Wi-Fi","Complimentary breakfast":"Daily breakfast included"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].included_perks","typeLabel":"object"},"expiration":{"description":"ISO 8601.","type":"string","example":"2024-05-20T00:00:00Z","uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX].expiration","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX].rates","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX].rooms.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.items.[INDEX].rooms","typeLabel":"object[]"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results","typeLabel":"object[]"},"missing_tripadvisor_ids":{"type":"array","items":{"type":"string","description":"TripAdvisor ids that were not able to be mapped to known hotel chain and property codes. Only shows if tripadvisor_ids are included in the request.","example":"555doesnotexist","uniqueKey":"missing_tripadvisor_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"missing_tripadvisor_ids","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"pagination":{"page_number":1,"page_size":25,"total_pages":3,"total_items":63,"pagination_token":"103f701e-39ad-4453-a375-2a9510b4d1c3"},"currency_exchange_rates":[{"conversion_factor":1.1037528,"source_currency":"EUR","target_currency":"USD"}],"results":[{"chain_code":"HI","property_code":"E8597","name":"HOLIDAY INN EXP STES DTWN OLD MARKE","address":{"street":"2431 FARNAM STREET","city":"OMAHA","state_providence":"NE","country_code":"US","postal_code":"68131"},"geolocation":{"latitude":41.2573,"longitude":-95.9484},"availability":true,"email":"admin@hoteldomain.com","phone":"14025093451","fax":"14025093461","ada_compliant":true,"check_in_time_local":"15:00","check_out_time_local":"11:00","lowest_rate":{"total_price":122.89,"base_price":104,"total_taxes":18.89,"taxes_and_fees_included":false,"currency_code":"USD"},"rating":{"value":2,"provider":"NTM"},"michelin_keys_rating":"\u003cstring>","forbes_travel_guide_rating":"\u003cstring>","hotel_network_affiliation":"\u003cstring>","images":[{"url":"https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg","caption":"Hotel Exterior","size":"ExtraLarge","category":1}],"amenities":[{"description":"Ice machine","code":52,"category":"Bar / Lounge"}],"rooms":[{"room_name":"Standard Room Garden Views with Balcony","room_name_with_beds":"Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds","room_type_ota_code":82,"bed_types":[{"bed_type":"Queen Bed(s)","quantity":2,"size":"160 cm X 200 cm"}],"room_amenities":[{"description":"Non-smoking","code":74}],"max_occupancy":5,"room_characteristics":{"category":{"description":"Room","code":42},"class":{"description":"Standard","code":82},"view":{"description":"City views","code":3},"other_features":["Walk In Shower"]},"room_images":[{"url":"https://travelport.leonardocontentcloud.com/imageRepo/7/0/127/847/591/OMAOM_6502858112_E.jpg","caption":"Hotel Exterior","size":"ExtraLarge","category":"Room"}],"rates":[{"booking_code":"2QN57JU","channel_code":"SBT1","rate_type":"flexible_rate","pcc":"KR5","rate_name":"Flexible Rate","room_name":"Standard Room Garden Views with Balcony","room_name_with_beds":"Standard Room Garden Views with Balcony, One Double Bed, Two Single Beds","price":{"total_price":164.24,"base_price":139,"total_taxes":25.24,"additional_fees":0,"taxes_and_fees_included":false,"currency_code":"USD","nightly_breakdown":[{"date":"2024-09-12","total_price":1501.25,"currency_code":"USD"}]},"terms":{"rate_payment_info":"PrePay","guarantee_type":"DepositRequired","refundable":true,"cancel_note":"","cancel_penalties":[{"deadline_local":"2024-09-17T00:00:00-05:00","cancel_short_description":"An estimated cancellation fee of 177.44 USD applies starting from 2024-09-17T00:00-05:00[America/Chicago].","penalty":{"estimated_amount":true,"currency_amount":{"amount":177.44,"currency":"USD"},"original_penalty_info":"100%"}}]},"included_perks":{"Complimentary Wi-Fi":"Complimentary Wi-Fi","Complimentary breakfast":"Daily breakfast included"},"expiration":"2024-05-20T00:00:00Z"}]}]}],"missing_tripadvisor_ids":["555doesnotexist"]}}},"exampleType":"generated"}},"exampleType":"generated"},"a1560f01-f778-484c-92c5-957d9b86e313":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Numeric error code.","example":2001,"uniqueKey":"code","typeLabel":"integer"},"details":{"type":"array","description":"One or more additional details about error condtion.","items":{"type":"object","properties":{"message":{"description":"A more detailed error message.","type":"string","example":"check_out_date is missing","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"field":{"description":"Included for validation errors. Indicating the path to the problem field.","type":"array","items":{"type":"string","example":"check_out_date","uniqueKey":"details.items.[INDEX].field.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.items.[INDEX].field","typeLabel":"string[]"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"message":{"type":"string","description":"A summary of the error.","example":"Unable to process your request. Missing or invalid request parameters.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","enum":["APPLICATION_ERROR","BOOKING_CANCELLATION_ERROR","BOOKING_CREATION_ERROR","BOOKING_ERROR","PAYMENT_PROCESSING_ERROR","VALIDATION"],"example":"VALIDATION","uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":2001,"details":[{"message":"check_out_date is missing","field":["check_out_date"]}],"message":"Unable to process your request. Missing or invalid request parameters.","type":"VALIDATION"}}},"exampleType":"generated"}},"exampleType":"generated"},"d3d30680-d5ff-4003-b5a9-18f414af9e57":{"description":"Unauthorized\nthe API key token is missing, invalid, or expired\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2fc3bd21-a1cc-4a1c-9d88-52e2e0e385ba":{"description":"Forbidden\nthe API key token cannot access the specified resource\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"92b8bd3a-bb0e-430c-8f55-e07197cd07ca":{"BasicAuthentication":{"type":"http","description":"Basic authentication where:\n - user-id is a partner account ID\n - user-password is an API key token associated with the partner account\n","scheme":"basic","scopes":[]}}},"servers":{"50778eea-7065-405a-bf8d-4753b0e60a35":{"url":"https://sandbox.travel.selfbook.com","description":"Sandbox server"},"6e867da0-ab6e-4213-9d00-569531f53446":{"url":"https://travel.selfbook.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Basic authentication where:\n - user-id is a partner account ID\n - user-password is an API key token associated with the partner account\n","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication where:\n - user-id is a partner account ID\n - user-password is an API key token associated with the partner account\n","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuthentication","name":"Authorization"}],"title":"BasicAuthentication"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"selfbook-48d94d82","siteName":"Selfbook API","title":"Hotel Search - Selfbook API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-07T03:06:51.323Z","originalFileLocation":"api-reference/endpoint/post-hotel-search.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns hotel search results\">\u003cmeta data-mint-head name=\"application-name\" content=\"Selfbook API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Hotel Search - Selfbook API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns hotel search results\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Selfbook API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://selfbook-48d94d82.mintlify.app/_mintlify/api/og/v2?division=Hotels\u0026amp;title=Hotel+Search\u0026amp;description=Returns+hotel+search+results%0A\u0026amp;theme=e829b42cf3ab651ca4d7d321\u0026amp;signature=4ada8ea2951e6dd383338823e656a8791c8b14e5fd15368197025291d239256d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Hotel Search - Selfbook API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns hotel search results\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://selfbook-48d94d82.mintlify.app/_mintlify/api/og/v2?division=Hotels\u0026amp;title=Hotel+Search\u0026amp;description=Returns+hotel+search+results%0A\u0026amp;theme=e829b42cf3ab651ca4d7d321\u0026amp;signature=4ada8ea2951e6dd383338823e656a8791c8b14e5fd15368197025291d239256d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/selfbook-48d94d82/41JX03fsc0c2k_-z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Selfbook API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/post-hotel-search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.selfbook.com/#organization\",\"name\":\"Selfbook API\",\"url\":\"https://docs.selfbook.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/selfbook-48d94d82/4o1J15JpGQHeig9p/logo/Selfbook-Logo-Black.svg?fit=max\u0026auto=format\u0026n=4o1J15JpGQHeig9p\u0026q=85\u0026s=cf8e815f68d046c09d6a143cf4791abf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.selfbook.com#website\",\"name\":\"Selfbook API\",\"url\":\"https://docs.selfbook.com\",\"publisher\":{\"@id\":\"https://docs.selfbook.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search#webpage\",\"url\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search\",\"name\":\"Hotel Search\",\"description\":\"Returns hotel search results\",\"dateModified\":\"2025-08-07T03:06:51.323Z\",\"isPartOf\":{\"@id\":\"https://docs.selfbook.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.selfbook.com/api-reference/endpoint/get-destinations-search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Hotel Search\",\"item\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search#apireference\",\"headline\":\"Hotel Search\",\"name\":\"Hotel Search\",\"description\":\"Returns hotel search results\",\"url\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.selfbook.com/api-reference/endpoint/post-hotel-search#webpage\"},\"dateModified\":\"2025-08-07T03:06:51.323Z\",\"publisher\":{\"@id\":\"https://docs.selfbook.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.selfbook.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Selfbook API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Selfbook API","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":null,"href":"/introduction"}]},{"group":"Search Use Cases","pages":[{"title":"Search by Property code","href":"/search_ids"},{"title":"Search by Multiple Property codes","href":"/search_multiple_ids"},{"title":"Search by Geo Coordinates","href":"/search_geo"},{"title":"Search by Airport code","href":"/search_airport"}]},{"group":"Booking Use Cases","pages":[{"title":"Create a Reservation","href":"/create_reservation"},{"title":"Find a Reservation","href":"/find_reservation"},{"title":"Cancel a Reservation","href":"/cancel_reservation"}]},{"group":"Reservation Modification Use Cases","pages":[{"title":"Modifications Overview","href":"/reservation_modification_use_cases"}]},{"group":"API Documentation","pages":[{"title":"Getting Started","href":"/api-reference/introduction"},{"title":"Errors","href":"/api-reference/error"},{"title":"Response Time","href":"/api-reference/response"},{"title":"Code References","href":"/api-reference/code-references"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","href":"/webhooks"}]},{"group":"API Reference","pages":[{"group":"Destinations","expanded":true,"pages":[{"title":"Destinations Search","openapi":"get /rest/v1/destinations/search","description":"Returns a list of geographic destinations and/or specific hotel properties based on a search query.\nObjects in the `results` array may be a Destination (geographic area) or a Hotel (specific property),\ndistinguished by their `type` field.\n","href":"/api-reference/endpoint/get-destinations-search"}]},{"group":"Hotels","expanded":true,"pages":[{"title":"Hotel Search","openapi":"post /rest/v1/hotel/search","href":"/api-reference/endpoint/post-hotel-search"},{"title":"Rate Verification","openapi":"post /rest/v1/hotel/rate_verification","description":"Returns pricing and complete terms for a rate.","href":"/api-reference/endpoint/post-hotel-rate-verification"}]},{"group":"Reservations","expanded":true,"pages":[{"title":"Create Reservation","openapi":"post /rest/v1/reservation","href":"/api-reference/endpoint/post-create-reservation"},{"title":"Get Reservation","openapi":"get /rest/v1/reservation/{reservation_id}","href":"/api-reference/endpoint/get-hotel-reservation"},{"title":"List Reservations","openapi":"get /rest/v1/reservations","href":"/api-reference/endpoint/get-list-reservations"},{"title":"Modify Reservation","openapi":"patch /rest/v1/reservation/{reservation_id}","href":"/api-reference/endpoint/patch-modify-reservation"},{"title":"Cancel Reservation","openapi":"post /rest/v1/reservation/{reservation_id}/cancel","href":"/api-reference/endpoint/post-cancel-reservation"}]}]},{"group":"Postman","icon":"download","pages":[{"title":"Postman Collection","href":"/postman"}]},{"group":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Hotel Search - Selfbook API","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}