{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e26ff9ee-82ab-40f6-9e48-195c1b2bdad0","name":"iOL X - Demand Integration","description":"This documentation describes the buyer-facing API schema for integrating with iOL X as a buyer.\n\n## Workflow\n\n**Search Hotel** → **Price Check (CheckRates)** → **Book Hotel** → **Cancel / Retrieve / List Bookings**\n\nFor hotel content data (descriptions, images, facilities), use the **Hotel Details** and **Hotel List** endpoints.\n\n---\n\n## 1\\. Authentication\n\nEach buyer client receives their own unique API Key (Code) and Secret (Password). Credentials are **not shared** across clients — every new client onboarded will have new credentials generated and provided via the iOL X portal.\n\nEvery request must include the following HTTP headers:\n\n| Parameter | Required | Description |\n| --- | --- | --- |\n| `Api-key` | Yes | Client API Key (unique per client) |\n| `X-Signature` | Yes | Client Secret (unique per client) |\n\n---\n\n## 2\\. Search Architecture\n\nA single Search call accepts **multiple hotel codes** in the `hotels.hotel[]` array (up to 50 codes per request). All results are returned in a single response, each hotel as a separate object in the `hotels.hotels[]` array.\n\n---\n\n## 3\\. RateKey Flow (Stateless)\n\nThe system is **fully stateless**. No session or token is tracked across calls. All rate information is embedded in the `rateKey` string, which is generated in the Search response and passed forward through the workflow.\n\n| Step | rateKey in Request | Behavior |\n| --- | --- | --- |\n| **Search** | Absent | Returns available rates; each rate carries a `rateKey` |\n| **Price Check** | Present (from Search) | Re-validates rate and price; returns updated `rateKey` |\n| **Book** | Present (from Price Check) | Creates booking using the confirmed `rateKey` |\n\n> **Note:** Price Check is mandatory before booking. \n  \n\n---\n\n## 4\\. RateKey Format\n\nThe `rateKey` is an opaque pipe-delimited string with **9 segments**:\n\n```\nhotelCode|checkIn|checkOut|ratePlanCode|roomCode|mealPlanCode|roomConfigurationId|nationality|rateAmount\n\n ```\n\n---\n\n## 5\\. Multi-Room Handling\n\nBoth scenarios are supported:\n\n- **Same room type**: Pass the same `rateKey` for multiple rooms\n    \n- **Different room types**: Pass multiple room objects, each with its own `rateKey`\n    \n\n---\n\n## 6\\. Booking Reference\n\nThe booking confirmation response returns `booking.reference` — this is the **iOL internal booking ID**.\n\n| Field | Use |\n| --- | --- |\n| `booking.reference` | **Required** for Cancel and Retrieve endpoints (path parameter) |\n| `clientReference` | Your own reference — echoed back, cannot be used to cancel or retrieve |\n\n> Always store `booking.reference` — it is the only identifier accepted by Cancel and Retrieve. \n  \n\n---\n\n## 7\\. Dates\n\nAll dates in request bodies use ISO format `YYYY-MM-DD` (e.g., 7 November 2025 = `2025-11-07`).  \nDates embedded inside a `rateKey` use compact format `yyyyMMdd`.  \nCancellation policy `from` dates use ISO 8601 format (`YYYY-MM-DDTHH:mm:ss+HH:mm`).\n\n---\n\n## 8\\. Meal Plans\n\n| Code | Abbreviation | Description |\n| --- | --- | --- |\n| BB | BB | Bed and Breakfast |\n| HB | HB | Half Board |\n| FB | FB | Full Board |\n| AI | AI | All Inclusive |\n| RO | RO | Room Only |\n\n---\n\n## 9\\. Cancellation Policy Structure\n\nEach cancellation policy entry includes a `from` date and **one** of three mutually exclusive penalty types:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `from` | String | Date-time from which the penalty applies (ISO 8601) |\n| `amount` | Number | Fixed monetary penalty |\n| `numberOfNights` | Integer | Penalty as number of nights |\n| `percent` | Number | Penalty as percentage of total rate |\n\n---\n\n## 10\\. Infants\n\nThere is no separate Infant type. Infants must be included as `CH` (child) with the appropriate age.\n\n---\n\n## 11\\. Source Market / Nationality\n\nMandatory in all searches via the `sourceMarket` field. Use the ISO 2-letter country code for the country where the traveller legally resides.\n\n---\n\n## 12\\. Inventory Types\n\n| Type | rateKey Behavior |\n| --- | --- |\n| Static Rates | Stable across sessions |\n| Dynamic with Cache | Stable across sessions |\n| Runtime (no cache) | Changes per search session |\n\n---\n\n## 13\\. Hotel Mapping\n\niOL X accepts searches by hotel codes only — location-based searches are not supported. GIATA maps against supplier code `iol_iwtx (Cache) and` iol_x3 (runtime). Vervotech also provides a mapping service.\n\n---\n\n## 14\\. Error Responses\n\n| HTTP Status | Code | Cause |\n| --- | --- | --- |\n| `400` | `INVALID_DATA` | Validation failure or missing required field |\n| `401` | `UNAUTHORIZED` | Invalid or missing `Api-key` / `X-Signature` |\n| `404` | `BOOKING_NOT_FOUND` | Booking reference does not exist or belongs to another client |\n| `500` | `SYSTEM_ERROR` | Internal server error |\n\n---\n\n## Contact & Support\n\nX Apisupport: [x.apisupport@iol.world](https://mailto:x.apisupport@iol.world)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"48381311","team":6603910,"collectionId":"e26ff9ee-82ab-40f6-9e48-195c1b2bdad0","publishedId":"2sBXwpMr9r","public":true,"publicUrl":"https://docs-hb.iol-x.com","privateUrl":"https://go.postman.co/documentation/48381311-e26ff9ee-82ab-40f6-9e48-195c1b2bdad0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.3","publishDate":"2026-07-09T20:45:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production","id":"030be9b1-740b-4210-8f7e-93179aabf6f5","owner":"40416318","values":[{"key":"token","value":"","type":"default","enabled":true},{"key":"collectionName","value":"","type":"default","enabled":true},{"key":"collectionSchemaUrl","value":"","type":"default","enabled":true},{"key":"accessKey","value":"","type":"default","enabled":true},{"key":"workspaceId","value":"","type":"default","enabled":true},{"key":"collectionId","value":"","type":"default","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f9be37bf8b30756549aea657fcf416e31ad4d20ad8f6646ecf09728a3819e45f","favicon":"https://iol-x.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"40416318-030be9b1-740b-4210-8f7e-93179aabf6f5"}],"canonicalUrl":"https://docs-hb.iol-x.com/view/metadata/2sBXwpMr9r"}