{"info":{"_postman_id":"9389c14f-57fc-4879-9843-d8d0f86443af","name":"RoomBoss API Documentation","description":"<html><head></head><body><h5 id=\"doc-version-11\"><strong>DOC VERSION 1.1</strong></h5>\n<h1 id=\"api-endpoints\"><strong>API Endpoints</strong></h1>\n<ul>\n<li><p><a href=\"#ab1b936b-b8c8-4dbf-bf24-cd1d93f890c3\">GS Purchasing API</a></p>\n</li>\n<li><p><a href=\"#f1cb98aa-ce71-47e6-9cb0-6ed48e39a588\">Hotel API</a></p>\n</li>\n<li><p><a href=\"#8b5eec04-6c82-4cd1-9987-d4eeb862d8c7\">OTA Rates &amp; Availability API</a></p>\n</li>\n</ul>\n<hr>\n<p>Private and Confidential. © RoomBoss Co. Ltd. 2025, All Rights Reserved.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Endpoints","slug":"api-endpoints"}],"owner":"39999798","collectionId":"9389c14f-57fc-4879-9843-d8d0f86443af","publishedId":"2sAYkEqKQ3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1B75BC"},"publishDate":"2025-03-25T10:50:04.000Z"},"item":[{"name":"GS Purchasing API","item":[{"name":"Vendors","item":[{"name":"List Vendors","id":"636c4f15-5808-4b52-807d-709c6cf8d7c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/gs/v1/vendors/list","description":"<p>This method allows you to query receive a list of vendors and their details, such as ID, name, media URLs, and other booking-related settings, located in the specified area.\n\nVendor IDs are required for multiple operations, including listing categories and products, querying pricing and guest field settings, and for creating packages.\n</p>\n<h3 id=\"pagelistvendorsheadercountrylocationcodes\">Country & Location Codes</h3>\n<p>When listing vendors, query by area location to include results from all sublocations associated with it. To limit vendors to a specific zone, instead query by sublocation.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Country Code</th>\n<th>Location Code  <br />(Area)</th>\n<th>Location Code  <br />(Sublocations)</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>JP (Japan)</td>\n<td>NISEKO</td>\n<td>NISEKO_HIRAFU  <br />NISEKO_ANNUPURI  <br />NISEKO_HIGASHIYAMA  <br />NISEKO_HANAZONO  <br />NISEKO_VILLAGE  <br />NISEKO_MOIWA</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KUTCHAN_TOWN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>FURANO</td>\n<td>FURANO_MOUNTAIN  <br />FURANO_TOWN</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>TOKYO</td>\n<td>TOKYO_CITY  <br />TOKYO_NARITA</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>SAPPORO</td>\n<td>SAPPORO_CHITOSE  <br />SAPPORO_CITY</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>ASAHIDAKE</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>HAKUBA</td>\n<td>HAKUBA_47  <br />HAKUBA_CORTINA  <br />HAKUBA_GORYU  <br />HAKUBA_HAPPOONE  <br />HAKUBA_HIGHLAND  <br />HAKUBA_IWATAKE  <br />HAKUBA_MINEKATA  <br />HAKUBA_NORIKURAONSEN  <br />HAKUBA_MISORANO  <br />HAKUBA_ECHOLAND</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KAGURA</td>\n<td>KAGURA_KAGURA  <br />KAGURA_MITSUMATA  <br />KAGURA_TASHIRO</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>RUSUTSU</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>TOMAMU</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>NAEBA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MYOKO</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KIRORO</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MADARAOKOGEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KYOTO</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>APPIKOGEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>HAKKODA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>SHIGAKOGEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>NOZAWAONSEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>ZAOONSEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>CHISENUPURI</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MOIWA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>LAKETOYA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>OKAYAMA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>FUJI_AREA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>GUNMA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>YATSUGATAKE</td>\n<td>SHIRAKABA_KOGEN  <br />IKENOTAIRA  <br />BLANCHE_TAKAYAMA  <br />KURUMAYAMA_KOGEN  <br />SHIRAKABAKO</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MAKKARI</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>QUEENSTOWN</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>METHVEN</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>CARDRONA</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>WANAKA</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>ARROWTOWN</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>FRANKTON</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>TEKAPO</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>FAIRLIE</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>OHAU</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>TWIZEL</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>CANTERBURYHIGHLANDS</td>\n<td>CANTERBURYHIGHLANDS_CASTLEHILL  <br />CANTERBURYHIGHLANDS_CRAIGIEBURN  <br />CANTERBURYHIGHLANDS_SPRINGFIELD  <br />CANTERBURYHIGHLANDS_HANMERSPRINGS</td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>PORTILLO</td>\n<td></td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>TERMASDECHILLAN</td>\n<td></td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>TRESVALLE</td>\n<td>TRESVALLE_VALLENEVADO  <br />TRESVALLE_ELCOLORADO  <br />TRESVALLE_LAPARVA  <br />TRESVALLE_FARELLONES</td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>SANTIAGO</td>\n<td></td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>LOSANDES</td>\n<td></td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>WHISTLER</td>\n<td></td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>KICKINGHORSE</td>\n<td>KICKINGHORSE_ONMOUNTAIN  <br />KICKINGHORSE_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>REVELSTOKE</td>\n<td>REVELSTOKE_ONMOUNTAIN  <br />REVELSTOKE_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>REDMOUNTAIN</td>\n<td>REDMOUNTAIN_ONMOUNTAIN  <br />REDMOUNTAIN_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>NELSON</td>\n<td>NELSON_ONMOUNTAIN  <br />NELSON_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>BIGWHITE</td>\n<td></td>\n</tr>\n<tr>\n<td>ID (Indonesia)</td>\n<td>BALI</td>\n<td>BALI_CANGGU  <br />BALI_SESEH_BEACH  <br />BALI_SEMINYAK  <br />BALI_KETEWEL  <br />BALI_UMALAS  <br />BALI_TANAH_LOT_TABANANBALI_KEROBOKAN  <br />BALI_PECATU</td>\n</tr>\n<tr>\n<td>AU (Australia)</td>\n<td>MTBULLER  <br />MTHOTHAM  <br />COFFSHARBOUR  <br />BYRONBAY</td>\n<td></td>\n</tr>\n<tr>\n<td>US (United States of America)</td>\n<td>TAOS  <br />DURANGOMOUNTAIN  <br />PARKCITY  <br />TELLURIDE</td>\n<td></td>\n</tr>\n<tr>\n<td>TH (Thailand)</td>\n<td>PHUKET  <br />KOHSAMUI  <br />KOH_YAO_NOI  <br />KRABI  <br />PATTAYA</td>\n<td></td>\n</tr>\n<tr>\n<td>MY (Malaysia)</td>\n<td>BORNEO</td>\n<td>BORNEO_SABAH</td>\n</tr>\n<tr>\n<td>MY (Malaysia)</td>\n<td>SELANGOR</td>\n<td>SELANGOR_PETALING_JAYA</td>\n</tr>\n<tr>\n<td>OTHER</td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>lang</td>\n<td>string</td>\n<td>The language in which localised content will be returned.</td>\n</tr>\n<tr>\n<td>countryCode</td>\n<td>string</td>\n<td>The country code used in the request.</td>\n</tr>\n<tr>\n<td>locationCode</td>\n<td>string</td>\n<td>The location code used in the request.</td>\n</tr>\n<tr>\n<td>vendors</td>\n<td>array</td>\n<td>List of vendors and their details.</td>\n</tr>\n<tr>\n<td>vendors[].id</td>\n<td>string</td>\n<td>The ID of the vendor.</td>\n</tr>\n<tr>\n<td>vendors[].name</td>\n<td>string</td>\n<td>Vendor name.</td>\n</tr>\n<tr>\n<td>vendors[].image</td>\n<td>string</td>\n<td>Vendor image/logo. The URL of the image.</td>\n</tr>\n<tr>\n<td>vendors[].description</td>\n<td>string</td>\n<td>Vendor description. Text providing a brief overview or introduction. *</td>\n</tr>\n<tr>\n<td>vendors[].url</td>\n<td>string</td>\n<td>Vendor URL. The website or landing page of the vendor.</td>\n</tr>\n<tr>\n<td>vendors[].countryCode</td>\n<td>string</td>\n<td>The country which the vendor location belongs to.</td>\n</tr>\n<tr>\n<td>vendors[].locationCode</td>\n<td>string</td>\n<td>The city or resort area in which the vendor is located. </td>\n</tr>\n<tr>\n<td>vendors[].latitude</td>\n<td>number</td>\n<td>The latitude coordinate of the vendor. Used in conjunction with the \"longitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>vendors[].longitude</td>\n<td>number</td>\n<td>The longitude coordinate of the vendor. Used in conjunction with the \"latitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>vendors[].currencyCode</td>\n<td>string</td>\n<td>The currency used by the vendor. Format: ISO 4217 currency code, e.g. \"JPY\".</td>\n</tr>\n<tr>\n<td>vendors[].vendorType</td>\n<td>string</td>\n<td>Distinguishes a vendor as a seller of either non-accommodation services or accommodation stays. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>vendors[].bookingPermission</td>\n<td>boolean</td>\n<td>Indicates the maximum booking extent the point of sale can make. Represents the level of booking access is granted by the vendor. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\". Note availability, stock and other factors may prevent bookings from being made at the stated level.</td>\n</tr>\n<tr>\n<td>vendors[].bookAndPayEnabled</td>\n<td>boolean</td>\n<td>Enabled when the vendor has the required settings in place to take online payments.</td>\n</tr>\n<tr>\n<td>vendors[].hideRequestIfBookAndPayEnabled</td>\n<td>boolean</td>\n<td>Indicates the UI should not present the option to make a booking enquiry if a booking reservation can be made.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["list"],"host":["https://api.roomboss.com/extws/gs/v1/vendors"],"query":[{"disabled":true,"description":{"content":"<p>The country code of the city or resort area.</p>\n","type":"text/plain"},"key":"countryCode","value":""},{"disabled":true,"description":{"content":"<p>The city or resort area.</p>\n","type":"text/plain"},"key":"locationCode","value":""},{"disabled":true,"description":{"content":"<p>Optional: The language in which localised content will be returned.</p>\n","type":"text/plain"},"key":"lang","value":""},{"disabled":true,"description":{"content":"<p>Optional: When a valid vendor set code is provided, only vendors belonging to the specified vendor set will be returned.</p>\n","type":"text/plain"},"key":"vs","value":""}],"variable":[]}},"response":[{"id":"dda9c5e3-76e6-4e0f-a6c2-06e3c5c467ab","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/vendors/list?countryCode=JP&locationCode=NISEKO&lang=en&vs=VENDORSET","protocol":"https","host":["api","roomboss","com"],"path":["extws","gs","v1","vendors","list"],"query":[{"key":"countryCode","value":"JP"},{"key":"locationCode","value":"NISEKO"},{"key":"lang","value":"en"},{"key":"vs","value":"VENDORSET"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"lang\": \"en\",\n    \"countryCode\": \"JP\",\n    \"locationCode\": \"NISEKO\",\n    \"vendors\": [\n        {\n            \"id\": \"vendorId1\",\n            \"name\": \"Example Ski School 1\",\n            \"image\": \"path/to/image.jpg\",\n            \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\",\n            \"url\": \"example-vendor.com/\",\n            \"countryCode\": \"JP\",\n            \"locationCode\": \"NISEKO_HIRAFU\",\n            \"latitude\": 42.0000000,\n            \"longitude\": 140.0000000,\n            \"currencyCode\": \"JPY\",\n            \"vendorType\": \"SKI_RENTALS\",\n            \"bookingPermission\": \"RESERVATION\",\n            \"bookAndPayEnabled\": true,\n            \"hideRequestIfBookAndPayEnabled\": true\n        }\n    ]\n}"},{"id":"4e77b2af-1fec-4d80-9d91-d4c95d745f46","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/vendors/list","host":["https://api.roomboss.com/extws/gs/v1/vendors"],"path":["list"],"query":[{"key":"countryCode","value":"JP","disabled":true},{"key":"locationCode","value":"NISEKO","disabled":true},{"key":"lang","value":"en","disabled":true},{"key":"vs","value":"VENDORSET","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"88"},{"key":"Date","value":"Fri, 22 Nov 2024 00:12:32 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Country Code parameter is required.\"\n}"},{"id":"32a0b4d0-c6a9-4a86-89bb-e7b1769c9af6","name":"Invalid Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/vendors/list?countryCode=JP&locationCode=invalid","host":["https://api.roomboss.com/extws/gs/v1/vendors"],"path":["list"],"query":[{"key":"countryCode","value":"JP"},{"key":"lang","value":"en","disabled":true},{"key":"vs","value":"VENDORSET","disabled":true},{"key":"locationCode","value":"invalid"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"90"},{"key":"Date","value":"Fri, 22 Nov 2024 00:16:40 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Location Code parameter is not valid.\"\n}"}],"_postman_id":"636c4f15-5808-4b52-807d-709c6cf8d7c2"}],"id":"ba3d90c3-a014-4835-b746-a00aa9f51141","_postman_id":"ba3d90c3-a014-4835-b746-a00aa9f51141","description":""},{"name":"Categories","item":[{"name":"List Categories","id":"ae132a33-6533-455e-9809-928d69d46567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/gs/v1/categories/list","description":"<p>This method allows you list the categories of a specified vendor, returning details such as ID, media URLs, localised names & descriptions, and any child categories.</p>\n<h4 id=\"misccategories\">Categories</h4>\n<p>Categories are used to group and organise products. Products are associated with a category, which in turn belong to a parent category. For example:</p>\n<ul>\n<li><p>Ski & Snowboard Lessons (Parent Category)</p>\n</li>\n<li><p>Ski Lessons (Child Category)</p>\n</li>\n<li><p>Private Ski Lesson (Product)</p>\n</li>\n</ul>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>lang</td>\n<td>string</td>\n<td>The language in which localised content will be returned.</td>\n</tr>\n<tr>\n<td>vendorId</td>\n<td>string</td>\n<td>The vendor ID used in the request.</td>\n</tr>\n<tr>\n<td>categories</td>\n<td>array</td>\n<td>List of categories and their details.</td>\n</tr>\n<tr>\n<td>categories[].id</td>\n<td>string</td>\n<td>Unique identifier of the category.</td>\n</tr>\n<tr>\n<td>categories[].name</td>\n<td>string</td>\n<td>Category name. *</td>\n</tr>\n<tr>\n<td>categories[].image</td>\n<td>string</td>\n<td>Category Image. The URL of the image.</td>\n</tr>\n<tr>\n<td>categories[].description</td>\n<td>string</td>\n<td>Category Description. Text providing a brief overview or introduction. *</td>\n</tr>\n<tr>\n<td>categories[].sequence</td>\n<td>number</td>\n<td>Indicates the order in which categories should be displayed in a sales UI.</td>\n</tr>\n<tr>\n<td>products[].hasOffers</td>\n<td>boolean</td>\n<td>Indicates whether a category product has availability for booking within the next two years.</td>\n</tr>\n<tr>\n<td>categories[].active</td>\n<td>boolean</td>\n<td>The active status of a category.</td>\n</tr>\n<tr>\n<td>categories[].children</td>\n<td>array</td>\n<td>List of child categories.</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li>Localised content (*): If available, text for this field will be returned in the language specified by the lang parameter. If unavailable, English text will be returned.</li>\n</ul>\n","urlObject":{"path":["list"],"host":["https://api.roomboss.com/extws/gs/v1/categories"],"query":[{"disabled":true,"description":{"content":"<p>The ID of the target vendor.</p>\n","type":"text/plain"},"key":"vendorId","value":""},{"disabled":true,"description":{"content":"<p>Optional: The language in which localised content will be returned. Defaults to English.</p>\n","type":"text/plain"},"key":"lang","value":""}],"variable":[]}},"response":[{"id":"fbab83b2-f809-4d1e-9432-020d0ce42b79","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/categories/list?vendorId=vendorId1&lang=en","protocol":"https","host":["api","roomboss","com"],"path":["extws","gs","v1","categories","list"],"query":[{"key":"vendorId","value":"vendorId1"},{"key":"lang","value":"en"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId\",\n    \"lang\": \"en\",\n    \"vendorId\": \"vendorId1\",\n    \"categories\": [\n        {\n            \"id\": \"parentCategoryId1\",\n            \"name\": \"Parent Category 1\",\n            \"image\": \"path/to/image.jpg\",\n            \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n            \"sequence\": 0,\n            \"active\": true,\n            \"hasOffers\": true,\n            \"children\": [\n                {\n                    \"id\": \"categoryId1\",\n                    \"name\": \"Category 1\",\n                    \"image\": \"path/to/image.jpg\",\n                    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n                    \"sequence\": 0,\n                    \"active\": true,\n                    \"itemCapacity\": 5,\n                    \"hasOffers\": true,\n                    \"children\": []\n                },\n                {\n                    \"id\": \"categoryId2\",\n                    \"name\": \"Category 2\",\n                    \"image\": \"path/to/image.jpg\",\n                    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n                    \"sequence\": 0,\n                    \"active\": true,\n                    \"hasOffers\": true,\n                    \"children\": []\n                }\n            ]\n        }  \n    ]\n}"},{"id":"b95490b1-e438-4e82-8b72-b5d3d159f917","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/categories/list","host":["https://api.roomboss.com/extws/gs/v1/categories"],"path":["list"],"query":[{"key":"vendorId","value":"invalid","disabled":true},{"key":"lang","value":"en","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"85"},{"key":"Date","value":"Fri, 22 Nov 2024 01:29:03 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Vendor ID parameter is required.\"\n}"},{"id":"141bbea2-c3c8-41e2-b8fd-ae5ab4883db0","name":"Vendor Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/categories/list?vendorId=invalid","host":["https://api.roomboss.com/extws/gs/v1/categories"],"path":["list"],"query":[{"key":"lang","value":"en","disabled":true},{"key":"vendorId","value":"invalid"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"70"},{"key":"Date","value":"Fri, 22 Nov 2024 01:27:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Vendor not found.\"\n}"}],"_postman_id":"ae132a33-6533-455e-9809-928d69d46567"}],"id":"db110f57-3d12-4bde-8232-97275764748b","_postman_id":"db110f57-3d12-4bde-8232-97275764748b","description":""},{"name":"Products","item":[{"name":"List Products","id":"57d5bc60-535a-413a-b99c-6abdc84a78d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/gs/v1/products/list","description":"<p>This method allows you to list the products of a specified category, returning product options, product details such as ID, media URLs, localised names & descriptions, product settings, and availability for booking.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>vendorId</td>\n<td>string</td>\n<td>The vendor ID of the product.</td>\n</tr>\n<tr>\n<td>categoryId</td>\n<td>string</td>\n<td>The category ID of the product.</td>\n</tr>\n<tr>\n<td>products</td>\n<td>array</td>\n<td>List of products and their details.</td>\n</tr>\n<tr>\n<td>products[].id</td>\n<td>string</td>\n<td>Unique identifier of the product.</td>\n</tr>\n<tr>\n<td>products[].name</td>\n<td>string</td>\n<td>Product name. *</td>\n</tr>\n<tr>\n<td>products[].description</td>\n<td>string</td>\n<td>Product description. Text providing a brief overview or introduction. *</td>\n</tr>\n<tr>\n<td>products[].image</td>\n<td>string</td>\n<td>Product image. The URL of the image.</td>\n</tr>\n<tr>\n<td>products[].sequence</td>\n<td>number</td>\n<td>Indicates the order in which products should be displayed in a sales UI.</td>\n</tr>\n<tr>\n<td>products[].hasOffers</td>\n<td>boolean</td>\n<td>Indicates whether a product has availability for booking within the next two years.</td>\n</tr>\n<tr>\n<td>products[].guestImageRequired</td>\n<td>boolean</td>\n<td>When true, association of a guest with a Guest Image is required to book this product.</td>\n</tr>\n<tr>\n<td>products[].productOptions</td>\n<td>array</td>\n<td>List of product options and their details.</td>\n</tr>\n<tr>\n<td>products[].unbookableDates</td>\n<td>array</td>\n<td>List of date ranges where this product cannot be booked.</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li>Localised content (*): If available, text for this field will be returned in the language specified by the lang parameter. If unavailable, English text will be returned.</li>\n</ul>\n<h4 id=\"miscproductoptions\">Product Options</h4>\n<p>Product options are used to collect information about a guest or the product they are buying.</p>\n<p>Each product is configurable with up to 10 independent product options, such as \"Number of Days\", \"Start Time\", or \"Shoe Size\". Some options can be price affecting, and can also be set as compulsory for booking.</p>\n<p>The format of a product option value is dependent upon its input type. This determines if the product option is intended to allow for selection from a list, accept free text input, or to display a fixed value.</p>\n<p>The product options object provides the necessary data required to build/present these options.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>productOptions</td>\n<td>array</td>\n<td>List of product options and their details.</td>\n</tr>\n<tr>\n<td>productOptions[].id</td>\n<td>string</td>\n<td>Unique identifier of the product option.</td>\n</tr>\n<tr>\n<td>productOptions[].position</td>\n<td>number</td>\n<td>Indicates the order in which product options should be displayed in a sales UI.</td>\n</tr>\n<tr>\n<td>productOptions[].label</td>\n<td>string</td>\n<td>The label describing a product option. E.g \"Skill Level\", or \"Number of Days\". *</td>\n</tr>\n<tr>\n<td>productOptions[].inputType</td>\n<td>string</td>\n<td>The input type of the product option. Indicates if submitted values can be free text, are limited to preset select item options, or are a fixed value. Values: \"FREE_TEXT\", \"DROP_DOWN\", \"FIXED\".</td>\n</tr>\n<tr>\n<td>productOptions[].value</td>\n<td>string/number</td>\n<td>The value of the product option. Provided if the product option input type is \"FIXED\".</td>\n</tr>\n<tr>\n<td>productOptions[].selectItems</td>\n<td>array</td>\n<td>A list of options from which the product option value can be selected. Provided if the product option input type is \"DROP_DOWN\".</td>\n</tr>\n<tr>\n<td>productOptions[].selectItems[].label</td>\n<td>string</td>\n<td>The label of the select item option. E.g \"Beginner\", or \"2 Days\". *</td>\n</tr>\n<tr>\n<td>productOptions[].selectItems[].value</td>\n<td>string/number</td>\n<td>The value of the select item option. E.g \"Beginner\", or 2.</td>\n</tr>\n<tr>\n<td>productOptions[].compulsory</td>\n<td>boolean</td>\n<td>When true, a value for this product option is required in order to book the product.</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li>Localised content (*): If available, text for this field will be returned in the language specified by the lang parameter. If unavailable, English text will be returned.</li>\n</ul>\n<h4 id=\"miscunavailabledates\">Unbookable Dates</h4>\n<p>A list of date ranges where the specified product is unavailable for booking. E.g Jan 1 - 5, Jan 10, Jan 15 - 31.\n\nIn the context of a booking UI, these ranges can be used to block dates on a date calendar, preventing selection/querying of offers for unbookable dates for a product.\n</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>unbookableDates</td>\n<td>array</td>\n<td>List of date ranges where this product cannot be booked.</td>\n</tr>\n<tr>\n<td>unbookableDates[].startDate</td>\n<td>string</td>\n<td>The start date of the date range.  Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>unbookableDates[].endDate</td>\n<td>string</td>\n<td>The end date of the date range.  Format: \"YYYY-MM-DD\".</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["list"],"host":["https://api.roomboss.com/extws/gs/v1/products"],"query":[{"disabled":true,"description":{"content":"<p>The ID of the target category.</p>\n","type":"text/plain"},"key":"categoryId","value":""},{"disabled":true,"description":{"content":"<p>Optional: The language in which localised content will be returned. Defaults to English.</p>\n","type":"text/plain"},"key":"lang","value":""}],"variable":[]}},"response":[{"id":"8fe9dce2-c881-4f4c-acb8-ed6bdb71da25","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/products/list?categoryId=categoryId1&lang=en","host":["https://api.roomboss.com/extws/gs/v1/products"],"path":["list"],"query":[{"key":"categoryId","value":"categoryId1","description":"Returns by Category ID."},{"key":"lang","value":"en","description":"Optional: Defines content language. Defaults to english."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"vendorId\": \"vendorId1\",\n    \"categoryId\": \"categoryId1\",\n    \"products\": [\n        {\n            \"id\": \"productId1\",\n            \"name\": \"Group Ski Lesson\",\n            \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n            \"image\": \"path/to/image.jpg\",\n            \"sequence\": 0,\n            \"hasOffers\": true,\n            \"guestImageRequired\": false,\n            \"productOptions\": [\n                {\n                    \"id\": \"productOptionId1\",\n                    \"position\": 0,\n                    \"label\": \"Number of Days\",\n                    \"selectItems\": [\n                        {\n                            \"label\": \"1 Day\",\n                            \"value\": 1\n                        },\n                        {\n                            \"label\": \"2 Days\",\n                            \"value\": 2\n                        },\n                        {\n                            \"label\": \"3 Days\",\n                            \"value\": 3\n                        }\n                    ],\n                    \"compulsory\": true,\n                    \"inputType\": \"DROP_DOWN\",\n                    \"value\": null\n                },\n                {\n                    \"id\": \"productOptionId2\",\n                    \"position\": 1,\n                    \"label\": \"Ability Level\",\n                    \"selectItems\": [\n                        {\n                            \"label\": \"\",\n                            \"value\": null\n                        },\n                        {\n                            \"label\": \"Beginner\",\n                            \"value\": \"Beginner\"\n                        },\n                        {\n                            \"label\": \"Intermediate\",\n                            \"value\": \"Intermediate\"\n                        },\n                        {\n                            \"label\": \"Advanced\",\n                            \"value\": \"Advanced\"\n                        }\n                    ],\n                    \"compulsory\": false,\n                    \"inputType\": \"DROP_DOWN\", \n                    \"value\": null\n                }\n            ],\n            \"unbookableDates\": [\n                { \n                    \"startDate\": \"2024-05-01\",\n                    \"endDate\": \"2024-11-15\"\n                },\n                { \n                    \"startDate\": \"2024-11-21\",\n                    \"endDate\": \"2024-11-21\"\n                },\n                { \n                    \"startDate\": \"2024-11-28\",\n                    \"endDate\": \"2024-11-28\"\n                },\n                { \n                    \"startDate\": \"2024-12-24\",\n                    \"endDate\": \"2024-12-26\"\n                },\n                { \n                    \"startDate\": \"2025-01-01\",\n                    \"endDate\": \"2025-01-01\"\n                },\n                { \n                    \"startDate\": \"2025-02-12\",\n                    \"endDate\": \"2025-02-14\"\n                },\n                { \n                    \"startDate\": \"2025-04-05\",\n                    \"endDate\": \"2025-04-05\"\n                },\n                { \n                    \"startDate\": \"2025-05-01\",\n                    \"endDate\": \"2025-12-01\"\n                }\n            ]\n        }\n    ]\n}"},{"id":"7d7a9dd3-b320-47dc-adcb-726b167fdbd0","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/products/list","host":["https://api.roomboss.com/extws/gs/v1/products"],"path":["list"],"query":[{"key":"categoryId","value":"categoryId1","description":"Returns by Category ID.","disabled":true},{"key":"lang","value":"en","description":"Optional: Defines content language. Defaults to english.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"87"},{"key":"Date","value":"Fri, 22 Nov 2024 01:54:21 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Category ID parameter is required.\"\n}"},{"id":"a3f341dd-a5ea-494b-895f-6889631113c8","name":"Category Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/products/list?categoryId=invalid","host":["https://api.roomboss.com/extws/gs/v1/products"],"path":["list"],"query":[{"key":"lang","value":"en","description":"Optional: Defines content language. Defaults to english.","disabled":true},{"key":"categoryId","value":"invalid"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"72"},{"key":"Date","value":"Fri, 22 Nov 2024 01:53:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Category not found.\"\n}"}],"_postman_id":"57d5bc60-535a-413a-b99c-6abdc84a78d5"}],"id":"309b24eb-e0ea-4279-89bd-b13fec9d46a8","_postman_id":"309b24eb-e0ea-4279-89bd-b13fec9d46a8","description":""},{"name":"Offers","item":[{"name":"Get Offer","id":"5d7e66e4-34fc-4d70-b908-ff24e42c778a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/offers/:productId","description":"<p>This method returns pricing, availability and booking restrictions for the specified product ID, product options, and date. Optionally define a discount code to be applied.</p>\n<h3 id=\"miscrequestfields\">Request Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>startDate</td>\n<td>string</td>\n<td>The start date of the product booking.</td>\n</tr>\n<tr>\n<td>productOptions</td>\n<td>array</td>\n<td>List of product options and their selected values, referenced by position index.</td>\n</tr>\n<tr>\n<td>productOptions[].position</td>\n<td>number</td>\n<td>Index reference of the product option. </td>\n</tr>\n<tr>\n<td>productOptions[].value</td>\n<td>string/number</td>\n<td>Selected value for the product option.</td>\n</tr>\n<tr>\n<td>discountCode</td>\n<td>string</td>\n<td>A discount code to apply to the package. E.g \"WINTER20\". If valid, adjusted pricing will be returned with the offer. Only one discount code may be applied to a single package order.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>vendorId</td>\n<td>string</td>\n<td>The vendor ID of the product.</td>\n</tr>\n<tr>\n<td>categoryId</td>\n<td>string</td>\n<td>The category ID of the product.</td>\n</tr>\n<tr>\n<td>productId</td>\n<td>string</td>\n<td>Unique identifier of the product.</td>\n</tr>\n<tr>\n<td>startDate</td>\n<td>string</td>\n<td>The start date of the product booking.</td>\n</tr>\n<tr>\n<td>bookingPermission</td>\n<td>string</td>\n<td>Indicates the maximum booking extent the point of sale can make. Represents the level of booking access is granted by the vendor. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\". Note availability, stock and other factors may prevent bookings from being made at the stated level.</td>\n</tr>\n<tr>\n<td>numberGuests</td>\n<td>number</td>\n<td>The number of guests the product can accommodate.</td>\n</tr>\n<tr>\n<td>minAssociatedGuests</td>\n<td>number</td>\n<td>The minimum number of guests required to be associated to a product when making a booking.</td>\n</tr>\n<tr>\n<td>priceGross</td>\n<td>number</td>\n<td>The gross price of the product.</td>\n</tr>\n<tr>\n<td>priceRack</td>\n<td>number</td>\n<td>The gross price after price adjustments.</td>\n</tr>\n<tr>\n<td>currencyCode</td>\n<td>string</td>\n<td>The currency used by the vendor. Format: ISO 4217 currency code, e.g. \"JPY\".</td>\n</tr>\n<tr>\n<td>productOptions</td>\n<td>array</td>\n<td>List of product options and their selected values.</td>\n</tr>\n<tr>\n<td>productOptions[].id</td>\n<td>string</td>\n<td>Unique identifier of the product option.</td>\n</tr>\n<tr>\n<td>productOptions[].position</td>\n<td>number</td>\n<td>Index reference of the product option. </td>\n</tr>\n<tr>\n<td>productOptions[].value</td>\n<td>string/number</td>\n<td>Selected value for the product option.</td>\n</tr>\n<tr>\n<td>discountCode</td>\n<td>string</td>\n<td>A discount code to apply to the package. E.g \"WINTER20\". If valid, adjusted pricing will be returned with the offer. Only one discount code may be applied to a single package order.</td>\n</tr>\n<tr>\n<td>quantityAvailable</td>\n<td>number</td>\n<td>The amount of stock available for the specified product. A value of 5 indicates at least 5+ items available for booking. A non-numeric value indicates the product is not limited by stock.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscbookingextent\">Booking Extent</h4>\n<p>The extent of a booking can be Internal, Request or Reservation.</p>\n<ul>\n<li><p>An Internal booking is only sent to the vendor when you change it to a Request.</p>\n</li>\n<li><p>A Request is a booking that has been submitted to a vendor, but is not confirmed until the vendor changes it to Reservation.</p>\n</li>\n<li><p>A Reservation is a booking that has been confirmed by the vendor.</p>\n</li>\n</ul>\n","urlObject":{"path":[":productId"],"host":["https://api.roomboss.com/extws/gs/v1/offers"],"query":[],"variable":[{"id":"055e5237-e55a-43eb-b11a-a2276c5f1a58","description":{"content":"<p>The ID of the target product.</p>\n","type":"text/plain"},"type":"any","value":"","key":"productId"}]}},"response":[{"id":"9aa09233-782b-4aa6-bc49-dc384aca2131","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"startDate\": \"2025-12-15\",\n    \"productOptions\": [\n        {\n            \"position\": 0,\n            \"value\": 3\n        },\n        {\n            \"position\": 1,\n            \"value\": \"Beginner\"\n        }\n    ],\n    \"discountCode\": \"SUMMER20\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/gs/v1/offers/:productId","protocol":"https","host":["api","roomboss","com"],"path":["extws","gs","v1","offers",":productId"],"variable":[{"key":"productId","value":"productId1"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"vendorId\": \"vendorId1\",\n    \"categoryId\": \"categoryId1\",\n    \"productId\": \"productId1\",\n    \"startDate\": \"2025-12-15\",\n    \"bookingPermission\": \"RESERVATION\",\n    \"numberGuests\": 1,\n    \"minAssociatedGuests\": 0,\n    \"priceRack\": 20000,\n    \"priceGross\": 16000,\n    \"currencyCode\": \"JPY\",\n    \"productOptions\": [\n        {\n            \"id\": \"productOptionId1\",\n            \"position\": 0,\n            \"value\": 1\n        },\n        {\n            \"id\": \"productOptionId2\",\n            \"position\": 1,\n            \"value\": 2\n        }\n    ],\n    \"discountCode\": \"SUMMER20\",\n    \"quantityAvailable\": 5\n}"},{"id":"86f34c30-b7e8-4537-9ed0-a0d88d7b85d4","name":"Unavailable Dates","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"startDate\": \"2025-12-15\",\n    \"productId\": \"productId1\",\n    \"productOptions\": [\n        {\n            \"position\": 0,\n            \"value\": \"1\"\n        },\n        {\n            \"position\": 1,\n            \"value\": \"Beginner\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/offers/productId1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"101"},{"key":"Date","value":"Fri, 22 Nov 2024 06:16:59 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n\t\"apiVersion\": \"1.0\",\n\t\"failureMessage\": \"Unavailable dates cannot be booked.\"\n}"},{"id":"50cfaf28-f766-4eec-bb0d-f5206ced790a","name":"Product Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"startDate\": \"2025-12-15\",\n    \"productId\": \"invalid\",\n    \"productOptions\": [\n        {\n            \"position\": 0,\n            \"value\": 3\n        },\n        {\n            \"position\": 1,\n            \"value\": \"Beginner\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/offers/invalid"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"71"},{"key":"Date","value":"Fri, 22 Nov 2024 06:12:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Product not found.\"\n}"},{"id":"c922bd77-b893-43ad-8dce-afd4213c1a37","name":"Invalid Product Option","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"startDate\": \"2025-12-15\",\n    \"productId\": \"productId1\",\n    \"productOptions\": [\n        {\n            \"position\": 0,\n            \"value\": \"invalid\"\n        },\n        {\n            \"position\": 1,\n            \"value\": \"Beginner\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/offers/productId1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"101"},{"key":"Date","value":"Fri, 22 Nov 2024 06:16:59 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Value for product option position: 0 is invalid.\"\n}"},{"id":"05c15ba5-7a97-4105-aea9-005ea96548b3","name":"Required Product Option","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"startDate\": \"2025-12-15\",\n    \"productId\": \"productId1\",\n    \"productOptions\": [\n        {\n            \"position\": 0,\n            \"value\": \"1\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/offers/productId1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"101"},{"key":"Date","value":"Fri, 22 Nov 2024 06:16:59 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Value for product option position: 0 is required.\"\n}"}],"_postman_id":"5d7e66e4-34fc-4d70-b908-ff24e42c778a"}],"id":"32edcc42-fa3f-49b6-aded-7f2cbc93aa95","_postman_id":"32edcc42-fa3f-49b6-aded-7f2cbc93aa95","description":""},{"name":"Guests","item":[{"name":"List Guest Details","id":"21f18d2d-b0e4-4f36-91d2-b7fcae9463dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/gs/v1/guests/list","description":"<p>This method allows you to list guest information by guest email and/or guest ID. Returns guest details for the lead guest and any associated additional guests.\n\nIt is possible for multiple guests to share the same email. If a guest email is used to query without specifying a guest ID, the most recently created guest (and any associated guests) matching that email will be returned.\n</p>\n<h4 id=\"miscaccess\">Access</h4>\n<p>This method returns sensitive information and is only accessible via credential-authenticated request. Not for public usage.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>guestId</td>\n<td>string</td>\n<td>The guest ID of the queried guest.</td>\n</tr>\n<tr>\n<td>guests</td>\n<td>array</td>\n<td>List of guests and their details. Includes the queried guest, and any additional guests included on bookings where the queried guest is the lead guest.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscguestdetails\">Guest Details</h3>\n<p>Each vendor is able to define which fields are compulsory in order to create a booking.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>title</td>\n<td>string</td>\n<td>Guest title. Values: \"MR\", \"MRS\", \"MS\", \"DR\".</td>\n</tr>\n<tr>\n<td>firstName</td>\n<td>string</td>\n<td>Guest first name. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>lastName</td>\n<td>string</td>\n<td>Guest last name. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>additionalFirstName</td>\n<td>string</td>\n<td>An additional or alternate guest first name. May be required to consist of only Japanese hiragana, Japanese katakana, or latin characters depending on vendor settings. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>additionalLastName</td>\n<td>string</td>\n<td>An additional or alternate guest last name. May be required to consist of only Japanese hiragana, Japanese katakana, or latin characters depending on vendor settings. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>email</td>\n<td>string</td>\n<td>Guest email. Max. character length:  64.</td>\n</tr>\n<tr>\n<td>phoneNumber</td>\n<td>string</td>\n<td>Guest phone number. Max. character length:  64.</td>\n</tr>\n<tr>\n<td>gender</td>\n<td>string</td>\n<td>Guest gender. Values: \"MALE\", \"FEMALE\", \"OTHER\".</td>\n</tr>\n<tr>\n<td>dateOfBirth</td>\n<td>string</td>\n<td>Guest date of birth.  Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>height</td>\n<td>number</td>\n<td>Guest height in centimeters (cm). Min 80, max 200. Format: integer.</td>\n</tr>\n<tr>\n<td>weight</td>\n<td>number</td>\n<td>Guest weight in kilograms (kg). Format: integer. Min 10, max 120.</td>\n</tr>\n<tr>\n<td>nationality</td>\n<td>string</td>\n<td>Guest country of residence. Format: ISO 3166 Country Code, e.g \"JP\".</td>\n</tr>\n<tr>\n<td>address1</td>\n<td>string</td>\n<td>Guest address 1. Max. character length:  120.</td>\n</tr>\n<tr>\n<td>address2</td>\n<td>string</td>\n<td>Guest address 2. Max. character length:  120.</td>\n</tr>\n<tr>\n<td>city</td>\n<td>string</td>\n<td>Guest city. Max. character length:  50.</td>\n</tr>\n<tr>\n<td>state</td>\n<td>string</td>\n<td>Guest state/province/region. Max. character length:  50.</td>\n</tr>\n<tr>\n<td>postCode</td>\n<td>string</td>\n<td>Guest ZIP/Postcode. Max. character length:  20.</td>\n</tr>\n<tr>\n<td>language</td>\n<td>string</td>\n<td>Guest language. Values: \"en\" (English), \"ja\" (Japanese), \"ko\" (Korean), \"fr\" (French), \"zh\" (Chinese - Traditional), \"zh-CN\" (Chinese - Simplified). </td>\n</tr>\n<tr>\n<td>dietaryRestrictions</td>\n<td>string</td>\n<td>Notes on guest dietary restrictions. Max. character length:  1024.</td>\n</tr>\n<tr>\n<td>medicalIssues</td>\n<td>string</td>\n<td>Notes on guest medical issues. Max. character length:  1024.</td>\n</tr>\n<tr>\n<td>emergencyContactName</td>\n<td>string</td>\n<td>Guest emergency contact name. Max. character length:  64.</td>\n</tr>\n<tr>\n<td>emergencyContactTel</td>\n<td>string</td>\n<td>Guest emergency contact phone number. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>image</td>\n<td>string</td>\n<td>Guest Image. The URL of the image.</td>\n</tr>\n<tr>\n<td>isLeadGuest</td>\n<td>boolean</td>\n<td>Indicates whether the guest is the lead guest on a package.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["list"],"host":["https://api.roomboss.com/extws/gs/v1/guests"],"query":[{"disabled":true,"description":{"content":"<p>Optional: The ID of the target guest.</p>\n","type":"text/plain"},"key":"guestId","value":""},{"disabled":true,"description":{"content":"<p>Optional: The email of the target guest.</p>\n","type":"text/plain"},"key":"guestEmail","value":""}],"variable":[]}},"response":[{"id":"8cc54e77-91da-4965-baf3-8cd02a0f04b3","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/guests/list?guestId=guestId1","host":["https://api.roomboss.com/extws/gs/v1/guests"],"path":["list"],"query":[{"key":"guestEmail","value":null,"disabled":true},{"key":"guestId","value":"guestId1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"guestId\": \"guestId1\",\n    \"guests\": [\n        {\n            \"id\": \"guestId1\",\n            \"title\": \"MR\",\n            \"firstName\": \"John\",\n            \"lastName\": \"Smith\",\n            \"additionalFirstName\": \"ジョン\",\n            \"additionalLastName\": \"スミス\",\n            \"email\": \"jsmith@gmail.com\",\n            \"phoneNumber\": \"+123456789\",\n            \"gender\": \"MALE\",\n            \"dateOfBirth\": \"1970-01-01\",\n            \"height\": \"170\",\n            \"weight\": \"80\",\n            \"nationality\": \"US\",\n            \"address1\": \"1 Main Street\",\n            \"address2\": \"Whoville\",\n            \"city\": \"New York\",\n            \"state\": \"New York\",\n            \"postCode\": \"1023456\",\n            \"language\": \"EN\",\n            \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n            \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n            \"emergencyContactName\": \"Jane Smith\",\n            \"emergencyContactTel\": \"+123456788\",\n            \"image\": \"path/to/image.jpg\",\n            \"isLeadGuest\": true\n        },\n        {\n            \"id\": \"guestId2\",\n            \"firstName\": \"Jane\",\n            \"lastName\": \"Smith\",\n            \"additionalFirstName\": null,\n            \"additionalLastName\": null,\n            \"email\": \"janesmith1@gmail.com\",\n            \"phoneNumber\": null,\n            \"gender\": null,\n            \"dateOfBirth\": null,\n            \"height\": null,\n            \"weight\": null,\n            \"nationality\": \"US\",\n            \"address1\": null,\n            \"address2\": null,\n            \"city\": null,\n            \"state\": null,\n            \"postCode\": null,\n            \"language\": null,\n            \"dietaryRestrictions\": null,\n            \"medicalIssues\": null,\n            \"emergencyContactName\": null,\n            \"emergencyContactTel\": null,\n            \"image\": null,\n            \"isLeadGuest\": false\n        }\n    ]\n}"},{"id":"54d9e0f0-0457-49b8-b34f-059afbb7b36d","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/guests/list","host":["https://api.roomboss.com/extws/gs/v1/guests"],"path":["list"],"query":[{"key":"guestEmail","value":null,"disabled":true},{"key":"guestId","value":"guestId1","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"{{gsApiUrl}}\",\n    \"failureMessage\": \"Guest ID or Guest Email parameter is required.\"\n}"},{"id":"e124a25a-a0d6-4b52-ac0a-644e2c42d5dc","name":"Guest Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/guests/list?guestId=invalid","host":["https://api.roomboss.com/extws/gs/v1/guests"],"path":["list"],"query":[{"key":"guestEmail","value":null,"disabled":true},{"key":"guestId","value":"invalid"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"94"},{"key":"Date","value":"Fri, 22 Nov 2024 07:22:16 GMT"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"No guest was found with the ID: invalid\"\n}"}],"_postman_id":"21f18d2d-b0e4-4f36-91d2-b7fcae9463dd"},{"name":"List Guest Fields","id":"0a7e3b37-139a-4f3b-8ab6-d386b44c8594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.roomboss.com/extws/gs/v1/guests/fields/list","description":"<p>This method allows you to query guest field requirements for a specified subset of vendors (each vendor being booked in the package).</p>\n<ul>\n<li><p><code>REQUIRE</code>: Indicates the specified guest field is required for booking.</p>\n</li>\n<li><p><code>SHOW</code>: Indicates the vendors will accept the guest field, but it is not required for booking.</p>\n</li>\n</ul>\n<p>When multiple products from different vendors are being purchased, the most restrictive requirements will be returned for that context.\n\nFor example, Vendor A requires Date of Birth; Vendor B requires Emergency Contact Name. For this context, Date of Birth and Emergency Contact Name will be returned as required for booking.\n</p>\n<h3 id=\"miscrequestfields\">Request Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>vendorIds</td>\n<td>array</td>\n<td>List of vendor IDs to be queried.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>reqNameFormat</td>\n<td>string</td>\n<td>The required format for guest firstName and lastName fields. Values: \"ANY_FORMAT\", \"LATIN_ONLY\", \"HIRAGANA_ONLY\", \"KATAKANA_ONLY\".</td>\n</tr>\n<tr>\n<td>reqAdditionalNameFormat</td>\n<td>string</td>\n<td>The required format for guest additionalFirstName and additionalLastName fields. Values: \"ANY_FORMAT\", \"LATIN_ONLY\", \"HIRAGANA_ONLY\", \"KATAKANA_ONLY\".</td>\n</tr>\n<tr>\n<td>guestFields</td>\n<td>array</td>\n<td>List of guest fields with their visibility/requirement settings. Values: \"SHOW\", \"REQUIRE\".</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["fields","list"],"host":["https://api.roomboss.com/extws/gs/v1/guests"],"query":[],"variable":[]}},"response":[{"id":"f1825430-c4d1-473a-996b-9c30b4d49c60","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"vendorIds\": [\"vendorId1\", \"vendorId2\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/fields/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"vendorIds\": [\n        \"vendorId1\",\n        \"vendorId2\"\n    ],\n    \"reqNameFormat\": \"ANY_FORMAT\",\n    \"reqAdditionalNameFormat\": \"ANY_FORMAT\",\n    \"guestFields\": {\n        \"title\": \"SHOW\",\n        \"firstName\": \"REQUIRE\",\n        \"lastName\": \"REQUIRE\",\n        \"additionalFirstName\": null,\n        \"additionalLastName\": null,\n        \"email\": \"REQUIRE\",\n        \"phoneNumber\": \"SHOW\",\n        \"gender\": \"SHOW\",\n        \"dateOfBirth\": \"SHOW\",\n        \"height\": null,\n        \"weight\": null,\n        \"nationality\": \"REQUIRE\",\n        \"address1\": \"SHOW\",\n        \"address2\": null,\n        \"city\": null,\n        \"state\": null,\n        \"postCode\": null,\n        \"dietaryRestrictions\": null,\n        \"medicalIssues\": null,\n        \"emergencyContactName\": \"SHOW\",\n        \"emergencyContactTel\": \"SHOW\"\n    }\n}"},{"id":"21b029de-e214-4352-8c39-0474bb78d6c1","name":"Required Parameter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"vendorIds\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/fields/list"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"86"},{"key":"Date","value":"Fri, 22 Nov 2024 07:35:02 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Vendor IDs parameter is required.\"\n}"},{"id":"4ed93a7c-7d5e-43f8-ba36-569c0b17a618","name":"Vendor Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"vendorIds\": [\"vendorId1\", \"invalid\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/fields/list"},"status":"Bad Request","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Authorization, Content-Type, X-Aws-Waf-Token"},{"key":"Access-Control-Allow-Methods","value":"GET, OPTIONS, HEAD, PUT, POST, DELETE"},{"key":"Access-Control-Expose-Headers","value":"Location"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"86"},{"key":"Date","value":"Fri, 22 Nov 2024 07:35:02 GMT"},{"key":"Connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Vendor IDs: [invalid] not found\"\n}"}],"_postman_id":"0a7e3b37-139a-4f3b-8ab6-d386b44c8594"},{"name":"Upload Guest Image","id":"db350a1d-cc64-4c90-831c-f5f79fdd7090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"imageUpload","contentType":"multipart/form-data","description":"<p>Description. File Restrictions: 7mb, jpg/jpeg.</p>\n","type":"file","value":null}]},"url":"https://api.roomboss.com/extws/gs/v1/guests/uploadImage","description":"<p>This method allows you to upload a guest image, for later association with the guest when creating a package. Returns the path of the image.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>image</td>\n<td>string</td>\n<td>Guest Image. The URL of the image.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["uploadImage"],"host":["https://api.roomboss.com/extws/gs/v1/guests"],"query":[],"variable":[]}},"response":[{"id":"4c49f791-acc2-455a-8c71-84db5c625836","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","name":"Content-Type","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"imageUpload","contentType":"multipart/form-data","type":"file","src":["PqfEN73Kq/image-upload.jpg"]}],"options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/uploadImage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"image\": \"path/to/image.jpg\"\n}"},{"id":"11b55814-195e-4dc0-b4c7-0e29d892bbba","name":"File Size Exceeded","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","name":"Content-Type","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"imageUpload","contentType":"multipart/form-data","type":"file","src":["PqfEN73Kq/image-upload.jpg"]}],"options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/uploadImage"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Maximum file size exceeded.\"\n}"},{"id":"8a9c93ef-021d-4101-9a74-e15b274352f9","name":"Invalid File Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","name":"Content-Type","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"imageUpload","contentType":"multipart/form-data","type":"file","src":["PqfEN73Kq/image-upload.jpg"]}],"options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/uploadImage"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Failed to upload image. Only .jpg files are supported.\"\n}"},{"id":"074139e0-7c45-47b2-aefe-24ee4b54f61c","name":"Upload Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","name":"Content-Type","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"imageUpload","contentType":"multipart/form-data","type":"file","src":["PqfEN73Kq/image-upload.jpg"]}],"options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/guests/uploadImage"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"Failed to upload image.\"\n}"}],"_postman_id":"db350a1d-cc64-4c90-831c-f5f79fdd7090"}],"id":"d37728cc-a3c4-4fb9-98e2-c03891754004","_postman_id":"d37728cc-a3c4-4fb9-98e2-c03891754004","description":""},{"name":"Packages","item":[{"name":"Create Package","id":"98b843ee-7ab6-4af2-be2f-58ac0d95b712","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.roomboss.com/extws/gs/v1/packages/create","description":"<p>This method allows you to create a new package for the specified booking settings, guest details, and product choices. Optionally apply a booking segment and/or discount code.\n\nCreating a package triggers the automatic creation of invoices if the appropriate account settings and invoice strategy exist.</p>\n<h4 id=\"miscguests\">Guests</h4>\n<p>The list of guests to be included on the package. At least one lead guest is required.</p>\n<ul>\n<li><p>New guests will be created upon booking using the guest details provided.</p>\n</li>\n<li><p>Existing guests can be included when using credential-authenticated access.</p>\n</li>\n<li><p>Existing guests can be updated by providing additional guest details alongside the guest ID.</p>\n</li>\n</ul>\n<h4 id=\"miscitems\">Items</h4>\n<p>The list of products being booked. Each item is intended to be built from its Get Offer response.</p>\n<h3 id=\"miscrequestfields\">Request Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>items[].vendorId</td>\n<td>string</td>\n<td>The vendor ID of the booking item.</td>\n</tr>\n<tr>\n<td>items[].productId</td>\n<td>string</td>\n<td>The product ID of the booking item.</td>\n</tr>\n<tr>\n<td>items[].id</td>\n<td>string</td>\n<td>The ID of the booking element.</td>\n</tr>\n<tr>\n<td>items[].startDate</td>\n<td>string</td>\n<td>The start date of the booking item.  Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>items[].extent</td>\n<td>string</td>\n<td>The requested extent of the product booking. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>items[].price</td>\n<td>number</td>\n<td>The requested sale price of the booking item.</td>\n</tr>\n<tr>\n<td>items[].productOptions</td>\n<td>array</td>\n<td>List of product options and their selected values.</td>\n</tr>\n<tr>\n<td>items[].productOptions[].position</td>\n<td>number</td>\n<td>Index reference of the product option. </td>\n</tr>\n<tr>\n<td>items[].productOptions[].value</td>\n<td>string/number</td>\n<td>Selected value for the product option.</td>\n</tr>\n<tr>\n<td>items[].associatedGuests</td>\n<td>array</td>\n<td>List of guests to be associated to the booking item, referenced by guest index.</td>\n</tr>\n<tr>\n<td>items[].notes</td>\n<td>string</td>\n<td>Optional: Internal booking notes. Max. character length:  1024.</td>\n</tr>\n<tr>\n<td>items[].skiPassNumber</td>\n<td>string</td>\n<td>The SKIDATA ski pass number. Required for SKIDATA recharge bookings.</td>\n</tr>\n<tr>\n<td>guests</td>\n<td>array</td>\n<td>List of guests to be added to the package and their details.</td>\n</tr>\n<tr>\n<td>bookingSegment</td>\n<td>string</td>\n<td>Optional: The booking segment to be applied to the package. E.g \"APP\". When valid, the segment will be added for bookings made in this order.</td>\n</tr>\n<tr>\n<td>discountCode</td>\n<td>string</td>\n<td>Optional: A discount code to apply to the package. E.g \"WINTER20\". Required if any products in the order are using discount code informed pricing.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>package</td>\n<td>object</td>\n<td>Object containing package information, including package bookings, package guests, and package invoice details.</td>\n</tr>\n<tr>\n<td>package.id</td>\n<td>string</td>\n<td>Unique identifier of the package.</td>\n</tr>\n<tr>\n<td>package.companyName</td>\n<td>string</td>\n<td>Company name of the POS.</td>\n</tr>\n<tr>\n<td>package.companyEmail</td>\n<td>string</td>\n<td>Contact email of the POS.</td>\n</tr>\n<tr>\n<td>package.companyPhone</td>\n<td>string</td>\n<td>Contact phone number of the POS.</td>\n</tr>\n<tr>\n<td>package.currencyCode</td>\n<td>string</td>\n<td>The currency used in the package. Format: ISO 4217 currency code, e.g. \"JPY\".</td>\n</tr>\n<tr>\n<td>package.bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>package.guests</td>\n<td>array</td>\n<td>List of additional guests in the package and their details.</td>\n</tr>\n<tr>\n<td>package.invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsevalidationerrors\">Response Validation Errors</h3>\n<p>If there are errors with guest or item validation, validationErrors will be displayed; including the error code and index of the invalid entity.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Error Code</th>\n<th>Error Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>VENDOR_PRODUCT_MISMATCH</td>\n<td>Items</td>\n<td>The specified product does not belong to the specified vendor.</td>\n</tr>\n<tr>\n<td>INVALID_ITEM_PRICE</td>\n<td>Items</td>\n<td>The specified price is invalid or missing.</td>\n</tr>\n<tr>\n<td>INVALID_ASSOCIATED_GUEST</td>\n<td>Items</td>\n<td>An invalid associated guest or guest index has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_ASSOCIATED_GUEST_COUNT</td>\n<td>Items</td>\n<td>The number of guests associated to the product is too few or too many.</td>\n</tr>\n<tr>\n<td>GUEST_ASSOCIATED_TO_MULTIPLE_ITEMS</td>\n<td>Items</td>\n<td>The guest cannot be associated to multiple items in a booking.</td>\n</tr>\n<tr>\n<td>DATE_NOT_AVAILABLE</td>\n<td>Items</td>\n<td>The specified booking date is not available.</td>\n</tr>\n<tr>\n<td>INVALID_PRODUCT_OPTIONS</td>\n<td>Items</td>\n<td>Invalid product options have been provided.</td>\n</tr>\n<tr>\n<td>MISSING_SKI_PASS_NUMBER</td>\n<td>Items</td>\n<td>The ski pass number is missing.</td>\n</tr>\n<tr>\n<td>INVALID_SKI_PASS_NUMBER</td>\n<td>Items</td>\n<td>The specified ski pass number is invalid.</td>\n</tr>\n<tr>\n<td>INVALID_GUEST_EMAIL</td>\n<td>Guests</td>\n<td>An invalid guest email has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_GUEST_COUNTRY_CODE</td>\n<td>Guests</td>\n<td>An invalid guest nationality has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_GUEST_GENDER</td>\n<td>Guests</td>\n<td>An invalid guest gender has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_FIRST_NAME_FORMAT</td>\n<td>Guests</td>\n<td>A guest first name which does not match the required name format has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_LAST_NAME_FORMAT</td>\n<td>Guests</td>\n<td>A guest last name which does not match the required name format has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_ADDITIONAL_FIRST_NAME_FORMAT</td>\n<td>Guests</td>\n<td>A guest additional first name which does not match the required additional name format has been provided.</td>\n</tr>\n<tr>\n<td>INVALID_ADDITIONAL_LAST_NAME_FORMAT</td>\n<td>Guests</td>\n<td>A guest additional last name which does not match the required additional name format has been provided.</td>\n</tr>\n<tr>\n<td>MISSING_GUEST_IMAGE</td>\n<td>Guests</td>\n<td>A guest which does not have a compulsory guest image has been provided.</td>\n</tr>\n<tr>\n<td>INCOMPLETE_GUEST_INFORMATION</td>\n<td>Guests</td>\n<td>A guest which has one or more missing required guest fields has been provided.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["create"],"host":["https://api.roomboss.com/extws/gs/v1/packages"],"query":[],"variable":[]}},"response":[{"id":"c444242f-6b20-4a4d-978e-fffc4d6012cc","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 16000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [\r\n                0\r\n            ]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"John\",\r\n            \"lastName\": \"Smith\",\r\n            \"additionalFirstName\": \"ジョン\",\r\n            \"additionalLastName\": \"スミス\",\r\n            \"email\": \"jsmith@gmail.com\",\r\n            \"phoneNumber\": \"+123456789\",\r\n            \"gender\": \"MALE\",\r\n            \"dateOfBirth\": \"1970-01-01\",\r\n            \"height\": \"170\",\r\n            \"weight\": \"80\",\r\n            \"nationality\": \"US\",\r\n            \"address1\": \"1 Main Street\",\r\n            \"address2\": \"Whoville\",\r\n            \"city\": \"New York\",\r\n            \"state\": \"New York\",\r\n            \"postCode\": \"1023456\",\r\n            \"language\": \"en\",\r\n            \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n            \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n            \"emergencyContactName\": \"Jane Smith\",\r\n            \"emergencyContactTel\": \"+123456788\",\r\n            \"image\": \"path/to/image.jpg\"\r\n        }\r\n    ],\r\n    \"bookingSegment\": \"SEGMENT\",\r\n    \"discountCode\": \"SUMMER20\",\r\n    \"notes\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n    \"multiVendor\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": null,\r\n    \"posId\": \"posId1\",\r\n    \"package\": {\r\n        \"id\": \"packageId1\",\r\n        \"companyName\": \"Example Agent\",\r\n        \"companyEmail\": \"example@email.com\",\r\n        \"companyPhone\": null,\r\n        \"currencyCode\": \"JPY\",\r\n        \"bookings\": [\r\n            {\r\n                \"eid\": 1000000,\r\n                \"customId\": null,\r\n                \"bookingId\": \"bookingId1\",\r\n                \"active\": true,\r\n                \"extent\": \"REQUEST\",\r\n                \"createdDate\": \"2025-05-00T00:00:00.000+0000\",\r\n                \"bookingType\": \"NON_ACCOMMODATION\",\r\n                \"bookingSource\": \"Example Ski School 1\",\r\n                \"bookingSegment\": \"SEGMENT\",\r\n                \"notes\": null,\r\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\r\n                \"items\": [\r\n                    {\r\n                        \"id\": \"bookingElementId1\",\r\n                        \"productId\": \"productId1\",\r\n                        \"productName\": \"Group Ski Lesson\",\r\n                        \"parentCategory\": \"parentCategoryId1\",\r\n                        \"category\": \"categoryId1\",\r\n                        \"priceGross\": 16000.0,\r\n                        \"priceRack\": 20000.0,\r\n                        \"priceNet\": 16000.0,\r\n                        \"startDate\": \"2025-12-15\",\r\n                        \"endDate\": \"2025-12-15\",\r\n                        \"numberGuests\": 3,\r\n                        \"productOptions\": [\r\n                            {\r\n                                \"position\": 0,\r\n                                \"value\": 1\r\n                            },\r\n                            {\r\n                                \"position\": 1,\r\n                                \"value\": 2\r\n                            }\r\n                        ],\r\n                        \"associatedGuests\": [\r\n                            {\r\n                                \"id\": \"guestId1\"\r\n                            }\r\n                        ]\r\n                    }\r\n                ]\r\n            }\r\n        ],\r\n        \"guests\": [\r\n            {\r\n                \"id\": \"guestId1\",\r\n                \"title\": \"MR\",\r\n                \"firstName\": \"John\",\r\n                \"lastName\": \"Smith\",\r\n                \"additionalFirstName\": \"ジョン\",\r\n                \"additionalLastName\": \"スミス\",\r\n                \"email\": \"jsmith@gmail.com\",\r\n                \"phoneNumber\": \"+123456789\",\r\n                \"gender\": \"MALE\",\r\n                \"dateOfBirth\": \"1970-01-01\",\r\n                \"height\": \"170\",\r\n                \"weight\": \"80\",\r\n                \"nationality\": \"US\",\r\n                \"address1\": \"1 Main Street\",\r\n                \"address2\": \"Whoville\",\r\n                \"city\": \"New York\",\r\n                \"state\": \"New York\",\r\n                \"postCode\": \"1023456\",\r\n                \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"emergencyContactName\": \"Jane Smith\",\r\n                \"emergencyContactTel\": \"+123456788\",\r\n                \"image\": \"path/to/image.jpg\",\r\n                \"isLeadGuest\": true \r\n            }\r\n        ],\r\n        \"invoicePayments\": []\r\n    }\r\n}"},{"id":"5e2c701f-4adb-4280-9a62-6e05205a20f8","name":"Success - Multiple Guests","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 16000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0, 1, 2]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"John\",\r\n            \"lastName\": \"Smith\",\r\n            \"additionalFirstName\": \"ジョン\",\r\n            \"additionalLastName\": \"スミス\",\r\n            \"email\": \"jsmith@gmail.com\",\r\n            \"phoneNumber\": \"+123456789\",\r\n            \"gender\": \"MALE\",\r\n            \"dateOfBirth\": \"1970-01-01\",\r\n            \"height\": \"170\",\r\n            \"weight\": \"80\",\r\n            \"nationality\": \"US\",\r\n            \"address1\": \"1 Main Street\",\r\n            \"address2\": \"Whoville\",\r\n            \"city\": \"New York\",\r\n            \"state\": \"New York\",\r\n            \"postCode\": \"1023456\",\r\n            \"language\": \"en\",\r\n            \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n            \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n            \"emergencyContactName\": \"Jane Smith\",\r\n            \"emergencyContactTel\": \"+123456788\",\r\n            \"image\": \"path/to/image.jpg\",\r\n            \"isLeadGuest\": true\r\n        },\r\n        {\r\n            \"title\": \"MRS\",\r\n            \"firstName\": \"Jane\",\r\n            \"lastName\": \"Smith\",\r\n            \"nationality\": \"US\"\r\n        },\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"George\",\r\n            \"lastName\": \"Kirk\",\r\n            \"email\": \"gkirk@gmail.com\",\r\n            \"nationality\": \"CA\"\r\n        }\r\n    ],\r\n    \"bookingSegment\": \"SEGMENT\", \r\n    \"discountCode\": \"SUMMER20\",\r\n    \"notes\": \"\",\r\n    \"multiVendor\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": null,\r\n    \"posId\": \"posId1\",\r\n    \"package\": {\r\n        \"id\": \"packageId1\",\r\n        \"companyName\": \"Example Agent\",\r\n        \"companyEmail\": \"example@email.com\",\r\n        \"companyPhone\": null,\r\n        \"currencyCode\": \"JPY\",\r\n        \"bookings\": [\r\n            {\r\n                \"eid\": 1000000,\r\n                \"customId\": null,\r\n                \"bookingId\": \"bookingId1\",\r\n                \"active\": true,\r\n                \"extent\": \"REQUEST\",\r\n                \"createdDate\": \"2025-05-00T00:00:00.000+0000\",\r\n                \"bookingType\": \"NON_ACCOMMODATION\",\r\n                \"bookingSource\": \"Example Ski School 1\",\r\n                \"bookingSegment\": \"SEGMENT\",\r\n                \"notes\": null,\r\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\r\n                \"items\": [\r\n                    {\r\n                        \"id\": \"bookingElementId1\",\r\n                        \"productId\": \"productId1\",\r\n                        \"productName\": \"Group Ski Lesson\",\r\n                        \"parentCategory\": \"parentCategoryId1\",\r\n                        \"category\": \"categoryId1\",\r\n                        \"priceGross\": 16000.0,\r\n                        \"priceRack\": 20000.0,\r\n                        \"priceNet\": 16000.0,\r\n                        \"startDate\": \"2025-12-15\",\r\n                        \"endDate\": \"2025-12-15\",\r\n                        \"numberGuests\": 3,\r\n                        \"productOptions\": [\r\n                            {\r\n                                \"position\": 0,\r\n                                \"value\": 1\r\n                            },\r\n                            {\r\n                                \"position\": 1,\r\n                                \"value\": 2\r\n                            }\r\n                        ],\r\n                        \"associatedGuests\": [\r\n                            {\r\n                                \"id\": \"guestId1\"\r\n                            },\r\n                            {\r\n                                \"id\": \"guestId2\"\r\n                            },\r\n                            {\r\n                                \"id\": \"guestId3\"\r\n                            }\r\n                        ]\r\n                    }\r\n                ]\r\n            }\r\n        ],\r\n        \"guests\": [\r\n            {\r\n                \"id\": \"guestId1\",\r\n                \"title\": \"MR\",\r\n                \"firstName\": \"John\",\r\n                \"lastName\": \"Smith\",\r\n                \"additionalFirstName\": \"ジョン\",\r\n                \"additionalLastName\": \"スミス\",\r\n                \"email\": \"jsmith@gmail.com\",\r\n                \"phoneNumber\": \"+123456789\",\r\n                \"gender\": \"MALE\",\r\n                \"dateOfBirth\": \"1970-01-01\",\r\n                \"height\": \"170\",\r\n                \"weight\": \"80\",\r\n                \"nationality\": \"US\",\r\n                \"address1\": \"1 Main Street\",\r\n                \"address2\": \"Whoville\",\r\n                \"city\": \"New York\",\r\n                \"state\": \"New York\",\r\n                \"postCode\": \"1023456\",\r\n                \"language\": \"en\",\r\n                \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"emergencyContactName\": \"Jane Smith\",\r\n                \"emergencyContactTel\": \"+123456788\",\r\n                \"image\": \"path/to/image.jpg\",\r\n                \"isLeadGuest\": true \r\n            },\r\n\t\t\t{\r\n\t\t\t\t\"id\": \"guestId2\",\r\n\t\t\t\t\"title\": \"MRS\",\r\n\t\t\t\t\"firstName\": \"Jane\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"additionalFirstName\": \"\",\r\n\t\t\t\t\"additionalLastName\": \"\",\r\n\t\t\t\t\"email\": \"\",\r\n\t\t\t\t\"phoneNumber\": \"\",\r\n\t\t\t\t\"gender\": null,\r\n\t\t\t\t\"dateOfBirth\": null,\r\n\t\t\t\t\"height\": \"0\",\r\n\t\t\t\t\"weight\": \"0\",\r\n\t\t\t\t\"nationality\": \"US\",\r\n\t\t\t\t\"address1\": \"\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"\",\r\n\t\t\t\t\"state\": \"\",\r\n\t\t\t\t\"postCode\": \"\",\r\n\t\t\t\t\"language\": \"\",\r\n\t\t\t\t\"dietaryRestrictions\": \"\",\r\n\t\t\t\t\"medicalIssues\": \"\",\r\n\t\t\t\t\"emergencyContactName\": \"\",\r\n\t\t\t\t\"emergencyContactTel\": \"\",\r\n\t\t\t\t\"image\": null,\r\n\t\t\t\t\"isLeadGuest\": false\r\n\t\t\t},\r\n            {\r\n                \"id\": \"guestId3\",\r\n                \"title\": \"MR\",\r\n                \"firstName\": \"George\",\r\n                \"lastName\": \"Kirk\",\r\n                \"additionalFirstName\": \"\",\r\n\t\t\t\t\"additionalLastName\": \"\",\r\n\t\t\t    \"email\": \"gkirk@gmail.com\",\r\n\t\t\t\t\"phoneNumber\": \"\",\r\n\t\t\t\t\"gender\": null,\r\n\t\t\t\t\"dateOfBirth\": null,\r\n\t\t\t\t\"height\": \"0\",\r\n\t\t\t\t\"weight\": \"0\",\r\n                \"nationality\": \"CA\",\r\n\t\t\t\t\"address1\": \"\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"\",\r\n\t\t\t\t\"state\": \"\",\r\n\t\t\t\t\"postCode\": \"\",\r\n\t\t\t\t\"language\": \"\",\r\n\t\t\t\t\"dietaryRestrictions\": \"\",\r\n\t\t\t\t\"medicalIssues\": \"\",\r\n\t\t\t\t\"emergencyContactName\": \"\",\r\n\t\t\t\t\"emergencyContactTel\": \"\",\r\n\t\t\t\t\"image\": null,\r\n\t\t\t\t\"isLeadGuest\": false\r\n            }\r\n        ],\r\n        \"invoicePayments\": []\r\n    }\r\n}"},{"id":"39ccf9ae-bbdd-4cb1-973a-a889c260bbdf","name":"Success - Existing Guests","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 16000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0, 1, 2]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"id\": \"guestId1\",\r\n            \"isLeadGuest\": true\r\n        },\r\n        {\r\n            \"id\": \"guestId2\"\r\n        },\r\n        {\r\n            \"id\": \"guestId3\"\r\n        }\r\n    ],\r\n    \"bookingSegment\": \"SEGMENT\", \r\n    \"discountCode\": \"SUMMER20\",\r\n    \"notes\": \"\",\r\n    \"multiVendor\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": null,\r\n    \"posId\": \"posId1\",\r\n    \"package\": {\r\n        \"id\": \"packageId1\",\r\n        \"companyName\": \"Example Agent\",\r\n        \"companyEmail\": \"example@email.com\",\r\n        \"companyPhone\": null,\r\n        \"currencyCode\": \"JPY\",\r\n        \"bookings\": [\r\n            {\r\n                \"eid\": 1000000,\r\n                \"customId\": null,\r\n                \"bookingId\": \"bookingId1\",\r\n                \"active\": true,\r\n                \"extent\": \"REQUEST\",\r\n                \"createdDate\": \"2025-05-00T00:00:00.000+0000\",\r\n                \"bookingType\": \"NON_ACCOMMODATION\",\r\n                \"bookingSource\": \"Example Ski School 1\",\r\n                \"bookingSegment\": \"SEGMENT\",\r\n                \"notes\": null,\r\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\r\n                \"items\": [\r\n                    {\r\n                        \"id\": \"bookingElementId1\",\r\n                        \"productId\": \"productId1\",\r\n                        \"productName\": \"Group Ski Lesson\",\r\n                        \"parentCategory\": \"parentCategoryId1\",\r\n                        \"category\": \"categoryId2\",\r\n                        \"priceGross\": 16000.0,\r\n                        \"priceRack\": 20000.0,\r\n                        \"priceNet\": 16000.0,\r\n                        \"startDate\": \"2024-12-17\",\r\n                        \"endDate\": \"2024-12-17\",\r\n                        \"numberGuests\": 3,\r\n                        \"productOptions\": [\r\n                            {\r\n                                \"position\": 0,\r\n                                \"value\": 1\r\n                            },\r\n                            {\r\n                                \"position\": 1,\r\n                                \"value\": 2\r\n                            }\r\n                        ],\r\n                        \"associatedGuests\": [\r\n                            {\r\n                                \"id\": \"guestId1\"\r\n                            },\r\n                            {\r\n                                \"id\": \"guestId2\"\r\n                            },\r\n                            {\r\n                                \"id\": \"guestId3\"\r\n                            }\r\n                        ]\r\n                    }\r\n                ]\r\n            }\r\n        ],\r\n        \"guests\": [\r\n            {\r\n                \"id\": \"guestId1\",\r\n                \"title\": \"MR\",\r\n                \"firstName\": \"John\",\r\n                \"lastName\": \"Smith\",\r\n                \"additionalFirstName\": \"ジョン\",\r\n                \"additionalLastName\": \"スミス\",\r\n                \"email\": \"jsmith@gmail.com\",\r\n                \"phoneNumber\": \"+123456789\",\r\n                \"gender\": \"MALE\",\r\n                \"dateOfBirth\": \"1970-01-01\",\r\n                \"height\": \"170\",\r\n                \"weight\": \"80\",\r\n                \"nationality\": \"US\",\r\n                \"address1\": \"1 Main Street\",\r\n                \"address2\": \"Whoville\",\r\n                \"city\": \"New York\",\r\n                \"state\": \"New York\",\r\n                \"postCode\": \"1023456\",\r\n                \"language\": \"en\",\r\n                \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"emergencyContactName\": \"Jane Smith\",\r\n                \"emergencyContactTel\": \"+123456788\",\r\n                \"image\": \"path/to/image.jpg\",\r\n                \"isLeadGuest\": true \r\n            },\r\n\t\t\t{\r\n\t\t\t\t\"id\": \"guestId2\",\r\n\t\t\t\t\"title\": null,\r\n\t\t\t\t\"firstName\": \"Jane\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"additionalFirstName\": \"\",\r\n\t\t\t\t\"additionalLastName\": \"\",\r\n\t\t\t\t\"email\": \"\",\r\n\t\t\t\t\"phoneNumber\": \"\",\r\n\t\t\t\t\"gender\": null,\r\n\t\t\t\t\"dateOfBirth\": null,\r\n\t\t\t\t\"height\": \"0\",\r\n\t\t\t\t\"weight\": \"0\",\r\n\t\t\t\t\"nationality\": \"US\",\r\n\t\t\t\t\"address1\": \"\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"\",\r\n\t\t\t\t\"state\": \"\",\r\n\t\t\t\t\"postCode\": \"\",\r\n\t\t\t\t\"language\": \"\",\r\n\t\t\t\t\"dietaryRestrictions\": \"\",\r\n\t\t\t\t\"medicalIssues\": \"\",\r\n\t\t\t\t\"emergencyContactName\": \"\",\r\n\t\t\t\t\"emergencyContactTel\": \"\",\r\n\t\t\t\t\"image\": null,\r\n\t\t\t\t\"isLeadGuest\": false\r\n\t\t\t},\r\n            {\r\n\t\t\t\t\"id\": \"guestId3\",\r\n\t\t\t\t\"title\": null,\r\n\t\t\t\t\"firstName\": \"George\",\r\n\t\t\t\t\"lastName\": \"Kirk\",\r\n\t\t\t\t\"additionalFirstName\": \"\",\r\n\t\t\t\t\"additionalLastName\": \"\",\r\n\t\t\t\t\"email\": \"gkirk@gmail.com\",\r\n\t\t\t\t\"phoneNumber\": \"\",\r\n\t\t\t\t\"gender\": null,\r\n\t\t\t\t\"dateOfBirth\": null,\r\n\t\t\t\t\"height\": \"0\",\r\n\t\t\t\t\"weight\": \"0\",\r\n\t\t\t\t\"nationality\": \"CA\",\r\n\t\t\t\t\"address1\": \"\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"\",\r\n\t\t\t\t\"state\": \"\",\r\n\t\t\t\t\"postCode\": \"\",\r\n\t\t\t\t\"language\": \"\",\r\n\t\t\t\t\"dietaryRestrictions\": \"\",\r\n\t\t\t\t\"medicalIssues\": \"\",\r\n\t\t\t\t\"emergencyContactName\": \"\",\r\n\t\t\t\t\"emergencyContactTel\": \"\",\r\n\t\t\t\t\"image\": null,\r\n\t\t\t\t\"isLeadGuest\": false\r\n            }\r\n        ],\r\n        \"invoicePayments\": []\r\n    }\r\n}"},{"id":"86161a86-a4f5-4dc1-a951-ce67aabfccdf","name":"Success - Existing Guests with Update","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 16000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0, 1, 2]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"id\": \"guestId1\",\r\n            \"isLeadGuest\": true\r\n        },\r\n        {\r\n            \"id\": \"guestId2\"\r\n        },\r\n        {\r\n            \"id\": \"guestId3\",\r\n            \"language\": \"en\",\r\n            \"phoneNumber\": \"+0123456789\",\r\n            \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\"\r\n        }\r\n    ],\r\n    \"bookingSegment\": \"SEGMENT\", \r\n    \"discountCode\": \"SUMMER20\",\r\n    \"notes\": \"\",\r\n    \"multiVendor\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": null,\r\n    \"posId\": \"posId1\",\r\n    \"package\": {\r\n        \"id\": \"packageId1\",\r\n        \"companyName\": \"Example Agent\",\r\n        \"companyEmail\": \"example@email.com\",\r\n        \"companyPhone\": null,\r\n        \"currencyCode\": \"JPY\",\r\n        \"bookings\": [\r\n            {\r\n                \"eid\": 1000000,\r\n                \"customId\": null,\r\n                \"bookingId\": \"bookingId1\",\r\n                \"active\": true,\r\n                \"extent\": \"REQUEST\",\r\n                \"createdDate\": \"2025-05-00T00:00:00.000+0000\",\r\n                \"bookingType\": \"NON_ACCOMMODATION\",\r\n                \"bookingSource\": \"Example Ski School 1\",\r\n                \"bookingSegment\": \"SEGMENT\",\r\n                \"notes\": null,\r\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\r\n                \"items\": [\r\n                    {\r\n                        \"id\": \"bookingElementId1\",\r\n                        \"productId\": \"productId1\",\r\n                        \"productName\": \"Group Ski Lesson\",\r\n                        \"parentCategory\": \"parentCategoryId1\",\r\n                        \"category\": \"categoryId2\",\r\n                        \"priceGross\": 16000.0,\r\n                        \"priceRack\": 20000.0,\r\n                        \"priceNet\": 16000.0,\r\n                        \"startDate\": \"2024-12-17\",\r\n                        \"endDate\": \"2024-12-17\",\r\n                        \"numberGuests\": 3,\r\n                        \"productOptions\": [\r\n                            {\r\n                                \"position\": 0,\r\n                                \"value\": 1\r\n                            },\r\n                            {\r\n                                \"position\": 1,\r\n                                \"value\": 2\r\n                            }\r\n                        ],\r\n                        \"associatedGuests\": [\r\n                            {\r\n                                \"id\": \"guestId1\"\r\n                            },\r\n                            {\r\n                                \"id\": \"guestId2\"\r\n                            },\r\n                            {\r\n                                \"id\": \"guestId3\"\r\n                            }\r\n                        ]\r\n                    }\r\n                ]\r\n            }\r\n        ],\r\n        \"guests\": [\r\n            {\r\n                \"id\": \"guestId1\",\r\n                \"title\": \"MR\",\r\n                \"firstName\": \"John\",\r\n                \"lastName\": \"Smith\",\r\n                \"additionalFirstName\": \"ジョン\",\r\n                \"additionalLastName\": \"スミス\",\r\n                \"email\": \"jsmith@gmail.com\",\r\n                \"phoneNumber\": \"+123456789\",\r\n                \"gender\": \"MALE\",\r\n                \"dateOfBirth\": \"1970-01-01\",\r\n                \"height\": \"170\",\r\n                \"weight\": \"80\",\r\n                \"nationality\": \"US\",\r\n                \"address1\": \"1 Main Street\",\r\n                \"address2\": \"Whoville\",\r\n                \"city\": \"New York\",\r\n                \"state\": \"New York\",\r\n                \"postCode\": \"1023456\",\r\n                \"language\": \"en\",\r\n                \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n                \"emergencyContactName\": \"Jane Smith\",\r\n                \"emergencyContactTel\": \"+123456788\",\r\n                \"image\": \"path/to/image.jpg\",\r\n                \"isLeadGuest\": true \r\n            },\r\n\t\t\t{\r\n\t\t\t\t\"id\": \"guestId2\",\r\n\t\t\t\t\"title\": null,\r\n\t\t\t\t\"firstName\": \"Jane\",\r\n\t\t\t\t\"lastName\": \"Smith\",\r\n\t\t\t\t\"additionalFirstName\": \"\",\r\n\t\t\t\t\"additionalLastName\": \"\",\r\n\t\t\t\t\"email\": \"\",\r\n\t\t\t\t\"phoneNumber\": \"\",\r\n\t\t\t\t\"gender\": null,\r\n\t\t\t\t\"dateOfBirth\": null,\r\n\t\t\t\t\"height\": \"0\",\r\n\t\t\t\t\"weight\": \"0\",\r\n\t\t\t\t\"nationality\": \"US\",\r\n\t\t\t\t\"address1\": \"\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"\",\r\n\t\t\t\t\"state\": \"\",\r\n\t\t\t\t\"postCode\": \"\",\r\n\t\t\t\t\"language\": \"\",\r\n\t\t\t\t\"dietaryRestrictions\": \"\",\r\n\t\t\t\t\"medicalIssues\": \"\",\r\n\t\t\t\t\"emergencyContactName\": \"\",\r\n\t\t\t\t\"emergencyContactTel\": \"\",\r\n\t\t\t\t\"image\": null,\r\n\t\t\t\t\"isLeadGuest\": false\r\n\t\t\t},\r\n            {\r\n\t\t\t\t\"id\": \"guestId3\",\r\n\t\t\t\t\"title\": null,\r\n\t\t\t\t\"firstName\": \"George\",\r\n\t\t\t\t\"lastName\": \"Kirk\",\r\n\t\t\t\t\"additionalFirstName\": \"\",\r\n\t\t\t\t\"additionalLastName\": \"\",\r\n\t\t\t\t\"email\": \"gkirk@gmail.com\",\r\n                \"phoneNumber\": \"+0123456789\",\r\n\t\t\t\t\"gender\": null,\r\n\t\t\t\t\"dateOfBirth\": null,\r\n\t\t\t\t\"height\": \"0\",\r\n\t\t\t\t\"weight\": \"0\",\r\n\t\t\t\t\"nationality\": \"CA\",\r\n\t\t\t\t\"address1\": \"\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"\",\r\n\t\t\t\t\"state\": \"\",\r\n\t\t\t\t\"postCode\": \"\",\r\n\t\t\t\t\"language\": \"en\",\r\n\t\t\t\t\"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\r\n\t\t\t\t\"medicalIssues\": \"\",\r\n\t\t\t\t\"emergencyContactName\": \"\",\r\n\t\t\t\t\"emergencyContactTel\": \"\",\r\n\t\t\t\t\"image\": null,\r\n\t\t\t\t\"isLeadGuest\": false\r\n            }\r\n        ],\r\n        \"invoicePayments\": []\r\n    }\r\n}"},{"id":"01e9ba71-5682-4749-9504-03a18a55993a","name":"Guest Validation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"firstName\": \"John\"\r\n        },\r\n        {\r\n            \"title\": \"invalid\",\r\n            \"firstName\": \"Jane\",\r\n            \"lastName\": \"Smith\",\r\n            \"language\": \"invalid\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"Please check the validation errors and try again.\",\r\n    \"validationErrors\": {\r\n        \"guests\": [\r\n            {\r\n                \"index\": 0,\r\n                \"errorCodes\": [\r\n                    \"INCOMPLETE_GUEST_INFORMATION\"\r\n                ]\r\n            },\r\n            {\r\n                \"index\": 1,\r\n                \"errorCodes\": [\r\n                    \"INVALID_GUEST_TITLE\",\r\n                    \"INVALID_GUEST_LANGUAGE\"\r\n                ]\r\n            }\r\n        ]\r\n    }\r\n}"},{"id":"7970a3e7-b4ba-4386-932a-06ce92165b8f","name":"Item Validation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-25\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [1, 2]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"John\",\r\n            \"lastName\": \"Smith\",\r\n            \"email\": \"jsmith@gmail.com\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"Please check the validation errors and try again.\",\r\n    \"validationErrors\": {\r\n        \"items\": [\r\n            {\r\n                \"index\": 0,\r\n                \"errorCodes\": [\r\n                    \"INVALID_ASSOCIATED_GUEST\",\r\n                    \"INVALID_ASSOCIATED_GUEST_COUNT\",\r\n                    \"DATE_NOT_AVAILABLE\"\r\n                ]\r\n            }\r\n        ]\r\n    }\r\n}"},{"id":"00a12fcf-0b10-41a4-adb4-4365148dc592","name":"Product Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"invalid\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"John\",\r\n            \"lastName\": \"Smith\",\r\n            \"email\": \"jsmith@gmail.com\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"No product was found with the ID invalid\"\r\n}"},{"id":"8006453e-6a7f-46d4-a27e-cb85694fdf67","name":"Offer Price Below Retail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 12000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"John\",\r\n            \"lastName\": \"Smith\",\r\n            \"email\": \"jsmith@gmail.com\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"The offer price was higher than the retail price specified.\"\r\n}"},{"id":"3c63184f-7e7b-4b64-aafb-5494fce99fc7","name":"Required Parameter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": null,\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"title\": \"MR\",\r\n            \"firstName\": \"John\",\r\n            \"lastName\": \"Smith\",\r\n            \"email\": \"jsmith@gmail.com\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"Please provide product IDs for each item.\"\r\n}"},{"id":"4ff87cd5-2d48-46bb-89cc-f98dc1054ddd","name":"Guest Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0, 1]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"id\": \"guestId1\",\r\n            \"isLeadGuest\": true\r\n        },\r\n        {\r\n            \"id\": \"invalid\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"No guest was found with the ID invalid for authenticated user.\"\r\n}"},{"id":"1b634c1b-a3b0-43d3-bc42-41c87a3b082d","name":"Required Lead Guest","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0, 1]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"id\": \"guestId1\",\r\n            \"isLeadGuest\": false\r\n        },\r\n        {\r\n            \"id\": \"guestId2\",\r\n            \"isLeadGuest\": false\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"Please enter a valid lead guest.\"\r\n}"},{"id":"ed3f967a-1237-42ac-8729-375858af12db","name":"Multiple Lead Guests","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"items\": [\r\n        {\r\n            \"vendorId\": \"vendorId1\",\r\n            \"productId\": \"productId1\",\r\n            \"startDate\": \"2025-12-15\",\r\n            \"extent\": \"REQUEST\",\r\n            \"price\": 20000.0,\r\n            \"productOptions\": [\r\n                {\r\n                    \"position\": 0,\r\n                    \"value\": 1\r\n                },\r\n                {\r\n                    \"position\": 1,\r\n                    \"value\": 2\r\n                }\r\n            ],\r\n            \"associatedGuests\": [0, 1]\r\n        }\r\n    ],\r\n    \"guests\": [\r\n        {\r\n            \"id\": \"guestId1\",\r\n            \"isLeadGuest\": true\r\n        },\r\n        {\r\n            \"id\": \"guestId2\",\r\n            \"isLeadGuest\": true\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/create"},"status":"OK","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"Please provide one lead guest.\"\r\n}"}],"_postman_id":"98b843ee-7ab6-4af2-be2f-58ac0d95b712"},{"name":"Get Package","id":"cf1048aa-d830-49aa-b486-de56c319e1de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/gs/v1/package","description":"<p>This method returns the details of a specified package, queried by the package or booking ID, and includes information on all bookings within the package, guest details, service provider information, and invoice and payments details.\n\nWhen queried by booking ID, the package containing the booking will be returned.</p>\n<h4 id=\"miscaccess\">Access</h4>\n<p>When accessed via origin-based calls, only limited details for the lead guest will be returned.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>package</td>\n<td>object</td>\n<td>Object containing package information, including package bookings, package guests, and package invoice details.</td>\n</tr>\n<tr>\n<td>package.id</td>\n<td>string</td>\n<td>Unique identifier of the package.</td>\n</tr>\n<tr>\n<td>package.companyName</td>\n<td>string</td>\n<td>Company name of the POS.</td>\n</tr>\n<tr>\n<td>package.companyEmail</td>\n<td>string</td>\n<td>Contact email of the POS.</td>\n</tr>\n<tr>\n<td>package.companyPhone</td>\n<td>string</td>\n<td>Contact phone number of the POS.</td>\n</tr>\n<tr>\n<td>package.totalAmount</td>\n<td>number</td>\n<td>Total price of the package bookings.</td>\n</tr>\n<tr>\n<td>package.receivedAmount</td>\n<td>number</td>\n<td>Total payments received towards package bookings.</td>\n</tr>\n<tr>\n<td>package.currencyCode</td>\n<td>string</td>\n<td>The currency used in the package. Format: ISO 4217 currency code, e.g. \"JPY\".</td>\n</tr>\n<tr>\n<td>package.bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>package.guests</td>\n<td>array</td>\n<td>List of additional guests in the package and their details.</td>\n</tr>\n<tr>\n<td>package.invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookings\">Package Bookings</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>bookings[].eid</td>\n<td>number</td>\n<td>The human-readable booking ID. E.g \"100000\".</td>\n</tr>\n<tr>\n<td>bookings[].customId</td>\n<td>string</td>\n<td>Optional custom ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingId</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].active</td>\n<td>boolean</td>\n<td>The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false).</td>\n</tr>\n<tr>\n<td>bookings[].extent</td>\n<td>string</td>\n<td>The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>bookings[].createdDate</td>\n<td>string</td>\n<td>The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedDate</td>\n<td>string</td>\n<td>The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingType</td>\n<td>string</td>\n<td>Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingSource</td>\n<td>string</td>\n<td>The company name of the booking source.</td>\n</tr>\n<tr>\n<td>bookings[].notes</td>\n<td>string</td>\n<td>Booking note. Max. character length:  4096.</td>\n</tr>\n<tr>\n<td>bookings[].guestIntranetUrl</td>\n<td>string</td>\n<td>The Guest Intranet page URL for the booking.</td>\n</tr>\n<tr>\n<td>bookings[].items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>bookings[].serviceProvider</td>\n<td>object</td>\n<td>Details of the vendor providing the booking.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookingitems\">Package Booking Items</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>items[].id</td>\n<td>string</td>\n<td>The ID of the booking element.</td>\n</tr>\n<tr>\n<td>items[].productId</td>\n<td>string</td>\n<td>The product ID of the booking item.</td>\n</tr>\n<tr>\n<td>items[].productName</td>\n<td>string</td>\n<td>Product name. *</td>\n</tr>\n<tr>\n<td>items[].startDate</td>\n<td>string</td>\n<td>The start date of the booking item.  Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>items[].extent</td>\n<td>string</td>\n<td>The requested extent of the product booking. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>items[].priceGross</td>\n<td>number</td>\n<td>The gross price of the product.</td>\n</tr>\n<tr>\n<td>items[].priceRack</td>\n<td>number</td>\n<td>The gross price after price adjustments.</td>\n</tr>\n<tr>\n<td>items[].priceNet</td>\n<td>number</td>\n<td>The gross price after commission.</td>\n</tr>\n<tr>\n<td>items[].productOptions</td>\n<td>array</td>\n<td>List of product options and their selected values.</td>\n</tr>\n<tr>\n<td>items[].productOptions[].label</td>\n<td>number</td>\n<td>The label describing a product option. E.g \"Skill Level\", or \"Number of Days\". *</td>\n</tr>\n<tr>\n<td>items[].productOptions[].value</td>\n<td>string/number</td>\n<td>Selected value for the product option.</td>\n</tr>\n<tr>\n<td>items[].associatedGuests</td>\n<td>array</td>\n<td>List of guests associated with the booking item. </td>\n</tr>\n<tr>\n<td>items[].notes</td>\n<td>string</td>\n<td>Optional: Internal booking notes. Max. character length:  1024.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscbookingserviceprovider\">Booking Service Provider</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>serviceProvider</td>\n<td>object</td>\n<td>Details of the vendor providing the booking.</td>\n</tr>\n<tr>\n<td>serviceProvider.id</td>\n<td>string</td>\n<td>The ID of the vendor.</td>\n</tr>\n<tr>\n<td>serviceProvider.name</td>\n<td>string</td>\n<td>Vendor name.</td>\n</tr>\n<tr>\n<td>serviceProvider.description</td>\n<td>string</td>\n<td>Vendor description. Text providing a brief overview or introduction. *</td>\n</tr>\n<tr>\n<td>serviceProvider.url</td>\n<td>string</td>\n<td>Vendor URL. The website or landing page of the vendor.</td>\n</tr>\n<tr>\n<td>serviceProvider.vendorType</td>\n<td>string</td>\n<td>Distinguishes a vendor as a seller of either non-accommodation services or accommodation stays. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>serviceProvider.countryCode</td>\n<td>string</td>\n<td>The country which the vendor location belongs to.</td>\n</tr>\n<tr>\n<td>serviceProvider.locationCode</td>\n<td>string</td>\n<td>The city or resort area in which the vendor is located. </td>\n</tr>\n<tr>\n<td>serviceProvider.latitude</td>\n<td>number</td>\n<td>The latitude coordinate of the vendor. Used in conjunction with the \"longitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>serviceProvider.longitude</td>\n<td>number</td>\n<td>The longitude coordinate of the vendor. Used in conjunction with the \"latitude\" value to indicate the location on a map.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackageinvoicepayments\">Package Invoice Payments</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceNumber</td>\n<td>string</td>\n<td>The human-readable invoice number, suffix increments with each invoice. E.g \"100000-1\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceId</td>\n<td>string</td>\n<td>Unique identifier of the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDate</td>\n<td>string</td>\n<td>The date the invoice was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceAmount</td>\n<td>number</td>\n<td>The amount billed on the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDueDate</td>\n<td>string</td>\n<td>The date the invoice is due. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceCreatedDate</td>\n<td>string</td>\n<td>The date the invoice was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceModifiedDate</td>\n<td>string</td>\n<td>The date the invoice was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceNotes</td>\n<td>string</td>\n<td>Invoice note. Max. character length:  128.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentId</td>\n<td>string</td>\n<td>Payment ID registered on the invoice payment. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentDate</td>\n<td>string</td>\n<td>The date the invoice payment was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentAmount</td>\n<td>number</td>\n<td>The amount of the invoice payment.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentMethod</td>\n<td>string</td>\n<td>The type of payment method. See \"Payment Methods\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentCreatedDate</td>\n<td>string</td>\n<td>The date the invoice payment was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentModifiedDate</td>\n<td>string</td>\n<td>The date the invoice payment was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentNotes</td>\n<td>string</td>\n<td>Payment note. Max. character length:  128.</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li>Localised content (*): If available, text for this field will be returned in the language specified by the lang parameter. If unavailable, English text will be returned.</li>\n</ul>\n","urlObject":{"host":["https://api.roomboss.com/extws/gs/v1/package"],"query":[{"disabled":true,"description":{"content":"<p>The ID of a booking. The package which contains the booking will be returned.</p>\n","type":"text/plain"},"key":"bookingId","value":""},{"disabled":true,"description":{"content":"<p>The ID of a package.</p>\n","type":"text/plain"},"key":"packageId","value":""},{"disabled":true,"description":{"content":"<p>Optional: The language in which localised content will be returned. Defaults to English.</p>\n","type":"text/plain"},"key":"lang","value":""}],"variable":[]}},"response":[{"id":"3c8bc3bb-9516-400b-8910-f160cde2c7bf","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/package?packageId=packageId1","protocol":"https","host":["api","roomboss","com"],"path":["extws","gs","v1","package"],"query":[{"key":"bookingId","value":"","description":"Returns by Vendor ID.","disabled":true},{"key":"packageId","value":"packageId1","description":"Returns by Package ID."},{"key":"lang","value":"","description":"Optional: Defines content language. Defaults to english.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"package\": {\n        \"id\": \"packageId1\",\n        \"companyName\": \"Example Agent\",\n        \"companyEmail\": \"example@email.com\",\n        \"companyPhone\": null,\n        \"totalAmount\": 16000.0,\n        \"receivedAmount\": 0,\n        \"currencyCode\": \"JPY\",\n        \"bookings\": [\n            {\n                \"eid\": 1000000,\n                \"customId\": null,\n                \"bookingId\": \"bookingId1\",\n                \"active\": true,\n                \"extent\": \"REQUEST\",\n                \"createdDate\": \"2025-01-01T00:00:00.000+0000\",\n                \"lastModifiedDate\": null,\n                \"bookingType\": \"NON_ACCOMMODATION\",\n                \"bookingSource\": \"Example Ski School 1\",\n                \"notes\": null,\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\n                \"items\": [\n                    {\n                        \"priceGross\": 16000,\n                        \"priceRack\": 20000,\n                        \"priceNet\": 16000,\n                        \"parentCategory\": \"parentCategoryId1\",\n                        \"category\": \"categoryId1\",\n                        \"product\": {\n                            \"id\": \"bookingElementId1\",\n                            \"productId\": \"productId1\",\n                            \"productName\": \"Group Ski Lesson\",\n                            \"productOptions\": [\n                                {\n                                    \"id\": \"productOptionId1\",\n                                    \"label\": \"Number of Days\",\n                                    \"value\": 1\n                                }\n                            ],\n                            \"associatedGuests\": [\n                                [\n                                    {\n                                        \"id\": \"guestId1\",\n                                        \"firstName\": \"John\",\n                                        \"lastName\": \"Smith\"\n                                    }\n                                ]\n                            ]\n                        },\n                        \"startDate\": \"2025-12-15\",\n                        \"endDate\": \"2025-12-15\"\n                    }\n                ],\n                \"serviceProvider\": {\n                    \"id\": \"vendorId1\",\n                    \"name\": \"Example Ski School 1\",\n                    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n                    \"url\": null,\n                    \"vendorType\": \"SKI_RENTALS\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO\",\n                    \"latitude\": null,\n                    \"longitude\": null,\n                    \"currencyCode\": \"JPY\"\n                }\n            }\n        ],\n        \"guests\": [\n            {\n                \"title\": \"MR\",\n                \"firstName\": \"John\",\n                \"lastName\": \"Smith\",\n                \"additionalFirstName\": \"ジョン\",\n                \"additionalLastName\": \"スミス\",\n                \"email\": \"jsmith@gmail.com\",\n                \"phoneNumber\": \"+123456789\",\n                \"gender\": \"MALE\",\n                \"dateOfBirth\": \"1970-01-01\",\n                \"height\": \"170\",\n                \"weight\": \"80\",\n                \"nationality\": \"US\",\n                \"address1\": \"1 Main Street\",\n                \"address2\": \"Whoville\",\n                \"city\": \"New York\",\n                \"state\": \"New York\",\n                \"postCode\": \"1023456\",\n                \"dietaryRestrictions\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n                \"medicalIssues\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n                \"emergencyContactName\": \"Jane Smith\",\n                \"emergencyContactTel\": \"+123456788\",\n                \"image\": \"path/to/image.jpg\",\n                \"isLeadGuest\": true\n            }\n        ],\n        \"invoicePayments\": [\n            {\n                \"invoiceNumber\": \"1000000-1\",\n                \"invoiceId\": \"invoiceId1\",\n                \"invoiceDate\": \"2025-01-01\",\n                \"invoiceAmount\": 4000,\n                \"invoiceDueDate\": \"2025-01-14\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": \"2025-01-02\",\n                \"paymentAmount\": 4000,\n                \"paymentMethod\": \"FLYWIRE\",\n                \"paymentCreatedBy\": \"exampleId\",\n                \"paymentCreatedDate\": \"2025-01-02\",\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            },\n            {\n                \"invoiceNumber\": \"1000000-2\",\n                \"invoiceId\": \"invoiceId2\",\n                \"invoiceDate\": \"2025-01-01\",\n                \"invoiceAmount\": 12000,\n                \"invoiceDueDate\": \"2025-02-01\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            }\n        ]\n    }\n}"},{"id":"a0a5caf4-a833-423f-91ab-08bbef50771a","name":"Success (Origin)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/package?packageId=packageId1","host":["https://api.roomboss.com/extws/gs/v1/package"],"query":[{"key":"bookingId","value":"","description":"Returns by Vendor ID.","disabled":true},{"key":"packageId","value":"packageId1","description":"Returns by Package ID."},{"key":"lang","value":"","description":"Optional: Defines content language. Defaults to english.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": null,\n    \"posId\": \"posId1\",\n    \"package\": {\n        \"id\": \"packageId1\",\n        \"companyName\": \"Example Agent\",\n        \"companyEmail\": \"example@email.com\",\n        \"companyPhone\": null,\n        \"totalAmount\": 16000.0,\n        \"receivedAmount\": 0, \n        \"currencyCode\": \"JPY\",\n        \"bookings\": [\n                {\n                    \"eid\": 1000000,\n                    \"customId\": null,\n                    \"bookingId\": \"bookingId1\",\n                    \"active\": true,\n                    \"extent\": \"REQUEST\",\n                    \"createdDate\": \"2025-01-01T00:00:00.000+0000\",\n                    \"lastModifiedDate\": null,\n                    \"bookingType\": \"NON_ACCOMMODATION\",\n                    \"bookingSource\": \"Example Ski School 1\",\n                    \"notes\": null,\n                    \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\n                    \"items\": [\n                        {\n                            \"priceGross\": 16000.0,\n                            \"priceRack\": 20000.0,\n                            \"priceNet\": 16000.0,\n                            \"parentCategory\": \"parentCategoryId1\",\n                            \"category\": \"categoryId1\",\n                            \"product\": {\n                                \"id\": \"bookingElementId1\",\n                                \"productId\": \"productId1\",\n                                \"productName\": \"Group Ski Lesson\",\n                                \"productOptions\": [\n                                    {\n                                        \"id\": \"productOptionId1\",\n                                        \"label\": \"Number of Days\",\n                                        \"value\": 1\n                                    }\n                                ],\n                                \"associatedGuests\": [\n                                    [\n                                        {\n                                            \"id\": \"guestId1\",\n                                            \"firstName\": \"John\",\n                                            \"lastName\": \"Smith\"\n                                        }\n                                    ]\n                                ]\n                            },\n                            \"startDate\": \"2025-12-15\",\n                            \"endDate\": \"2025-12-15\"\n                        }\n                    ],\n                    \"serviceProvider\": {\n                        \"id\": \"vendorId1\",\n                        \"name\": \"Example Ski School 1\",\n                        \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\",\n                        \"url\": null,\n                        \"vendorType\": \"SKI_RENTALS\",\n                        \"countryCode\": \"JP\",\n                        \"locationCode\": \"NISEKO\",\n                        \"latitude\": null,\n                        \"longitude\": null,\n                        \"currencyCode\": \"JPY\"\n                    }\n                }\n        ],\n        \"guests\": [\n            {   \n                \"title\": \"MR\",\n                \"firstName\": \"John\",\n                \"lastName\": \"Smith\",\n                \"email\": \"jsmith@gmail.com\",\n                \"nationality\": \"US\"\n            }\n        ],\n        \"invoicePayments\": [\n          {\n\t\t\t\t\"invoiceNumber\": \"1000000-1\",\n\t\t\t\t\"invoiceId\": \"invoiceId1\",\n\t\t\t\t\"invoiceDate\": \"2025-01-01\",\n\t\t\t\t\"invoiceAmount\": 4000.0,\n\t\t\t\t\"invoiceDueDate\": \"2025-01-14\",\n\t\t\t\t\"invoiceCreatedBy\": null,\n\t\t\t\t\"invoiceCreatedDate\": null,\n\t\t\t\t\"invoiceModifiedBy\": null,\n\t\t\t\t\"invoiceModifiedDate\": null,\n\t\t\t\t\"invoiceNotes\": null,\n\t\t\t\t\"paymentId\": null,\n\t\t\t\t\"paymentDate\": \"2025-01-02\",\n\t\t\t\t\"paymentAmount\": 4000.0,\n\t\t\t\t\"paymentMethod\": \"FLYWIRE\",\n\t\t\t\t\"paymentCreatedBy\": \"exampleId\",\n\t\t\t\t\"paymentCreatedDate\": \"2025-01-02\",\n\t\t\t\t\"paymentModifiedBy\": null,\n\t\t\t\t\"paymentModifiedDate\": null,\n\t\t\t\t\"paymentNotes\": null\n\t\t\t},\n            {\n\t\t\t\t\"invoiceNumber\": \"1000000-2\",\n\t\t\t\t\"invoiceId\": \"invoiceId2\",\n\t\t\t\t\"invoiceDate\": \"2025-01-01\",\n\t\t\t\t\"invoiceAmount\": 12000.0,\n\t\t\t\t\"invoiceDueDate\": \"2025-02-01\",\n\t\t\t\t\"invoiceCreatedBy\": null,\n\t\t\t\t\"invoiceCreatedDate\": null,\n\t\t\t\t\"invoiceModifiedBy\": null,\n\t\t\t\t\"invoiceModifiedDate\": null,\n\t\t\t\t\"invoiceNotes\": null,\n\t\t\t\t\"paymentId\": null,\n\t\t\t\t\"paymentDate\": null,\n\t\t\t\t\"paymentAmount\": 0,\n\t\t\t\t\"paymentMethod\": null,\n\t\t\t\t\"paymentCreatedBy\": null,\n\t\t\t\t\"paymentCreatedDate\": null,\n\t\t\t\t\"paymentModifiedBy\": null,\n\t\t\t\t\"paymentModifiedDate\": null,\n\t\t\t\t\"paymentNotes\": null\n\t\t\t}\n        ]\n    }\n}"},{"id":"ed906214-a626-496a-8249-ac1523a6d46a","name":"Package Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/package?packageId=invalid","host":["https://api.roomboss.com/extws/gs/v1/package"],"query":[{"key":"bookingId","value":"","description":"Returns by Vendor ID.","disabled":true},{"key":"packageId","value":"invalid","description":"Returns by Package ID."},{"key":"lang","value":"","description":"Optional: Defines content language. Defaults to english.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"No package was found with ID invalid\"\n}"},{"id":"f5ce40cf-abbf-40c8-a532-3c1355c62c89","name":"Booking Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/gs/v1/package?bookingId=invalid","host":["https://api.roomboss.com/extws/gs/v1/package"],"query":[{"key":"bookingId","value":"invalid","description":"Returns by Vendor ID."},{"key":"packageId","value":null,"description":"Returns by Package ID.","disabled":true},{"key":"lang","value":"","description":"Optional: Defines content language. Defaults to english.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.0\",\n    \"failureMessage\": \"No package was found with booking ID invalid\"\n}"}],"_postman_id":"cf1048aa-d830-49aa-b486-de56c319e1de"},{"name":"Create Payment","id":"46228917-efd4-4aca-80df-840b657c1051","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment","description":"<p>This method allows you to register a payment for the specified invoice & booking ID.</p>\n<h3 id=\"miscpaymentmethods\">Payment Methods</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Code</th>\n<th>Payment Method</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>ACCOUNTSRECEIVABLE</td>\n<td>Accounts Receivable</td>\n</tr>\n<tr>\n<td>BANKTRANSFER</td>\n<td>Bank Transfer</td>\n</tr>\n<tr>\n<td>CASH</td>\n<td>Cash</td>\n</tr>\n<tr>\n<td>CHEQUE</td>\n<td>Cheque</td>\n</tr>\n<tr>\n<td>CREDITCARD</td>\n<td>Credit Card</td>\n</tr>\n<tr>\n<td>ECPAY</td>\n<td>ECPay</td>\n</tr>\n<tr>\n<td>PAYGENT</td>\n<td>Paygent</td>\n</tr>\n<tr>\n<td>PAYPAL</td>\n<td>Paypal</td>\n</tr>\n<tr>\n<td>SOFTBANK</td>\n<td>Softbank</td>\n</tr>\n<tr>\n<td>SQUARE</td>\n<td>Square</td>\n</tr>\n<tr>\n<td>STRIPE</td>\n<td>Stripe</td>\n</tr>\n<tr>\n<td>FLYWIRE</td>\n<td>Flywire</td>\n</tr>\n<tr>\n<td>VERITRANS</td>\n<td>Zenryo Payment</td>\n</tr>\n<tr>\n<td>CHECKOUTCOM</td>\n<td>Checkout.com</td>\n</tr>\n<tr>\n<td>VOUCHER</td>\n<td>Voucher</td>\n</tr>\n<tr>\n<td>COUPON</td>\n<td>Coupon</td>\n</tr>\n<tr>\n<td>OWNERACCOUNT</td>\n<td>Owner Account</td>\n</tr>\n<tr>\n<td>OTHER</td>\n<td>Other</td>\n</tr>\n<tr>\n<td>PROMOTIONAL</td>\n<td>Promotional</td>\n</tr>\n<tr>\n<td>ROOMCHARGE</td>\n<td>Room Charge</td>\n</tr>\n<tr>\n<td>FURUSATO_NOZEI</td>\n<td>Furusato Nozei</td>\n</tr>\n<tr>\n<td>ALIPAY</td>\n<td>Alipay</td>\n</tr>\n<tr>\n<td>PAYPAY</td>\n<td>PayPay</td>\n</tr>\n<tr>\n<td>CREDITCARD_AMEX</td>\n<td>Credit Card-AMEX</td>\n</tr>\n<tr>\n<td>CREDITCARD_DC</td>\n<td>Credit Card-DC</td>\n</tr>\n<tr>\n<td>CREDITCARD_GINREI</td>\n<td>Credit Card-Ginrei</td>\n</tr>\n<tr>\n<td>CREDITCARD_JCB</td>\n<td>Credit Card-JCB</td>\n</tr>\n<tr>\n<td>CREDITCARD_MASTERCARD</td>\n<td>Credit Card-Mastercard</td>\n</tr>\n<tr>\n<td>CREDITCARD_MUFG</td>\n<td>Credit Card-MUFG</td>\n</tr>\n<tr>\n<td>CREDITCARD_NICOS</td>\n<td>Credit Card-NICOS</td>\n</tr>\n<tr>\n<td>CREDITCARD_RAKUTEN</td>\n<td>Credit Card-Rakuten</td>\n</tr>\n<tr>\n<td>CREDITCARD_VISA</td>\n<td>Credit Card-VISA</td>\n</tr>\n<tr>\n<td>CREDITCARD_UC</td>\n<td>Credit Card-UC</td>\n</tr>\n<tr>\n<td>GOTO_PAPER_COUPON</td>\n<td>GoTo Paper Coupons</td>\n</tr>\n<tr>\n<td>GOTO_E_COUPON</td>\n<td>GoTo E-Coupons</td>\n</tr>\n<tr>\n<td>GMO</td>\n<td>GMO</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscrequestfields\">Request Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookingId</td>\n<td>string</td>\n<td>The ID of the booking you wish to register a payment for.</td>\n</tr>\n<tr>\n<td>invoiceId</td>\n<td>string</td>\n<td>The ID of the invoice you wish to register a payment for.</td>\n</tr>\n<tr>\n<td>paymentAmount</td>\n<td>number</td>\n<td>The amount of the invoice payment.</td>\n</tr>\n<tr>\n<td>paymentMethod</td>\n<td>string</td>\n<td>The type of payment method. See \"Payment Methods\".</td>\n</tr>\n<tr>\n<td>paymentId</td>\n<td>string</td>\n<td>Optional: Payment ID registered on the invoice payment. Max. character length:  32.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["createPayment"],"host":["https://api.roomboss.com/extws/gs/v1/packages"],"query":[],"variable":[]}},"response":[{"id":"824e1474-2b97-42fb-ba6b-3a27f3f4b0e3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"bookingId\": \"bookingId1\",\r\n    \"invoiceId\": \"invoiceId1\",\r\n    \"paymentAmount\": 3200.0,\r\n    \"paymentMethod\": \"STRIPE\",\r\n    \"paymentId\": \"paymentId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": null\r\n}"},{"id":"a868f7b9-a927-42cc-bf6e-c2edbe563086","name":"Booking Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"bookingId\": \"invalid\",\r\n    \"invoiceId\": \"invoiceId1\",\r\n    \"paymentAmount\": 3200.0,\r\n    \"paymentMethod\": \"STRIPE\",\r\n    \"paymentId\": \"paymentId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"No booking was found with the id: invalid\"\r\n}"},{"id":"014dc574-7879-4866-bd8a-4d6b65b148b9","name":"Invoice Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"bookingId\": \"bookingId1\",\r\n    \"invoiceId\": \"invalid\",\r\n    \"paymentAmount\": 3200.0,\r\n    \"paymentMethod\": \"STRIPE\",\r\n    \"paymentId\": \"paymentId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"No invoice was found with the id: invalid\"\r\n}"},{"id":"c80ea5a5-371b-40dd-9db0-514ebdaf0843","name":"Required Parameter","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"bookingId\": \"bookingId1\",\r\n    \"invoiceId\": null,\r\n    \"paymentAmount\": 3200.0,\r\n    \"paymentMethod\": \"STRIPE\",\r\n    \"paymentId\": \"paymentId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"Please provide a valid Invoice ID\"\r\n}"},{"id":"7119c4fd-3c58-43a1-a94e-8dd94017fe18","name":"Unauthorised Action","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"bookingId\": \"bookingId1\",\r\n    \"invoiceId\": \"invoiceId1\",\r\n    \"paymentAmount\": 3200.0,\r\n    \"paymentMethod\": \"STRIPE\",\r\n    \"paymentId\": \"paymentId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"This booking does not belong to Example Ski School\"\r\n}"},{"id":"c827dd8a-03a9-4bd0-9fa1-23bd34f923fa","name":"Invalid Action","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"bookingId\": \"bookingId1\",\r\n    \"invoiceId\": \"invoiceId1\",\r\n    \"paymentAmount\": 3200.0,\r\n    \"paymentMethod\": \"STRIPE\",\r\n    \"paymentId\": \"paymentId1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.roomboss.com/extws/gs/v1/packages/createPayment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"A payment has already been made for this invoice.\"\r\n}"}],"_postman_id":"46228917-efd4-4aca-80df-840b657c1051"}],"id":"7630a71e-e64e-4b16-bef3-3fcc0d52c729","_postman_id":"7630a71e-e64e-4b16-bef3-3fcc0d52c729","description":""},{"name":"Booking","item":[{"name":"Get SKIDATA Booking Sync Status","id":"d8a61252-dcf0-4c9f-95f1-455e5ce304e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/gs/v1//booking/:bookingId/syncStatus","description":"<p>This method returns information about the synchronization status of a SKIDATA booking.</p>\n<h4 id=\"response-fields\">Response Fields</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>booking</td>\n<td>object</td>\n<td>Object containing details of the booking. Includes the id, status, and items of the booking.</td>\n</tr>\n<tr>\n<td>booking.id</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>booking.status</td>\n<td>string</td>\n<td>The status of the booking. Values: \"ACTIVE\", \"CANCELLED\"</td>\n</tr>\n<tr>\n<td>booking.items</td>\n<td>array</td>\n<td>List of item sync details.</td>\n</tr>\n<tr>\n<td>booking.items[].id</td>\n<td>String</td>\n<td>The ID of the booking element.</td>\n</tr>\n<tr>\n<td>booking.items[].guestId</td>\n<td>String</td>\n<td>The ID of the guest associated to the item.</td>\n</tr>\n<tr>\n<td>booking.items[].syncStatus</td>\n<td>String</td>\n<td>The status of the sync to SKIDATA. Values: \"SYNCED\", \"CANCELLED\", \"NOT_SYNCED\", \"NOT_QUEUED\"</td>\n</tr>\n<tr>\n<td>booking.items[].skidataStatus</td>\n<td>String</td>\n<td>The status of the item in SKIDATA. Values: \"PENDING\", \"RESERVED\", \"BOOKED\", \"BOOKED_AND_TRANSFERRED\", \"BOOKED_AND_REJECTED\",  \"CANCELED\", \"CANCELED_AND_TRANSFERRED\", \"CANCELED_AND_REJECTED\", \"CORRECTED\",  \"NO_STATUS\", \"NOT_PAID\", \"PAID\", \"REFUNDED\", \"REFUNDED_AND_TRANSFERRED\",  \"REFUNDED_AND_REJECTED\"</td>\n</tr>\n<tr>\n<td>booking.items[].skidataOrderId</td>\n<td>String</td>\n<td>The order ID of the item in SKIDATA.</td>\n</tr>\n<tr>\n<td>booking.items[].confirmationNumber</td>\n<td>String</td>\n<td>The confirmation number provided by SKIDATA.</td>\n</tr>\n<tr>\n<td>booking.items[].orderType</td>\n<td>String</td>\n<td>The order type of the item. Values: \"NEW\", \"RECHARGE\".</td>\n</tr>\n<tr>\n<td>booking.items[].liftPassNumber</td>\n<td>String</td>\n<td>The lift pass number from SKIDATA. This is null if the pass has not yet been collected.</td>\n</tr>\n<tr>\n<td>booking.items[].permissionSerialNumber</td>\n<td>String</td>\n<td>The permission serial number from SKIDATA. This is null if the pass has not yet been collected.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["booking",":bookingId","syncStatus"],"host":["https://api.roomboss.com/extws/gs/v1/"],"query":[],"variable":[{"id":"b17513c8-d282-43d8-ba5b-5e0b69d36458","description":{"content":"<p>The ID of the booking</p>\n","type":"text/plain"},"type":"any","value":"","key":"bookingId"}]}},"response":[{"id":"908663a3-8312-4e56-afda-8513cb5b3d44","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.roomboss.com/extws/gs/v1/booking/bookingId1/syncStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": null,\r\n    \"posId\": \"posId1\",\r\n    \"booking\": {\r\n        \"id\": \"bookingId1\",\r\n        \"status\": \"ACTIVE\",\r\n        \"items\": [\r\n            {\r\n                \"id\": \"itemId1\",\r\n                \"guestId\": \"guestId1\",\r\n                \"syncStatus\": \"SYNCED\",\r\n                \"skidataStatus\": \"RESERVED\",\r\n                \"skidataOrderId\": \"skiDataOrderId1\",\r\n                \"confirmationNumber\": \"confirmationNumber1\",\r\n                \"orderType\": \"NEW\",\r\n                \"liftPassNumber\": null,\r\n                \"permissionSerialNumber\": null\r\n            },\r\n            {\r\n                \"id\": \"itemId2\",\r\n                \"guestId\": \"ff8081819390e023019390e071080104\",\r\n                \"syncStatus\": \"SYNCED\",\r\n                \"skidataStatus\": \"BOOKED_AND_TRANSFERRED\",\r\n                \"skidataOrderId\": \"skiDataOrderId2\",\r\n                \"confirmationNumber\": \"confirmationNumber2\",\r\n                \"orderType\": \"RECHARGE\",\r\n                \"liftPassNumber\": \"liftPassNumber2\",\r\n                \"permissionSerialNumber\": \"permissionSerialNumber2\"\r\n            }\r\n        ]\r\n    }\r\n}"},{"id":"8f0ea03d-07d7-4660-9807-443ab4fafd73","name":"Booking Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.roomboss.com/extws/gs/v1//booking/invalid/syncStatus"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"No booking was found with the id: invalid\"\r\n}"},{"id":"3108dc4a-2111-401b-bb2f-776c618a7abb","name":"Invalid Booking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.roomboss.com/extws/gs/v1//booking/booking2/syncStatus"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n    \"apiVersion\": \"1.0\",\r\n    \"failureMessage\": \"The found booking is not a valid Ski Data booking.\"\r\n}"}],"_postman_id":"d8a61252-dcf0-4c9f-95f1-455e5ce304e5"}],"id":"bb634217-6ca7-4343-847a-4cb966185122","_postman_id":"bb634217-6ca7-4343-847a-4cb966185122","description":""}],"id":"ab1b936b-b8c8-4dbf-bf24-cd1d93f890c3","description":"<h1 id=\"pageintroheaderscope\">Scope</h1>\n<p>This API is intended for holders of a ROOMBOSS account.\n\nThe purpose of this API is to facilitate functionality found on the Order02 Booking widget and Customer Intranet page, allowing you to create/maintain your own booking interfaces via a data connection.\n\nThis API allows you to:\n</p>\n<ol>\n<li><p>List vendors by area.</p>\n</li>\n<li><p>List categories by vendor.</p>\n</li>\n<li><p>List products by category.</p>\n</li>\n<li><p>Get available pricing for a specified product, date, and product options.</p>\n</li>\n<li><p>List guest details.</p>\n</li>\n<li><p>List required guest fields for a set of vendors.</p>\n</li>\n<li><p>Upload guest images.</p>\n</li>\n<li><p>Create a package.</p>\n</li>\n<li><p>Get package details.</p>\n</li>\n<li><p>Register a payment on a package.</p>\n</li>\n<li><p>Retrieve synchronisation status for SKIDATA lift pass bookings.</p>\n</li>\n</ol>\n<h1 id=\"pageintroheaderconnection\">Connection</h1>\n<h2 id=\"pageintroheaderbaseurl\">Base URL</h2>\n<p>https://api.roomboss.com/extws/gs/v1/</p>\n<h2 id=\"pageintroheaderauthentication\">Authentication</h2>\n<p>Two methods of authentication are available, depending on the intended usage:</p>\n<h4 id=\"pageintroheaderserverside\">Server-side</h4>\n<p>Callers are required to use HTTP Basic Authentication to authenticate themselves, for which credentials will be provided.</p>\n<h4 id=\"pageintroheaderclientside\">Client-side</h4>\n<p>Calls can be made via a browser-based application using origin authentication. Origins can be configured by creating a website configuration within the applicable RoomBoss account.</p>\n<h2 id=\"pageintroheadersecurity\">Security</h2>\n<p>All calls are to be made via secure HTTP (HTTPS).</p>\n","_postman_id":"ab1b936b-b8c8-4dbf-bf24-cd1d93f890c3"},{"name":"Hotel API","item":[{"name":"Hotels","item":[{"name":"Hotel Directory","id":"eea9b40f-1729-4f79-932a-5d50876bf82a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/list","description":"<p>This method allows you to receive a list of hotels and their IDs. Note the IDs are those required when searching for available accommodation, and when creating a booking.</p>\n<h3 id=\"pagelistvendorsheadercountrylocationcodes\">Country & Location Codes</h3>\n<p>When listing hotels, query by area location to include results from all sublocations associated with it. To limit hotels to a specific zone, instead query by sublocation.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Country Code</th>\n<th>Location Code  <br />(Area)</th>\n<th>Location Code  <br />(Sublocations)</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>JP (Japan)</td>\n<td>NISEKO</td>\n<td>NISEKO_HIRAFU  <br />NISEKO_ANNUPURI  <br />NISEKO_HIGASHIYAMA  <br />NISEKO_HANAZONO  <br />NISEKO_VILLAGE  <br />NISEKO_MOIWA</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KUTCHAN_TOWN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>FURANO</td>\n<td>FURANO_MOUNTAIN  <br />FURANO_TOWN</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>TOKYO</td>\n<td>TOKYO_CITY  <br />TOKYO_NARITA</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>SAPPORO</td>\n<td>SAPPORO_CHITOSE  <br />SAPPORO_CITY</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>ASAHIDAKE</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>HAKUBA</td>\n<td>HAKUBA_47  <br />HAKUBA_CORTINA  <br />HAKUBA_GORYU  <br />HAKUBA_HAPPOONE  <br />HAKUBA_HIGHLAND  <br />HAKUBA_IWATAKE  <br />HAKUBA_MINEKATA  <br />HAKUBA_NORIKURAONSEN  <br />HAKUBA_MISORANO  <br />HAKUBA_ECHOLAND</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KAGURA</td>\n<td>KAGURA_KAGURA  <br />KAGURA_MITSUMATA  <br />KAGURA_TASHIRO</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>RUSUTSU</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>TOMAMU</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>NAEBA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MYOKO</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KIRORO</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MADARAOKOGEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>KYOTO</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>APPIKOGEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>HAKKODA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>SHIGAKOGEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>NOZAWAONSEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>ZAOONSEN</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>CHISENUPURI</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MOIWA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>LAKETOYA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>OKAYAMA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>FUJI_AREA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>GUNMA</td>\n<td></td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>YATSUGATAKE</td>\n<td>SHIRAKABA_KOGEN  <br />IKENOTAIRA  <br />BLANCHE_TAKAYAMA  <br />KURUMAYAMA_KOGEN  <br />SHIRAKABAKO</td>\n</tr>\n<tr>\n<td>JP (Japan)</td>\n<td>MAKKARI</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>QUEENSTOWN</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>METHVEN</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>CARDRONA</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>WANAKA</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>ARROWTOWN</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>FRANKTON</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>TEKAPO</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>FAIRLIE</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>OHAU</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>TWIZEL</td>\n<td></td>\n</tr>\n<tr>\n<td>NZ (New Zealand)</td>\n<td>CANTERBURYHIGHLANDS</td>\n<td>CANTERBURYHIGHLANDS_CASTLEHILL  <br />CANTERBURYHIGHLANDS_CRAIGIEBURN  <br />CANTERBURYHIGHLANDS_SPRINGFIELD  <br />CANTERBURYHIGHLANDS_HANMERSPRINGS</td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>PORTILLO</td>\n<td></td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>TERMASDECHILLAN</td>\n<td></td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>TRESVALLE</td>\n<td>TRESVALLE_VALLENEVADO  <br />TRESVALLE_ELCOLORADO  <br />TRESVALLE_LAPARVA  <br />TRESVALLE_FARELLONES</td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>SANTIAGO</td>\n<td></td>\n</tr>\n<tr>\n<td>CL (Chile)</td>\n<td>LOSANDES</td>\n<td></td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>WHISTLER</td>\n<td></td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>KICKINGHORSE</td>\n<td>KICKINGHORSE_ONMOUNTAIN  <br />KICKINGHORSE_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>REVELSTOKE</td>\n<td>REVELSTOKE_ONMOUNTAIN  <br />REVELSTOKE_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>REDMOUNTAIN</td>\n<td>REDMOUNTAIN_ONMOUNTAIN  <br />REDMOUNTAIN_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>NELSON</td>\n<td>NELSON_ONMOUNTAIN  <br />NELSON_OFFMOUNTAIN</td>\n</tr>\n<tr>\n<td>CA (Canada)</td>\n<td>BIGWHITE</td>\n<td></td>\n</tr>\n<tr>\n<td>ID (Indonesia)</td>\n<td>BALI</td>\n<td>BALI_CANGGU  <br />BALI_SESEH_BEACH  <br />BALI_SEMINYAK  <br />BALI_KETEWEL  <br />BALI_UMALAS  <br />BALI_TANAH_LOT_TABANANBALI_KEROBOKAN  <br />BALI_PECATU</td>\n</tr>\n<tr>\n<td>AU (Australia)</td>\n<td>MTBULLER  <br />MTHOTHAM  <br />COFFSHARBOUR  <br />BYRONBAY</td>\n<td></td>\n</tr>\n<tr>\n<td>US (United States of America)</td>\n<td>TAOS  <br />DURANGOMOUNTAIN  <br />PARKCITY  <br />TELLURIDE</td>\n<td></td>\n</tr>\n<tr>\n<td>TH (Thailand)</td>\n<td>PHUKET  <br />KOHSAMUI  <br />KOH_YAO_NOI  <br />KRABI  <br />PATTAYA</td>\n<td></td>\n</tr>\n<tr>\n<td>MY (Malaysia)</td>\n<td>BORNEO</td>\n<td>BORNEO_SABAH</td>\n</tr>\n<tr>\n<td>MY (Malaysia)</td>\n<td>SELANGOR</td>\n<td>SELANGOR_PETALING_JAYA</td>\n</tr>\n<tr>\n<td>OTHER</td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>hotels</td>\n<td>array</td>\n<td>List of hotels and their details.</td>\n</tr>\n<tr>\n<td>hotels[].hotelId</td>\n<td>string</td>\n<td>The ID of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].hotelName</td>\n<td>string</td>\n<td>The name of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].countryCode</td>\n<td>array</td>\n<td>The country code of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].locationCode</td>\n<td>string</td>\n<td>The location code of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].latitude</td>\n<td>number</td>\n<td>The latitude coordinate of the hotel. Used in conjunction with the \"longitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>hotels[].longitude</td>\n<td>number</td>\n<td>The longitude coordinate of the hotel. Used in conjunction with the \"latitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>hotels[].currencyCode</td>\n<td>string</td>\n<td>The currency used by the hotel. Format: ISO 4217 currency code, e.g. \"JPY\".</td>\n</tr>\n<tr>\n<td>hotels[].url</td>\n<td>string</td>\n<td>Hotel URL. The website or landing page of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].internalInventory</td>\n<td>boolean</td>\n<td>Determines whether the inventory of a hotel is maintained in RoomBoss or retrieved from a 3rd-party API.</td>\n</tr>\n<tr>\n<td>hotels[].recordGuestType</td>\n<td>boolean</td>\n<td>Indicates whether the numberAdults, numberChildren, and numberInfants should be explicitly defined in the createBooking request.</td>\n</tr>\n<tr>\n<td>hotels[].maxAgeChildren</td>\n<td>number</td>\n<td>Specifies the maximum age at which a person is considered a child. Anyone older than this age is classified as an adult.</td>\n</tr>\n<tr>\n<td>hotels[].maxAgeInfants</td>\n<td>number</td>\n<td>Specifies the maximum age at which a person is classified as an infant.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes</td>\n<td>array</td>\n<td>List of room types within a hotel and their details.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].roomTypeId</td>\n<td>number</td>\n<td>The ID of the room type.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].roomTypeName</td>\n<td>number</td>\n<td>The name of the room type.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].maxNumberGuests</td>\n<td>number</td>\n<td>Specifies the maximum number of guests (including adults, children, and infants) that a particular room type can accommodate.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].numberBedrooms</td>\n<td>number</td>\n<td>Indicates the total number of bedrooms in the specified room type.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].numberBathrooms</td>\n<td>number</td>\n<td>Indicates the total number of bathrooms availabie within the specified room type.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].maxNumberAdults</td>\n<td>number</td>\n<td>Defines the maximum number of adults that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].maxNumberChildren</td>\n<td>number</td>\n<td>Defines the maximum number of children that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[].maxNumberInfants</td>\n<td>number</td>\n<td>Defines the maximum number of infants that the specified room type can accommodate.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["list"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>The country code of the resort.</p>\n","type":"text/plain"},"key":"countryCode","value":""},{"disabled":true,"description":{"content":"<p>A city or resort area.</p>\n","type":"text/plain"},"key":"locationCode","value":""}],"variable":[]}},"response":[{"id":"6e8f2a39-06ea-48eb-a868-37738f744d0b","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/list?countryCode=jp&locationCode=niseko","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["list"],"query":[{"key":"countryCode","value":"jp"},{"key":"locationCode","value":"niseko"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"hotels\": [\n        {\n            \"hotelId\": \"ff8081811b103444011b10344bb30001\",\n            \"hotelName\": \"Hotel 1\",\n            \"countryCode\": \"JP\",\n            \"locationCode\": \"NISEKO_HIRAFU\",\n            \"latitude\": 42.8556,\n            \"longitude\": 140.7078,\n            \"currencyCode\": \"JPY\",\n            \"url\": \"www.hotel1.com\",\n            \"internalInventory\": true,\n            \"recordGuestType\": false,\n            \"maxAgeChildren\": 12,\n            \"maxAgeInfants\": 2,\n            \"roomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb45671\",\n                    \"roomTypeName\": \"Quad Room\",\n                    \"maxNumberGuests\": 4,\n                    \"numberBedrooms\": 1,\n                    \"numberBathrooms\": 1,\n                    \"maxNumberAdults\": 4,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0\n                },\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb23451\",\n                    \"roomTypeName\": \"Twin Room\",\n                    \"maxNumberGuests\": 2,\n                    \"numberBedrooms\": 1,\n                    \"numberBathrooms\": 1,\n                    \"maxNumberAdults\": 2,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0\n                }\n            ]\n        },\n        {\n            \"hotelId\": \"ff8081811b103444011b10344bb40001\",\n            \"hotelName\": \"Condo 1\",\n            \"countryCode\": \"JP\",\n            \"locationCode\": \"NISEKO_HANAZONO\",\n            \"latitude\": 42.9372,\n            \"longitude\": 140.232,\n            \"currencyCode\": \"JPY\",\n            \"url\": \"\",\n            \"internalInventory\": true,\n            \"recordGuestType\": false,\n            \"maxAgeChildren\": 12,\n            \"maxAgeInfants\": 2,\n            \"roomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb88853\",\n                    \"roomTypeName\": \"Two Bedroom Apartment\",\n                    \"maxNumberGuests\": 5,\n                    \"numberBedrooms\": 2,\n                    \"numberBathrooms\": 2,\n                    \"maxNumberAdults\": 5,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0\n                },\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb94321\",\n                    \"roomTypeName\": \"Three Bedroom Apartment\",\n                    \"maxNumberGuests\": 6,\n                    \"numberBedrooms\": 3,\n                    \"numberBathrooms\": 2,\n                    \"maxNumberAdults\": 6,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0\n                }\n            ]\n        }\n    ]\n}"},{"id":"e1530d9b-cee2-4f02-8379-79de16256a22","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/list?countryCode=&locationCode=","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["list"],"query":[{"key":"countryCode","value":"","description":"The country code of the resort."},{"key":"locationCode","value":"","description":"A city or resort area."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Parameters countryCode and locationCode are mandatory and are case sensitive.\"\n}"}],"_postman_id":"eea9b40f-1729-4f79-932a-5d50876bf82a"},{"name":"List Available Stays","id":"246e9071-a2c8-4937-8b47-1625a8897f26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listAvailable","description":"<p>This method allows you to search for available accommodation. Note that only hotels that have available options to accommodate your group will be returned. When a room cannot accommodate your group in a single room but it is possible if multiple rooms are selected, it will be included in the result as well.</p>\n<p>In addition, the method also shows the Booking Extent access to a given property for the given dates based on the agent permission and vendor policy.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>availableHotels</td>\n<td>array</td>\n<td>List of available hotels and their details.</td>\n</tr>\n<tr>\n<td>availableHotels[].hotelId</td>\n<td>string</td>\n<td>The ID of the hotel.</td>\n</tr>\n<tr>\n<td>availableHotels[].hotelName</td>\n<td>string</td>\n<td>The name of the hotel.</td>\n</tr>\n<tr>\n<td>availableHotels[].countryCode</td>\n<td>array</td>\n<td>The country code of the hotel.</td>\n</tr>\n<tr>\n<td>availableHotels[].locationCode</td>\n<td>string</td>\n<td>The location code of the hotel.</td>\n</tr>\n<tr>\n<td>availableHotels[].latitude</td>\n<td>number</td>\n<td>The latitude coordinate of the hotel. Used in conjunction with the \"longitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>availableHotels[].longitude</td>\n<td>number</td>\n<td>The longitude coordinate of the hotel. Used in conjunction with the \"latitude\" value to indicate the location on a map.</td>\n</tr>\n<tr>\n<td>availableHotels[].currencyCode</td>\n<td>string</td>\n<td>The currency used by the hotel. Format: ISO 4217 currency code, e.g. \"JPY\".</td>\n</tr>\n<tr>\n<td>availableHotels[].url</td>\n<td>string</td>\n<td>Hotel URL. The website or landing page of the hotel.</td>\n</tr>\n<tr>\n<td>availableHotels[].internalInventory</td>\n<td>boolean</td>\n<td>Determines whether the inventory of a hotel is maintained in RoomBoss or retrieved from a 3rd-party API.</td>\n</tr>\n<tr>\n<td>availableHotels[].recordGuestType</td>\n<td>boolean</td>\n<td>Indicates whether the numberAdults, numberChildren, and numberInfants should be explicitly defined in the createBooking request.</td>\n</tr>\n<tr>\n<td>availableHotels[].maxAgeChildren</td>\n<td>number</td>\n<td>Specifies the maximum age at which a person is considered a child. Anyone older than this age is classified as an adult.</td>\n</tr>\n<tr>\n<td>availableHotels[].maxAgeInfants</td>\n<td>number</td>\n<td>Specifies the maximum age at which a person is classified as an infant.</td>\n</tr>\n<tr>\n<td>availableHotels[].roomTypes</td>\n<td>array</td>\n<td>List of room types within a hotel and their details.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"mischotelroomtypes\">Hotel Room Types</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>roomTypes</td>\n<td>array</td>\n<td>List of room types within a hotel and their details.</td>\n</tr>\n<tr>\n<td>roomTypes[] .roomTypeId</td>\n<td>number</td>\n<td>The ID of the room type.</td>\n</tr>\n<tr>\n<td>roomTypes[] .roomTypeName</td>\n<td>number</td>\n<td>The name of the room type.</td>\n</tr>\n<tr>\n<td>roomTypes[] .maxNumberGuests</td>\n<td>number</td>\n<td>Specifies the maximum number of guests (including adults, children, and infants) that a particular room type can accommodate.</td>\n</tr>\n<tr>\n<td>roomTypes[] .numberBedrooms</td>\n<td>number</td>\n<td>Indicates the total number of bedrooms in the specified room type.</td>\n</tr>\n<tr>\n<td>roomTypes[] .numberBathrooms</td>\n<td>number</td>\n<td>Indicates the total number of bathrooms availabie within the specified room type.</td>\n</tr>\n<tr>\n<td>roomTypes[] .maxNumberAdults</td>\n<td>number</td>\n<td>Defines the maximum number of adults that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>roomTypes[] .maxNumberChildren</td>\n<td>number</td>\n<td>Defines the maximum number of children that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>roomTypes[] .maxNumberInfants</td>\n<td>number</td>\n<td>Defines the maximum number of infants that the specified room type can accommodate.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"mischotelavailableroomtypes\">Hotel Available Room Types</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>availableRoomTypes</td>\n<td>array</td>\n<td>List of room types within a hotel and their details.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .roomTypeId</td>\n<td>number</td>\n<td>The ID of the room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .roomTypeName</td>\n<td>number</td>\n<td>The name of the room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .maxNumberGuests</td>\n<td>number</td>\n<td>Specifies the maximum number of guests (including adults, children, and infants) that a particular room type can accommodate.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .numberBedrooms</td>\n<td>number</td>\n<td>Indicates the total number of bedrooms in the specified room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .numberBathrooms</td>\n<td>number</td>\n<td>Indicates the total number of bathrooms availabie within the specified room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .maxNumberAdults</td>\n<td>number</td>\n<td>Defines the maximum number of adults that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .maxNumberChildren</td>\n<td>number</td>\n<td>Defines the maximum number of children that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .maxNumberInfants</td>\n<td>number</td>\n<td>Defines the maximum number of infants that the specified room type can accommodate.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .quantityAvailable</td>\n<td>number</td>\n<td>The number of available units for a particular roomType that can be booked.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .priceRetail</td>\n<td>number</td>\n<td>The gross price of the room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .priceRack</td>\n<td>number</td>\n<td>The gross price after price adjustments.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .priceNet</td>\n<td>number</td>\n<td>The gross price after commission.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .priceNumberGuests</td>\n<td>number</td>\n<td>Indicates the number of guests that the specified price applies to for a given room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan</td>\n<td>object</td>\n<td>Returned when the rate parameter is used in a request. Includes details of the available rate plan for the room type</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.ratePlanId</td>\n<td>string</td>\n<td>The ID of the rate plan.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.priceRetail</td>\n<td>number</td>\n<td>The gross price of the room type.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.mealsIncluded</td>\n<td>boolean</td>\n<td>Indicates whether meals are included as part of the rate plan.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.breakfast</td>\n<td>boolean</td>\n<td>Indicates whether breakfast is included as part of the rate plan.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.lunch</td>\n<td>boolean</td>\n<td>Indicates whether lunch is included as part of the rate plan.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.dinner</td>\n<td>boolean</td>\n<td>Indicates whether dinner is included as part of the rate plan.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.currencyCode</td>\n<td>string</td>\n<td>The currency code corresponding to the retail price of the rate plan.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.altCurrencyCode</td>\n<td>string</td>\n<td>Represents the alternative currency code used for the altPriceRetail value. If the request included an altCurrencyString, the prices will be returned in both the default currency and this alternative currency.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.altPriceRetail</td>\n<td>number</td>\n<td>Represents the converted retail price in the alternative currency specified by altCurrencyString. If an altCurrencyCode was provided in the request, this field returns the equivalent of priceRetail in that currency.</td>\n</tr>\n<tr>\n<td>availableRoomTypes[] .ratePlan.rateRestrictionIgnored</td>\n<td>boolean</td>\n<td>{{description.availableRoomTypes.rateplan.rateRestrictionIgnored}}</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["listAvailable"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify which hotel(s) you wish to query. This parameter may be specified multiple times.</p>\n","type":"text/plain"},"key":"hotelId","value":""},{"disabled":true,"description":{"content":"<p>Specify the check-in date. Format: yyyyMMdd</p>\n","type":"text/plain"},"key":"checkIn","value":""},{"disabled":true,"description":{"content":"<p>Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.</p>\n","type":"text/plain"},"key":"checkOut","value":""},{"disabled":true,"description":{"content":"<p>Specify the number of guests in the group</p>\n","type":"text/plain"},"key":"numberGuests","value":""},{"disabled":true,"description":{"content":"<p>Optional: Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions.</p>\n","type":"text/plain"},"key":"excludeConditionsNotMet","value":""},{"disabled":true,"description":{"content":"<p>Optional: Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount.</p>\n","type":"text/plain"},"key":"discountCode","value":""},{"disabled":true,"description":{"content":"<p>Must be `ota`. Indicates OTA style rate plans should be used.</p>\n","type":"text/plain"},"key":"rate","value":""},{"disabled":true,"description":{"content":"<p>Optional: When a valid vendor set code is provided, only hotels belonging to the specified vendor set will be returned.</p>\n","type":"text/plain"},"key":"vs","value":""},{"disabled":true,"description":{"content":"<p>Optional: Specify an alternative currency in which the prices should be returned.</p>\n","type":"text/plain"},"key":"altCurrencyString","value":""},{"disabled":true,"description":{"content":"<p>Optional: Determines whether the request should return all valid hotels. If no specific hotel IDs are provided, this field must be set to true.</p>\n","type":"text/plain"},"key":"all","value":""},{"disabled":true,"description":{"content":"<p>Optional: The country code of the resort.</p>\n","type":"text/plain"},"key":"countryCode","value":""},{"disabled":true,"description":{"content":"<p>Optional: The country code of the resort.</p>\n","type":"text/plain"},"key":"locationCode","value":""}],"variable":[]}},"response":[{"id":"47793af8-c4e0-44e5-a858-1860827a2886","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listAvailable?rate=ota&hotelId=ff8081811b103444011b10344bb30001&hotelId=402881874100bd9a014100c29f850001&checkIn=20270315&checkOut=20270321&numberGuests=4","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listAvailable"],"query":[{"key":"hotelId","value":null,"description":"{{description.request.hotelId}}","type":"text","disabled":true},{"key":"checkIn","value":null,"description":"{{description.request.checkIn}}","type":"text","disabled":true},{"key":"checkOut","value":null,"description":"{{description.request.checkOut}}","type":"text","disabled":true},{"key":"numberGuests","value":null,"description":"{{description.request.numberGuests}}","type":"text","disabled":true},{"key":"excludeConditionsNotMet","value":null,"description":"Optional: {{description.excludeConditionsNotMet}}","type":"text","disabled":true},{"key":"discountCode","value":null,"description":"Optional: {{description.discountCode}}","type":"text","disabled":true},{"key":"rate","value":"ota","description":"{{description.rate}}","type":"text"},{"key":"hotelId","value":"ff8081811b103444011b10344bb30001"},{"key":"hotelId","value":"402881874100bd9a014100c29f850001"},{"key":"checkIn","value":"20270315"},{"key":"checkOut","value":"20270321"},{"key":"numberGuests","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"posId\": \"69ca195c773e429980749592afb41b04\",\n    \"checkIn\": \"2027-03-15\",\n    \"checkOut\": \"2027-03-21\",\n    \"numberGuests\": 4,\n    \"availableHotels\": [\n        {\n            \"hotelId\": \"ff8081811b103444011b10344bb30001\",\n            \"hotelName\": \"Hotel 1\",\n            \"countryCode\": \"JP\",\n            \"locationCode\": \"NISEKO_HIRAFU\",\n            \"latitude\": 42.8556,\n            \"longitude\": 140.7078,\n            \"currencyCode\": \"JPY\",\n            \"url\": \"www.hotel1.com\",\n            \"internalInventory\": true,\n            \"bookingPermission\": \"RESERVATION\",\n            \"recordGuestType\": false,\n            \"maxAgeChildren\": 12,\n            \"maxAgeInfants\": 2,\n            \"roomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb45671\",\n                    \"roomTypeName\": \"Quad Room\",\n                    \"maxNumberGuests\": 4,\n                    \"numberBedrooms\": 1,\n                    \"numberBathrooms\": 1,\n                    \"maxNumberAdults\": 4,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0\n                },\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb23451\",\n                    \"roomTypeName\": \"Twin Room\",\n                    \"maxNumberGuests\": 2,\n                    \"numberBedrooms\": 1,\n                    \"numberBathrooms\": 1,\n                    \"maxNumberAdults\": 2,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0\n                }\n            ],\n            \"availableRoomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811b103444011b10344bb23451\",\n                    \"roomTypeName\": \"Twin Room\",\n                    \"maxNumberGuests\": 2,\n                    \"numberBedrooms\": 1,\n                    \"numberBathrooms\": 1,\n                    \"maxNumberAdults\": 2,\n                    \"maxNumberChildren\": 0,\n                    \"maxNumberInfants\": 0,\n                    \"quantityAvailable\": 2,\n                    \"priceRetail\": 28000,\n                    \"priceRack\": 28000,\n                    \"priceNet\": 20000,\n                    \"priceNumberGuests\": 2\n                }\n            ]\n        }\n    ]\n}"},{"id":"f6f6d44b-5532-420c-b681-ed20ea2e656e","name":"Required Hotel ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listAvailable?rate=ota&checkIn=20270315&checkOut=20270321&numberGuests=4","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listAvailable"],"query":[{"key":"hotelId","value":"","description":"Specify which hotel(s) you wish to query. This parameter may be specified multiple times.","disabled":true},{"key":"checkIn","value":"","description":"Specify the check-in date. Format: yyyyMMdd","type":"text","disabled":true},{"key":"checkOut","value":"","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.","type":"text","disabled":true},{"key":"numberGuests","value":"","description":"Specify the number of guests in the group","type":"text","disabled":true},{"key":"excludeConditionsNotMet","value":"","description":"Optional: Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions.","type":"text","disabled":true},{"key":"discountCode","value":"","description":"Optional: Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount.","type":"text","disabled":true},{"key":"rate","value":"ota"},{"key":"checkIn","value":"20270315"},{"key":"checkOut","value":"20270321"},{"key":"numberGuests","value":"4"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide at least 1 hotel ID.\"\n}"},{"id":"0bfcc6e5-1ac5-45b5-8102-52fb91793afc","name":"Required Dates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listAvailable?rate=ota&hotelId=ff8081811b103444011b10344bb30001&checkOut=20270321&numberGuests=4","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listAvailable"],"query":[{"key":"hotelId","value":"","description":"Specify which hotel(s) you wish to query. This parameter may be specified multiple times.","disabled":true},{"key":"checkIn","value":"","description":"Specify the check-in date. Format: yyyyMMdd","type":"text","disabled":true},{"key":"checkOut","value":"","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.","type":"text","disabled":true},{"key":"numberGuests","value":"","description":"Specify the number of guests in the group","type":"text","disabled":true},{"key":"excludeConditionsNotMet","value":"","description":"Optional: Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions.","type":"text","disabled":true},{"key":"discountCode","value":"","description":"Optional: Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount.","type":"text","disabled":true},{"key":"rate","value":"ota","type":"text"},{"key":"hotelId","value":"ff8081811b103444011b10344bb30001"},{"key":"checkOut","value":"20270321"},{"key":"numberGuests","value":"4"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide dates.\"\n}"},{"id":"84b26cce-8cc7-432e-9a61-efef948ad7bd","name":"Required Number Guests","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listAvailable?hotelId=&rate=ota&checkIn=20270315&checkOut=20270321","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listAvailable"],"query":[{"key":"hotelId","value":"","description":"Specify which hotel(s) you wish to query. This parameter may be specified multiple times."},{"key":"checkIn","value":"","description":"Specify the check-in date. Format: yyyyMMdd","type":"text","disabled":true},{"key":"checkOut","value":"","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.","type":"text","disabled":true},{"key":"numberGuests","value":"","description":"Specify the number of guests in the group","type":"text","disabled":true},{"key":"excludeConditionsNotMet","value":"","description":"Optional: Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions.","type":"text","disabled":true},{"key":"discountCode","value":"","description":"Optional: Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount.","type":"text","disabled":true},{"key":"rate","value":"ota","type":"text"},{"key":"checkIn","value":"20270315"},{"key":"checkOut","value":"20270321"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide number of guests.\"\n}"},{"id":"d720b9ac-dcb4-4ecc-a21f-2afd1a5355cb","name":"Invalid Check In Date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listAvailable?hotelId=&rate=ota&checkIn=20180315&checkOut=20180321&numberGuests=4","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listAvailable"],"query":[{"key":"hotelId","value":"","description":"Specify which hotel(s) you wish to query. This parameter may be specified multiple times."},{"key":"checkIn","value":"","description":"Specify the check-in date. Format: yyyyMMdd","type":"text","disabled":true},{"key":"checkOut","value":"","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.","type":"text","disabled":true},{"key":"numberGuests","value":"","description":"Specify the number of guests in the group","type":"text","disabled":true},{"key":"excludeConditionsNotMet","value":"","description":"Optional: Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions.","type":"text","disabled":true},{"key":"discountCode","value":"","description":"Optional: Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount.","type":"text","disabled":true},{"key":"rate","value":"ota","type":"text"},{"key":"checkIn","value":"20180315"},{"key":"checkOut","value":"20180321"},{"key":"numberGuests","value":"4"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide a future check in date.\"\n}"},{"id":"e3625e5b-808c-40d0-89e6-0929cb9fc664","name":"Invalid Date Range","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listAvailable?hotelId=&rate=ota&checkIn=20270315&checkOut=20270313&numberGuests=4","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listAvailable"],"query":[{"key":"hotelId","value":"","description":"Specify which hotel(s) you wish to query. This parameter may be specified multiple times."},{"key":"checkIn","value":"","description":"Specify the check-in date. Format: yyyyMMdd","type":"text","disabled":true},{"key":"checkOut","value":"","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.","type":"text","disabled":true},{"key":"numberGuests","value":"","description":"Specify the number of guests in the group","type":"text","disabled":true},{"key":"excludeConditionsNotMet","value":"","description":"Optional: Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions.","type":"text","disabled":true},{"key":"discountCode","value":"","description":"Optional: Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount.","type":"text","disabled":true},{"key":"rate","value":"ota","type":"text"},{"key":"checkIn","value":"20270315"},{"key":"checkOut","value":"20270313"},{"key":"numberGuests","value":"4"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide valid date range.\"\n}"}],"_postman_id":"246e9071-a2c8-4937-8b47-1625a8897f26"},{"name":"List Image","id":"78ae8d68-9681-459e-8330-44beddb0c091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listImage","description":"<p>This API allows you to retrieve images for specified hotelIds, returning the image links for the hotels and their associated room types.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>strring</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>hotels</td>\n<td>array</td>\n<td>List of hotels with their images.</td>\n</tr>\n<tr>\n<td>hotels[].hotelId</td>\n<td>string</td>\n<td>The ID of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].hotelImages</td>\n<td>map</td>\n<td>A map where each key is a simple label (e.g., hero01, main01, main02, etc.), and the value is the URL link to an image of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes</td>\n<td>array</td>\n<td>List of room types within a hotel and their images.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[] .roomTypeId</td>\n<td>string</td>\n<td>The ID of the room type.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[] .roomTypeImages</td>\n<td>map</td>\n<td>A map where each key is a simple label (e.g., hero01, main01, main02, etc.), and the value is the URL link to an image of the room type.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["listImage"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels.</p>\n","type":"text/plain"},"key":"hotelId","value":""}],"variable":[]}},"response":[{"id":"6cb2a6d7-b7f4-48bb-88af-8f2b09897dda","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listImage?hotelId=ff8081811b103444011b10344bb30001&hotelId=402881874100bd9a014100c29f850001","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listImage"],"query":[{"key":"hotelId","value":"ff8081811b103444011b10344bb30001","description":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."},{"key":"hotelId","value":"402881874100bd9a014100c29f850001","description":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"Success\": true,\n    \"failureMessage\": null,\n    \"posId\": \"ff8081811b0af2d8011b0af2e0430001\",\n    \"hotels\": [\n        {\n            \"hotelId\": \"ff8081811b103444011b10344c090002\",\n            \"hotelImages\": {\n                \"hero01\": \"https://dh1msuk8kbcis.cloudfront.net/0_img/vdr/thumb/block_2_furano_mountain_164120.jpg\"\n            },\n            \"roomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811c21f6e4011c2203facd0007\",\n                    \"roomTypeImages\": {\n                        \"main01\": \"https://dh1msuk8kbcis.cloudfront.net/ff8081811c21f6e4011c2203facd0007_682212.jpg\"\n                    }\n                },\n                {\n                    \"roomTypeId\": \"ff8081811c21f6e4011c22043c390008\"\n                }\n            ]\n        },\n        {\n            \"hotelId\": \"ff8081811b103444011b10344bb30001\",\n            \"hotelImages\": {\n                \"hero01\": \"https://dh1msuk8kbcis.cloudfront.net/0_img/vdr/thumb/block_1_niseko_228878.jpg\",\n                \"main01\": \"https://dh1msuk8kbcis.cloudfront.net/block_1_niseko_hirafu_785904.jpg\",\n                \"main02\": \"https://dh1msuk8kbcis.cloudfront.net/block_1_niseko_hirafu_689044.jpg\",\n                \"main03\": \"https://dh1msuk8kbcis.cloudfront.net/block_1_niseko_hirafu_261291.jpg\"\n            },\n            \"roomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811c21f6e4011c220306020001\"\n                },\n                {\n                    \"roomTypeId\": \"ff80818132ecdff00132ecf4f94b0001\"\n                },\n                {\n                    \"roomTypeId\": \"ff8081811c21f6e4011c2203591d0002\"\n                }\n            ]\n        }\n    ]\n}"},{"id":"e137d636-59a2-4583-a0cb-767a71df2ae6","name":"Invalid Hotel ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listImage?hotelId=","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listImage"],"query":[{"key":"hotelId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide at least 1 hotel ID.\"\n}"}],"_postman_id":"78ae8d68-9681-459e-8330-44beddb0c091"},{"name":"List Text","id":"e77f793e-65a3-4cd3-b013-65603eadaf6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listDescription","description":"<p>This API allows you to fetch hotel descriptions, room type names, and room type descriptions in the selected language for the specified hotels.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>hotels</td>\n<td>array</td>\n<td>List of hotels with their images.</td>\n</tr>\n<tr>\n<td>hotels[].hotelId</td>\n<td>string</td>\n<td>The ID of the hotel.</td>\n</tr>\n<tr>\n<td>hotels[].hotelName</td>\n<td>map</td>\n<td>The name of the hotel. This is provided in only one language. Therefore, changing the language parameter will not affect the hotel name.</td>\n</tr>\n<tr>\n<td>hotels[].hotelDescription</td>\n<td>map</td>\n<td>Hotel description. Text providing a brief overview or introduction. *</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes</td>\n<td>array</td>\n<td>List of room types within a hotel and their localized name and description.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[] .roomTypeId</td>\n<td>string</td>\n<td>The ID of the room type.</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[] .roomTypeName</td>\n<td>map</td>\n<td>Room type name. *</td>\n</tr>\n<tr>\n<td>hotels[].roomTypes[] .roomTypeDescription</td>\n<td>map</td>\n<td>Room type description. Text providing a brief overview or introduction. *</td>\n</tr>\n</tbody>\n</table>\n</div><ul>\n<li>Localised content (*): If available, text for this field will be returned in the language specified by the lang parameter. If unavailable, English text will be returned.</li>\n</ul>\n","urlObject":{"path":["listDescription"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels.</p>\n","type":"text/plain"},"key":"hotelId","value":""},{"disabled":true,"description":{"content":"<p>Specify the language to return. Legal values are {\"en\",\"ja\",\"fr\",\"zh-cn\",\"zh\",\"ko\"}.\nNote the hotel name has entered in just 1 language; value won't change as the local parameter is changed. (We should address this in the future.)\nNote it will return English text if there is no text for the selected language.\n</p>\n","type":"text/plain"},"key":"locale","value":""}],"variable":[]}},"response":[{"id":"71dfbcd7-a0b1-487f-8d6b-7d603954f26b","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listDescription?hotelId=ff8081811b103444011b10344bb30001&hotelId=402881874100bd9a014100c29f850001&locale=en","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listDescription"],"query":[{"key":"hotelId","value":"ff8081811b103444011b10344bb30001","description":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."},{"key":"hotelId","value":"402881874100bd9a014100c29f850001","description":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."},{"key":"locale","value":"en","description":"Specify the language to return. Legal values are {\"en\",\"ja\",\"fr\",\"zh-cn\",\"zh\",\"ko\"}.\nNote the hotel name has entered in just 1 language; value won't change as the local parameter is changed. (We should address this in the future.)\nNote it will return English text if there is no text for the selected language.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"posId\": \"ff8081811b0af2d8011b0af2e0430001\",\n    \"locale\": \"en\",\n    \"hotels\": [\n        {\n            \"hotelId\": \"ff8081811b103444011b10344bb30001\",\n            \"hotelName\": \"Block 1\",\n            \"hotelDescription\": \"Yama Shizen has 39 apartments, ranging in size from Studio Rooms to 3 bedroom Penthouses.  It is ideally located in upper Hirafu Village, with excellent access to the slopes, shopping, hot springs, and all the best restaurants including Yama Dining on the 1st floor which provides buffet breakfast and dinner daily during the season. Designer interiors, contemporary architecture and the latest in Q.\",\n            \"roomTypes\": [\n                {\n                    \"roomTypeId\": \"ff8081811c21f6e4011c220306020001\",\n                    \"roomTypeName\": \"2 BDR\",\n                    \"roomTypeDescription\": \"These apartments are 69 - 104 square metres in size. Each room has a full kitchen. They are available in both 2 bed 2 bath and 2 bed 1 bath configurations. Open plan Living / Dining / Kitchen, sought.\"\n                },\n                {\n                    \"roomTypeId\": \"ff80818132ecdff00132ecf4f94b0001\",\n                    \"roomTypeName\": \"2 BDR Config\",\n                    \"roomTypeDescription\": \"\"\n                },\n                {\n                    \"roomTypeId\": \"ff8081811c21f6e4011c2203591d0002\",\n                    \"roomTypeName\": \"3 BDR\",\n                    \"roomTypeDescription\": \"These apartments are 120 - 127 square metres in size. Each room has a full kitchen. They are available in both 3 bed 2 bath and 3 bed 3 bath configurations. Open plan Living / Dining / Kitchen, sauce.\"\n                }\n            ]\n        }\n    ]\n}"},{"id":"7fb39729-4dc8-4b8a-bfa2-9181256b5590","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listDescription?hotelId=","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listDescription"],"query":[{"key":"hotelId","value":"","description":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."},{"key":"locale","value":"","description":"Specify the language to return. Legal values are {\"en\",\"ja\",\"fr\",\"zh-cn\",\"zh\",\"ko\"}.\nNote the hotel name has entered in just 1 language; value won't change as the local parameter is changed. (We should address this in the future.)\nNote it will return English text if there is no text for the selected language.\n","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide at least 1 hotel ID.\"\n}"}],"_postman_id":"e77f793e-65a3-4cd3-b013-65603eadaf6d"},{"name":"List Rate Plan Description","id":"6e5fb768-22ee-4e57-8a62-d23d25dde1d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listRatePlanDescription","description":"<p>Fetch all rate plan descriptions for OTA style rate plans.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>vendorId</td>\n<td>string</td>\n<td>The ID of the hotel.</td>\n</tr>\n<tr>\n<td>ratePlanDescriptionList</td>\n<td>array</td>\n<td>List of the hotel's rate plans with their localized descriptions.</td>\n</tr>\n<tr>\n<td>ratePlanDescriptionList[] .ratePlanId</td>\n<td>string</td>\n<td>The ID of the rate plan.</td>\n</tr>\n<tr>\n<td>ratePlanDescriptionList[] .names</td>\n<td>map</td>\n<td>A mapping of locale codes to their corresponding localized rate plan names.</td>\n</tr>\n<tr>\n<td>ratePlanDescriptionList[] .descriptions</td>\n<td>map</td>\n<td>A mapping of locale codes to their corresponding localized rate plan descriptions.</td>\n</tr>\n<tr>\n<td>ratePlanDescriptionList[] .longDescriptions</td>\n<td>map</td>\n<td>A mapping of locale codes to their corresponding localized rate plan long descriptions.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["listRatePlanDescription"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify which hotel(s) you wish to receive rate plan descriptions for. This parameter may be specified multiple times to receive rate plan description for multiple hotels.</p>\n","type":"text/plain"},"key":"hotelId","value":""}],"variable":[]}},"response":[{"id":"175eca99-9774-4545-a2fe-423be5873a2a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listRatePlanDescription?hotelId=ff8081811b103444011b10344bb30001&hotelId=402881874100bd9a014100c29f850001","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listRatePlanDescription"],"query":[{"key":"hotelId","value":"ff8081811b103444011b10344bb30001","description":"Specify which hotel(s) you wish to receive rate plan descriptions for. This parameter may be specified multiple times to receive rate plan description for multiple hotels."},{"key":"hotelId","value":"402881874100bd9a014100c29f850001","description":"Specify which hotel(s) you wish to receive rate plan descriptions for. This parameter may be specified multiple times to receive rate plan description for multiple hotels."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"vendorId\": \"ff8081811b103444011b10344bb30001\",\n    \"ratePlanDescriptionList\": [\n        {\n            \"ratePlanId\": 10001,\n            \"names\": {\n                \"en\": \"Flexible Rate - Direct Booking\",\n                \"ja\": \"フレックスレート\"\n            },\n            \"descriptions\": {\n                \"en\": \"Flexible Rate\",\n                \"ja\": \"フレックスレート\"\n            },\n            \"longDescriptions\": {\n                \"en\": \"Long Description in English\",\n                \"ja\": \"Long Description in Japanese\"\n            }\n        },\n        {\n            \"ratePlanId\": 10022,\n            \"names\": {\n                \"en\": \"Flexible Rate - No meals\",\n                \"ja\": \"フレックスレート\"\n            },\n            \"descriptions\": {\n                \"en\": \"Flexible Rate -  No meals\",\n                \"ja\": \"フレックスレート\"\n            },\n            \"longDescriptions\": {\n                \"en\": \"Long Description in English\",\n                \"ja\": \"Long Description in Japanese\"\n            }\n        }\n    ]\n}"}],"_postman_id":"6e5fb768-22ee-4e57-8a62-d23d25dde1d7"}],"id":"9df11131-15d1-4a39-8a53-9b7bbe3998fd","_postman_id":"9df11131-15d1-4a39-8a53-9b7bbe3998fd","description":""},{"name":"Bookings","item":[{"name":"Create Booking","id":"a66bee3b-ff17-4fb2-a35a-e61c31666fb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/createBooking","description":"<blockquote>\n<p>⚠️ <strong>Important</strong><br />This method is deprecated. We recommend using the POST version of Create Booking. </p>\n</blockquote>\n<p>This method allows you to create a new booking for one or more rooms.</p>\n<p>The ability to make bookings via this method mirrors what a user of the account can do from a widget like book &amp; pay or Order02. This includes checks such as:</p>\n<ul>\n<li><p><strong>Minimum nights</strong>: Minimum nights will be enforced for REQUEST INTERNAL, REQUEST or RESERVATION if an agent booking; or for RESERVATIONS if a direct booking.</p>\n</li>\n<li><p><strong>Request/Reservation Window</strong>: The request or reservation window will be enforced for both direct and agent bookings. For instance, if the vendor settings state that a direct RESERVATION can only be made 2 days or more from the check-in date, this is enforced.</p>\n</li>\n</ul>\n<p>Creating a booking also triggers the creation of invoices if an invoice strategy exists. An invoice strategy is necessary if one wishes to create an end-to-end flow using the REST API- from creating a booking to accepting payment for the same.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>order</td>\n<td>object</td>\n<td>Object containing package information, including package bookings, package guests, and package invoice details.</td>\n</tr>\n<tr>\n<td>order.posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>order.leadGuest</td>\n<td>array</td>\n<td>Guest details. The lead guest of the primary booking in the package.</td>\n</tr>\n<tr>\n<td>order.bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>order.invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookings\">Package Bookings</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>bookings[].eid</td>\n<td>number</td>\n<td>The human-readable booking ID. E.g \"100000\".</td>\n</tr>\n<tr>\n<td>bookings[].customId</td>\n<td>string</td>\n<td>Optional custom ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingId</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].active</td>\n<td>boolean</td>\n<td>The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false).</td>\n</tr>\n<tr>\n<td>bookings[].extent</td>\n<td>string</td>\n<td>The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>bookings[].createdDate</td>\n<td>string</td>\n<td>The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].createdUser</td>\n<td>string</td>\n<td>The name of the user who created the booking.</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedDate</td>\n<td>string</td>\n<td>The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedUser</td>\n<td>string</td>\n<td>The name of the user who made the most recent modification to the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingType</td>\n<td>string</td>\n<td>Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingSource</td>\n<td>string</td>\n<td>The company name of the booking source.</td>\n</tr>\n<tr>\n<td>bookings[].notes</td>\n<td>string</td>\n<td>Booking note. Max. character length:  4096.</td>\n</tr>\n<tr>\n<td>bookings[].guestIntranetUrl</td>\n<td>string</td>\n<td>The Guest Intranet page URL for the booking.</td>\n</tr>\n<tr>\n<td>bookings[].hotel</td>\n<td>object</td>\n<td>Details of the hotel associated with the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead.</td>\n</tr>\n<tr>\n<td>bookings[].items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>bookings[].roomStatus</td>\n<td>string</td>\n<td>The room status of a booking. Indicates whether the booking is a standard reservation or a blocked date. Possible values: STD (standard), OOS (blocked date), OOO (blocked date)</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookingitems\">Package Booking Items</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>items[].roomType</td>\n<td>string</td>\n<td>Details of the room type associated with the booking.</td>\n</tr>\n<tr>\n<td>items[].checkIn</td>\n<td>string</td>\n<td>The check-in date for the booking item.</td>\n</tr>\n<tr>\n<td>items[].checkOut</td>\n<td>string</td>\n<td>The check-out date for the booking item.</td>\n</tr>\n<tr>\n<td>items[].numberGuests</td>\n<td>number</td>\n<td>The number of guests of a room in a booking.</td>\n</tr>\n<tr>\n<td>items[].priceRetail</td>\n<td>number</td>\n<td>The gross price of the room type.</td>\n</tr>\n<tr>\n<td>items[].priceRack</td>\n<td>number</td>\n<td>The gross price after price adjustments.</td>\n</tr>\n<tr>\n<td>items[].priceNet</td>\n<td>number</td>\n<td>The gross price after commission.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackageinvoicepayments\">Package Invoice Payments</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceNumber</td>\n<td>string</td>\n<td>The human-readable invoice number, suffix increments with each invoice. E.g \"100000-1\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceId</td>\n<td>string</td>\n<td>Unique identifier of the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDate</td>\n<td>string</td>\n<td>The date the invoice was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceAmount</td>\n<td>number</td>\n<td>The amount billed on the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceDueDate</td>\n<td>string</td>\n<td>The date the invoice is due. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceCreatedDate</td>\n<td>string</td>\n<td>The date the invoice was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceModifiedDate</td>\n<td>string</td>\n<td>The date the invoice was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceNotes</td>\n<td>string</td>\n<td>Invoice note. Max. character length:  128.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentId</td>\n<td>string</td>\n<td>Payment ID registered on the invoice payment. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentDate</td>\n<td>string</td>\n<td>The date the invoice payment was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentAmount</td>\n<td>number</td>\n<td>The amount of the invoice payment.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentMethod</td>\n<td>string</td>\n<td>The type of payment method. See \"Payment Methods\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentCreatedDate</td>\n<td>string</td>\n<td>The date the invoice payment was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentModifiedDate</td>\n<td>string</td>\n<td>The date the invoice payment was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentNotes</td>\n<td>string</td>\n<td>Payment note. Max. character length:  128.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsevalidationerrors\">Response Validation Errors</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Error Message</strong></th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Please provide a valid hotel ID</td>\n<td>The request is missing a valid hotelId. A valid hotel identifier must be provided.</td>\n</tr>\n<tr>\n<td>Please provide at least one room type.</td>\n<td>The booking request must include at least one roomType.</td>\n</tr>\n<tr>\n<td>The requested room types must belong to the same vendor.</td>\n<td>All selected roomTypes must be from the same hotel to proceed with the booking.</td>\n</tr>\n<tr>\n<td>The booking extent can only be REQUEST or RESERVATION for vendor/portal bookings.</td>\n<td>For vendor or portal bookings, REQUEST_INTERNAL booking extent is not allowed.</td>\n</tr>\n<tr>\n<td>The booking extent RESERVATION is not enabled for portal bookings</td>\n<td>Portal bookings do not support the RESERVATION extent type for this hotel.</td>\n</tr>\n<tr>\n<td>The booking extent can only be REQUEST, REQUEST_INTERNAL or RESERVATION.</td>\n<td>The provided bookingExtent value is invalid. It must be one of: REQUEST, REQUEST_INTERNAL, or RESERVATION.</td>\n</tr>\n<tr>\n<td>One of the selected room types is currently inactive.</td>\n<td>At least one of the chosen roomTypes is inactive and cannot be booked.</td>\n</tr>\n<tr>\n<td>One or more of the requested room types cannot be booked due to the lack of permissions by the vendor.</td>\n<td>The agent does not have the required permissions to book one or more of the selected roomTypes.</td>\n</tr>\n<tr>\n<td>The number of check-in dates provided does not match the number of room types.</td>\n<td>The number of checkInDates should align with the number of roomTypes in the request.</td>\n</tr>\n<tr>\n<td>The number of check-out dates provided does not match the number of room types.</td>\n<td>The number of checkOutDatesshould align with the number of roomTypes.</td>\n</tr>\n<tr>\n<td>The number of guest head counts provided does not match the number of room types.</td>\n<td>The total guest count (numberGuests) should align with the number of roomTypes in the booking.</td>\n</tr>\n<tr>\n<td>The number of maximum retail prices provided does not match the number of room types.</td>\n<td>The number of priceRetailMax values should align with the number of roomTypes.</td>\n</tr>\n<tr>\n<td>Please provide the guest's given name</td>\n<td>The booking request must include guestGivenName.</td>\n</tr>\n<tr>\n<td>Please provide the guest's family name</td>\n<td>The booking request must include guestFamilyName.</td>\n</tr>\n<tr>\n<td>The check-in date must be at least day(s) in advance.</td>\n<td>The checkInDate must be set at least X days in advance.</td>\n</tr>\n<tr>\n<td>One of the given check-in dates was of an invalid format. Please follow the yyyyMMdd format. (ex. 19700101)</td>\n<td>A checkInDate is incorrectly formatted. It should follow the yyyyMMdd format.</td>\n</tr>\n<tr>\n<td>One of the given check-out dates was of an invalid format. Please follow the yyyyMMdd format. (ex. 19700101)</td>\n<td>A checkOutDate is incorrectly formatted. It should follow the yyyyMMdd format.</td>\n</tr>\n<tr>\n<td>Maximum booking duration is 180 nights</td>\n<td>The stay duration cannot exceed 180 nights.</td>\n</tr>\n<tr>\n<td>Please provide number of adults in each room.</td>\n<td>If hotel.recordGuestType is enabled, the request must specify numberAdults for each roomType.</td>\n</tr>\n<tr>\n<td>Please provide number of children in each room.</td>\n<td>If hotel.recordGuestType is enabled, the request must specify numberChildren for each roomType.</td>\n</tr>\n<tr>\n<td>Please provide number of infants in each room.</td>\n<td>If hotel.recordGuestType is enabled, the request must specify numberInfants for each roomType.</td>\n</tr>\n<tr>\n<td>The room type can hold a maximum of guests only.</td>\n<td>The total numberGuests exceeds the maximum allowed capacity (maxNumberGuests) for the roomType.</td>\n</tr>\n<tr>\n<td>Total number of guests differs from total number of adults and number of children</td>\n<td>If hotel.recordGuestType is enabled, the sum of numberAdults and numberChildren must equal numberGuests.</td>\n</tr>\n<tr>\n<td>The guest gender is invalid. Please choose between MALE, FEMALE or OTHER.</td>\n<td>The provided guest gender value is invalid and must be MALE, FEMALE, or OTHER.</td>\n</tr>\n<tr>\n<td>The guest nationality is invalid. Please use the ISO 3166 country codes.</td>\n<td>The guest nationality (country) value must follow the ISO 3166 country code format.</td>\n</tr>\n<tr>\n<td>The guest date of birth was of an invalid format. Please follow the yyyyMMdd format. (ex. 19700101)</td>\n<td>The guest date of birth (dob) must be in the yyyyMMdd format.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["createBooking"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional.</p>\n","type":"text/plain"},"key":"customId","value":""},{"disabled":true,"description":{"content":"<p>Specify the hotel ID of the hotel.</p>\n","type":"text/plain"},"key":"hotelId","value":""},{"disabled":true,"description":{"content":"<p>Specify the room type of the first room to book.</p>\n","type":"text/plain"},"key":"roomTypeId","value":""},{"disabled":true,"description":{"content":"<p>This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids.</p>\n","type":"text/plain"},"key":"ratePlanId","value":""},{"disabled":true,"description":{"content":"<p>Specify the check-in date of a room in the booking. Format: yyyyMMdd</p>\n","type":"text/plain"},"key":"checkIn","value":""},{"disabled":true,"description":{"content":"<p>Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.</p>\n","type":"text/plain"},"key":"checkOut","value":""},{"disabled":true,"description":{"content":"<p>Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n</p>\n","type":"text/plain"},"key":"numberGuests","value":""},{"disabled":true,"description":{"content":"<p>Specifies the number of adults of a room in the booking. If recordGuestType is enabled, this parameter must be set as 1 or more, and may not exceed the maxNumberGuests or maxNumberAdults of the room type.</p>\n","type":"text/plain"},"key":"numberAdults","value":""},{"disabled":true,"description":{"content":"<p>Specifies the number of children of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberChildren of the room type.</p>\n","type":"text/plain"},"key":"numberChildren","value":""},{"disabled":true,"description":{"content":"<p>Specifies the number of infants of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberInfants of the room type.</p>\n","type":"text/plain"},"key":"numberInfants","value":""},{"disabled":true,"description":{"content":"<p>The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing.</p>\n","type":"text/plain"},"key":"priceRetailMax","value":""},{"disabled":true,"description":{"content":"<p>The given name / first name of the lead guest.</p>\n","type":"text/plain"},"key":"guestGivenName","value":""},{"disabled":true,"description":{"content":"<p>The family name / last name of the lead guest.</p>\n","type":"text/plain"},"key":"guestFamilyName","value":""},{"disabled":true,"description":{"content":"<p>Must be `ota` and indicates new OTA style rate plans should be used.</p>\n","type":"text/plain"},"key":"rate","value":""},{"disabled":true,"description":{"content":"<p>Optional: The email address of the lead guest. This parameter is optional.</p>\n","type":"text/plain"},"key":"guestEmail","value":""},{"disabled":true,"description":{"content":"<p>Optional: The extent of the booking. Can be REQUEST_INTERNAL, REQUEST, RESERVATION. This parameter is optional; the default is assumed to be RESERVATION. The booking extent cannot be set to REQUEST_INTERNAL if it is a direct booking.</p>\n","type":"text/plain"},"key":"bookingExtent","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the Widget URL of the booking. This is useful to store a URL with the booking to determine its source.</p>\n","type":"text/plain"},"key":"widgetUrl","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which allows the use of a discount code for the booking. If the discount code is invalid, then the booking is created without the application of the discount. No specific feedback is shown at present to determine if the discount code was successfully used or not.</p>\n","type":"text/plain"},"key":"discountCode","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss.</p>\n","type":"text/plain"},"key":"comment","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER.</p>\n","type":"text/plain"},"key":"gender","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)</p>\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API.</p>\n","type":"text/plain"},"key":"dob","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the contact number of the guest.</p>\n","type":"text/plain"},"key":"contactNumber","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the postcode of the guest.</p>\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest.</p>\n","type":"text/plain"},"key":"adminRegion","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the city of the guest.</p>\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the address line 1 of the guest.</p>\n","type":"text/plain"},"key":"address1","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the address line 2 of the guest.</p>\n","type":"text/plain"},"key":"address2","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the locale language of the guest.</p>\n","type":"text/plain"},"key":"lang","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the dietary restrictions of the guest.</p>\n","type":"text/plain"},"key":"dietRestrictions","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the emergency contact name of the guest</p>\n","type":"text/plain"},"key":"emContactName","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the emergency contact number of the guest.</p>\n","type":"text/plain"},"key":"emContactTel","value":""},{"disabled":true,"description":{"content":"<p>Optional: Control sending of the \"new booking created\" auto email: Null / not provided - send based on account settings; True - send (overriding account settings); False - don't send (overriding account settings)</p>\n","type":"text/plain"},"key":"emailSendOverride","value":""}],"variable":[]}},"response":[{"id":"075b2c30-0448-4ac7-8d9e-20a3e83b6797","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?hotelId=f808ad963f54211d013f65b88d7b35a9&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789&rate=ota&ratePlanId=432872&customId=RGB8007457&roomTypeId=2c98902a54bb76cc0154cba342c34378&numberGuests=3&priceRetailMax=28000&checkIn=20260327&checkOut=20260329","protocol":"https","host":["api","roomboss","com"],"path":["extws","hotel","v1","createBooking"],"query":[{"key":"hotelId","value":"f808ad963f54211d013f65b88d7b35a9","description":"Specify the hotel ID of the hotel."},{"key":"numberAdults","value":"","description":"Specifies the number of adults of a room in the booking. If recordGuestType is enabled, this parameter must be set as 1 or more, and may not exceed the maxNumberGuests or maxNumberAdults of the room type.","disabled":true},{"key":"numberChildren","value":"","description":"Specifies the number of children of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberChildren of the room type.","disabled":true},{"key":"numberInfants","value":"","description":"Specifies the number of infants of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberInfants of the room type.","disabled":true},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"bookingExtent","value":"","description":"Optional: The extent of the booking. Can be REQUEST_INTERNAL, REQUEST, RESERVATION. This parameter is optional; the default is assumed to be RESERVATION. The booking extent cannot be set to REQUEST_INTERNAL if it is a direct booking.","disabled":true},{"key":"widgetUrl","value":"","description":"Optional: This is an optional parameter which sets the Widget URL of the booking. This is useful to store a URL with the booking to determine its source.","disabled":true},{"key":"discountCode","value":"","description":"Optional: This is an optional parameter which allows the use of a discount code for the booking. If the discount code is invalid, then the booking is created without the application of the discount. No specific feedback is shown at present to determine if the discount code was successfully used or not.","disabled":true},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."},{"key":"rate","value":"ota","description":"Must be `ota` and indicates new OTA style rate plans should be used."},{"key":"ratePlanId","value":"432872","description":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids."},{"key":"customId","value":"RGB8007457","description":"Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"roomTypeId","value":"2c98902a54bb76cc0154cba342c34378","description":"Specify the room type of the first room to book."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"checkIn","value":"20260327","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20260329","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"order\": {\n        \"posId\": \"4028808c11f7ee4d0111f7ee55980001\",\n        \"leadGuest\": {\n            \"title\": null,\n            \"guestId\": null,\n            \"givenName\": \"Will\",\n            \"familyName\": \"Werdsworth\",\n            \"email\": \"willwerds8253b@gmail.com\",\n            \"additionalEmail\": null,\n            \"gender\": \"MALE\",\n            \"nationality\": \"AG\",\n            \"age\": 0,\n            \"phoneNumber\": \"81123456789\",\n            \"dateOfBirth\": \"1950-01-02\",\n            \"height\": null,\n            \"weight\": null,\n            \"postcode\": \"044-0123\",\n            \"administrativeRegion\": \"Hokkaido\",\n            \"city\": \"Kutchan\",\n            \"address1\": \"29, Wallaby Way\",\n            \"address2\": \"Central Business District\",\n            \"language\": \"JA\",\n            \"dietaryRestrictions\": \"Vegetarian and no nuts\",\n            \"emergencyContactName\": \"Parry Hotter\",\n            \"emergencyContactTel\": \"81123456789\",\n            \"medicalIssues\": null\n        },\n        \"bookings\": [\n            {\n                \"eId\": 2596464,\n                \"customId\": \"RGB8007457\",\n                \"bookingId\": \"8a80818a9ae0553b019ae33b429d075b\",\n                \"active\": true,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": null,\n                \"items\": [\n                    {\n                        \"endDate\": 1774742400000,\n                        \"priceRetail\": 20000.0,\n                        \"priceRack\": 20000.0,\n                        \"priceNet\": 20000.0,\n                        \"priceSell\": 0.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9ae0553b019ae33b429d075d\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-27\",\n                        \"checkOut\": \"2026-03-29\",\n                        \"arrivalTime\": null,\n                        \"departureTime\": null,\n                        \"numberGuests\": 3,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": null,\n                        \"checkedOut\": null,\n                        \"roomNote\": null,\n                        \"ratePlan\": null,\n                        \"productOptions\": null\n                    }\n                ],\n                \"createdDate\": \"2025-12-03T08:01:42.945+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": null,\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": null,\n                \"notes\": \"testComment\",\n                \"discountCode\": null,\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            }\n        ],\n        \"invoicePayments\": [\n            {\n                \"invoiceNumber\": \"2596464-1-WEB\",\n                \"invoiceId\": \"8a80818a9ae0553b019ae33b44760769\",\n                \"invoiceDate\": \"2025-12-03\",\n                \"invoiceAmount\": 4000.0,\n                \"invoiceDueDate\": \"2025-12-03\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            },\n            {\n                \"invoiceNumber\": \"2596464-2-WEB\",\n                \"invoiceId\": \"8a80818a9ae0553b019ae33b44c1076c\",\n                \"invoiceDate\": \"2025-12-03\",\n                \"invoiceAmount\": 16000.0,\n                \"invoiceDueDate\": \"2025-12-31\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            }\n        ]\n    }\n}"},{"id":"21cd0d73-efa4-43f8-beb5-71c910b9a163","name":"Success - Multiple Rooms","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?numberGuests=3&priceRetailMax=28000&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789&customId=RGB8007456&roomTypeId=2c98902a54bb76cc0154cba342c34378&hotelId=f808ad963f54211d013f65b88d7b35a9&checkIn=20260322&checkOut=20260326&roomTypeId=f808ad963f54211d013f65b88d7b35aa&checkIn=20260322&checkOut=20260326&numberGuests=1&rate=ota&ratePlanId=432872&ratePlanId=432872","protocol":"https","host":["api","roomboss","com"],"path":["extws","hotel","v1","createBooking"],"query":[{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."},{"key":"customId","value":"RGB8007456","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"roomTypeId","value":"2c98902a54bb76cc0154cba342c34378","description":"Specify the room type of the first room to book."},{"key":"hotelId","value":"f808ad963f54211d013f65b88d7b35a9","description":"Specify the hotel ID of the hotel."},{"key":"checkIn","value":"20260322","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20260326","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"roomTypeId","value":"f808ad963f54211d013f65b88d7b35aa","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20260322","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20260326","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"1","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"rate","value":"ota","description":"Must be `ota` and indicates new OTA style rate plans should be used."},{"key":"ratePlanId","value":"432872","description":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids."},{"key":"ratePlanId","value":"432872","description":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"order\": {\n        \"posId\": \"4028808c11f7ee4d0111f7ee55980001\",\n        \"leadGuest\": {\n            \"title\": null,\n            \"guestId\": null,\n            \"givenName\": \"Will\",\n            \"familyName\": \"Werdsworth\",\n            \"email\": \"willwerds8253b@gmail.com\",\n            \"additionalEmail\": null,\n            \"gender\": \"MALE\",\n            \"nationality\": \"AG\",\n            \"age\": 0,\n            \"phoneNumber\": \"81123456789\",\n            \"dateOfBirth\": \"1950-01-02\",\n            \"height\": null,\n            \"weight\": null,\n            \"postcode\": \"044-0123\",\n            \"administrativeRegion\": \"Hokkaido\",\n            \"city\": \"Kutchan\",\n            \"address1\": \"29, Wallaby Way\",\n            \"address2\": \"Central Business District\",\n            \"language\": \"JA\",\n            \"dietaryRestrictions\": \"Vegetarian and no nuts\",\n            \"emergencyContactName\": \"Parry Hotter\",\n            \"emergencyContactTel\": \"81123456789\",\n            \"medicalIssues\": null\n        },\n        \"bookings\": [\n            {\n                \"eId\": 2596456,\n                \"customId\": \"RGB8007456\",\n                \"bookingId\": \"8a80818a9ae0553b019ae3395db506b1\",\n                \"active\": true,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": null,\n                \"items\": [\n                    {\n                        \"endDate\": 1774483200000,\n                        \"priceRetail\": 40000.0,\n                        \"priceRack\": 40000.0,\n                        \"priceNet\": 40000.0,\n                        \"priceSell\": 0.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9ae0553b019ae3395db506b3\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-22\",\n                        \"checkOut\": \"2026-03-26\",\n                        \"arrivalTime\": null,\n                        \"departureTime\": null,\n                        \"numberGuests\": 3,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": null,\n                        \"checkedOut\": null,\n                        \"roomNote\": null,\n                        \"ratePlan\": null,\n                        \"productOptions\": null\n                    },\n                    {\n                        \"endDate\": 1774483200000,\n                        \"priceRetail\": 40000.0,\n                        \"priceRack\": 40000.0,\n                        \"priceNet\": 40000.0,\n                        \"priceSell\": 0.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9ae0553b019ae3395db506b9\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-22\",\n                        \"checkOut\": \"2026-03-26\",\n                        \"arrivalTime\": null,\n                        \"departureTime\": null,\n                        \"numberGuests\": 1,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": null,\n                        \"checkedOut\": null,\n                        \"roomNote\": null,\n                        \"ratePlan\": null,\n                        \"productOptions\": null\n                    }\n                ],\n                \"createdDate\": \"2025-12-03T07:59:38.862+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": null,\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": null,\n                \"notes\": \"testComment\",\n                \"discountCode\": null,\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            }\n        ],\n        \"invoicePayments\": [\n            {\n                \"invoiceNumber\": \"2596456-1-WEB\",\n                \"invoiceId\": \"8a80818a9ae0553b019ae339602906ce\",\n                \"invoiceDate\": \"2025-12-03\",\n                \"invoiceAmount\": 16000.0,\n                \"invoiceDueDate\": \"2025-12-03\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            },\n            {\n                \"invoiceNumber\": \"2596456-2-WEB\",\n                \"invoiceId\": \"8a80818a9ae0553b019ae339607406d1\",\n                \"invoiceDate\": \"2025-12-03\",\n                \"invoiceAmount\": 64000.0,\n                \"invoiceDueDate\": \"2025-12-31\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            }\n        ]\n    }\n}"},{"id":"aa54e4ca-867a-43d9-aa1f-051f288bf07e","name":"Validation Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270321&numberGuests=3&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the hotel ID of the hotel."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide a valid hotel ID\"\n}"},{"id":"d0e984d8-b2bd-416f-997e-c634ecdcced2","name":"Unset Rates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&hotelID=ff8081811b103444011b10344bb30001&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20180315&checkOut=20180321&numberGuests=3&priceRetailMax=28000&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20180315&checkOut=20180321&numberGuests=1&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"hotelID","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20180315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20180321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20180315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20180321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"1","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The booking cannot be made as rates have not been set for one or more of the specified room types for one or more of the specified periods.\"\n}"},{"id":"5e69c0f0-7f2a-468f-9742-915bcbce7caa","name":"Rate Mismatch","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&hotelID=ff8081811b103444011b10344bb30001&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270321&numberGuests=3&priceRetailMax=28000&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270321&numberGuests=1&priceRetailMax=200&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"hotelID","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"1","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"200","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The offer price was higher than the maximum retail price specified.\"\n}"},{"id":"424648e9-fe63-4599-99cf-274a190a8441","name":"Invalid Stay Length","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&hotelID=ff8081811b103444011b10344bb30001&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270315&numberGuests=3&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"hotelID","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270315","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"One or more of the booking elements should be at least 1 nights long for a RESERVATION.\"\n}"}],"_postman_id":"a66bee3b-ff17-4fb2-a35a-e61c31666fb4"},{"name":"List Booking","id":"92c47ac0-bc05-4b33-aee9-acd13b5fd869","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listBooking","description":"<p>This method allows you to list a booking, including details of the order in which it is contained.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>order</td>\n<td>object</td>\n<td>Object containing package information, including package bookings, package guests, and package invoice details.</td>\n</tr>\n<tr>\n<td>order.posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>order.leadGuest</td>\n<td>array</td>\n<td>Guest details. The lead guest of the primary booking in the package.</td>\n</tr>\n<tr>\n<td>order.bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>order.invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookings\">Package Bookings</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>bookings[].eid</td>\n<td>number</td>\n<td>The human-readable booking ID. E.g \"100000\".</td>\n</tr>\n<tr>\n<td>bookings[].customId</td>\n<td>string</td>\n<td>Optional custom ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingId</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].discountCode</td>\n<td>string</td>\n<td>The promo code applied to this booking.</td>\n</tr>\n<tr>\n<td>bookings[].active</td>\n<td>boolean</td>\n<td>The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false).</td>\n</tr>\n<tr>\n<td>bookings[].extent</td>\n<td>string</td>\n<td>The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>bookings[].createdDate</td>\n<td>string</td>\n<td>The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].createdUser</td>\n<td>string</td>\n<td>The name of the user who created the booking.</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedDate</td>\n<td>string</td>\n<td>The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedUser</td>\n<td>string</td>\n<td>The name of the user who made the most recent modification to the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingType</td>\n<td>string</td>\n<td>Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingSource</td>\n<td>string</td>\n<td>The company name of the booking source.</td>\n</tr>\n<tr>\n<td>bookings[].notes</td>\n<td>string</td>\n<td>Booking note. Max. character length:  4096.</td>\n</tr>\n<tr>\n<td>bookings[].guestIntranetUrl</td>\n<td>string</td>\n<td>The Guest Intranet page URL for the booking.</td>\n</tr>\n<tr>\n<td>bookings[].hotel</td>\n<td>object</td>\n<td>Details of the hotel associated with the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead.</td>\n</tr>\n<tr>\n<td>bookings[].serviceProvider</td>\n<td>object</td>\n<td>Details of the vendor providing the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead.</td>\n</tr>\n<tr>\n<td>bookings[].segment</td>\n<td>string</td>\n<td>The segment of the booking (e.g. agent, OTA, etc.), as determined by the system.</td>\n</tr>\n<tr>\n<td>bookings[].packageId</td>\n<td>string</td>\n<td>Identifier of the package this booking belongs to (ID of the lead booking).</td>\n</tr>\n<tr>\n<td>bookings[].leadGuest.additionalEmail</td>\n<td>string</td>\n<td>Secondary email address for the lead guest on this booking.</td>\n</tr>\n<tr>\n<td>bookings[].items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>bookings[].roomStatus</td>\n<td>string</td>\n<td>The room status of a booking. Indicates whether the booking is a standard reservation or a blocked date. Possible values: STD (standard), OOS (blocked date), OOO (blocked date)</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookingitems\">Package Booking Items</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>items[].roomType</td>\n<td>string</td>\n<td>Details of the room type associated with the booking.</td>\n</tr>\n<tr>\n<td>items[].checkIn</td>\n<td>string</td>\n<td>The check-in date for the booking item.</td>\n</tr>\n<tr>\n<td>items[].checkOut</td>\n<td>string</td>\n<td>The check-out date for the booking item.</td>\n</tr>\n<tr>\n<td>items[].numberGuests</td>\n<td>number</td>\n<td>The number of guests of a room in a booking.</td>\n</tr>\n<tr>\n<td>items[].priceRetail</td>\n<td>number</td>\n<td>The gross price of the room type.</td>\n</tr>\n<tr>\n<td>items[].priceRack</td>\n<td>number</td>\n<td>The gross price after price adjustments.</td>\n</tr>\n<tr>\n<td>items[].priceNet</td>\n<td>number</td>\n<td>The gross price after commission.</td>\n</tr>\n<tr>\n<td>items[].endDate</td>\n<td>number</td>\n<td>The end date of the booking item as a Unix timestamp in milliseconds.</td>\n</tr>\n<tr>\n<td>items[].priceSell</td>\n<td>number</td>\n<td>The sell price applied to non-managed/bought products for this item after commission and adjustments.</td>\n</tr>\n<tr>\n<td>items[].parentCategory</td>\n<td>string</td>\n<td>Parent classification for the item.</td>\n</tr>\n<tr>\n<td>items[].category</td>\n<td>string</td>\n<td>Specific item category.</td>\n</tr>\n<tr>\n<td>items[].itemId</td>\n<td>string</td>\n<td>Internal identifier of the booking item.</td>\n</tr>\n<tr>\n<td>items[].roomNumber</td>\n<td>string</td>\n<td>Assigned room number for this item, if applicable.</td>\n</tr>\n<tr>\n<td>items[].resourceId</td>\n<td>string</td>\n<td>Linked resource ID (e.g., the specific room/inventory resource).</td>\n</tr>\n<tr>\n<td>items[].arrivalTime</td>\n<td>string</td>\n<td>Scheduled arrival time for the booking item (HH:mm).</td>\n</tr>\n<tr>\n<td>items[].departureTime</td>\n<td>string</td>\n<td>Scheduled departure time for the booking item (HH:mm).</td>\n</tr>\n<tr>\n<td>items[].checkedIn</td>\n<td>boolean</td>\n<td>Indicates whether the guest has checked in.</td>\n</tr>\n<tr>\n<td>items[].checkedOut</td>\n<td>boolean</td>\n<td>Indicates whether the guest has checked out.</td>\n</tr>\n<tr>\n<td>items[].roomNote</td>\n<td>string</td>\n<td>Free-text notes related to the room for this item.</td>\n</tr>\n<tr>\n<td>items[].ratePlan</td>\n<td>string</td>\n<td>Rate plan name associated with this item.</td>\n</tr>\n<tr>\n<td>items[].productOptions</td>\n<td>array</td>\n<td>Array of option selections for this item.</td>\n</tr>\n<tr>\n<td>items[].productOptions[].id</td>\n<td>string</td>\n<td>Internal identifier of the item option.</td>\n</tr>\n<tr>\n<td>items[].productOptions[].label</td>\n<td>string</td>\n<td>Display name of the item option.</td>\n</tr>\n<tr>\n<td>items[].productOptions[].value</td>\n<td>string</td>\n<td>Selected value for the option.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackageinvoicepayments\">Package Invoice Payments</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceNumber</td>\n<td>string</td>\n<td>The human-readable invoice number, suffix increments with each invoice. E.g \"100000-1\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceId</td>\n<td>string</td>\n<td>Unique identifier of the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDate</td>\n<td>string</td>\n<td>The date the invoice was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceAmount</td>\n<td>number</td>\n<td>The amount billed on the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceDueDate</td>\n<td>string</td>\n<td>The date the invoice is due. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceCreatedDate</td>\n<td>string</td>\n<td>The date the invoice was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceModifiedDate</td>\n<td>string</td>\n<td>The date the invoice was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceNotes</td>\n<td>string</td>\n<td>Invoice note. Max. character length:  128.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentId</td>\n<td>string</td>\n<td>Payment ID registered on the invoice payment. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentDate</td>\n<td>string</td>\n<td>The date the invoice payment was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentAmount</td>\n<td>number</td>\n<td>The amount of the invoice payment.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentMethod</td>\n<td>string</td>\n<td>The type of payment method. See \"Payment Methods\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentCreatedDate</td>\n<td>string</td>\n<td>The date the invoice payment was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentModifiedDate</td>\n<td>string</td>\n<td>The date the invoice payment was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentNotes</td>\n<td>string</td>\n<td>Payment note. Max. character length:  128.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["listBooking"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify the alphanumeric ID for the booking.</p>\n","type":"text/plain"},"key":"bookingId","value":""},{"disabled":true,"description":{"content":"<p>Specify the alphanumeric EID for the booking.</p>\n","type":"text/plain"},"key":"bookingEid","value":""}],"variable":[]}},"response":[{"id":"7c417599-a76f-4211-bbfc-207ccde83f9a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBooking?bookingId=8a80818a9a7e7c66019a80389e470a09","protocol":"https","host":["api","roomboss","com"],"path":["extws","hotel","v1","listBooking"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking.","disabled":true},{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","disabled":true},{"key":"bookingId","value":"8a80818a9a7e7c66019a80389e470a09"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"order\": {\n        \"posId\": \"4028808c11f7ee4d0111f7ee55980001\",\n        \"leadGuest\": {\n            \"title\": null,\n            \"guestId\": null,\n            \"givenName\": \"Will\",\n            \"familyName\": \"Werdsworth\",\n            \"email\": \"willwerds8253b@gmail.com\",\n            \"additionalEmail\": \"\",\n            \"gender\": \"MALE\",\n            \"nationality\": \"AG\",\n            \"age\": 0,\n            \"phoneNumber\": \"81123456789\",\n            \"dateOfBirth\": \"1950-01-02\",\n            \"height\": null,\n            \"weight\": null,\n            \"postcode\": \"044-0123\",\n            \"administrativeRegion\": \"Hokkaido\",\n            \"city\": \"Kutchan\",\n            \"address1\": \"29, Wallaby Way\",\n            \"address2\": \"Central Business District\",\n            \"language\": \"JA\",\n            \"dietaryRestrictions\": \"Vegetarian and no nuts\",\n            \"emergencyContactName\": \"Parry Hotter\",\n            \"emergencyContactTel\": \"81123456789\",\n            \"medicalIssues\": null\n        },\n        \"bookings\": [\n            {\n                \"packageId\": \"2571445\",\n                \"eId\": 2571445,\n                \"customId\": \"RGB80075\",\n                \"segment\": \"\",\n                \"bookingId\": \"8a80818a9a7e7c66019a80389e470a09\",\n                \"active\": false,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": \"STD\",\n                \"items\": [\n                    {\n                        \"endDate\": 1774051200000,\n                        \"priceRetail\": 60000.0,\n                        \"priceRack\": 60000.0,\n                        \"priceNet\": 60000.0,\n                        \"priceSell\": 60000.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9a7e7c66019a80389e480a0b\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-15\",\n                        \"checkOut\": \"2026-03-21\",\n                        \"arrivalTime\": \"--:--\",\n                        \"departureTime\": \"--:--\",\n                        \"numberGuests\": 4,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": false,\n                        \"checkedOut\": false,\n                        \"roomNote\": null,\n                        \"ratePlan\": \"Base Rate Plan Winter\",\n                        \"productOptions\": []\n                    }\n                ],\n                \"createdDate\": \"2025-11-14T02:36:25.000+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": \"2025-11-14T02:53:44.000+0000\",\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": \"Example Management Group\",\n                \"notes\": null,\n                \"discountCode\": \"\",\n                \"guestIntranetUrl\": null,\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            }\n        ],\n        \"invoicePayments\": [\n            {\n                \"invoiceNumber\": \"2571445-1-WEB\",\n                \"invoiceId\": \"8a80818a9a7e7c66019a8038a02d0a1f\",\n                \"invoiceDate\": \"2025-11-14\",\n                \"invoiceAmount\": 12000.0,\n                \"invoiceDueDate\": \"2025-11-14\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            },\n            {\n                \"invoiceNumber\": \"2571445-2-WEB\",\n                \"invoiceId\": \"8a80818a9a7e7c66019a8038a0760a22\",\n                \"invoiceDate\": \"2025-11-14\",\n                \"invoiceAmount\": 48000.0,\n                \"invoiceDueDate\": \"2025-12-31\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            }\n        ]\n    }\n}"},{"id":"d0c086ca-8881-4517-a17e-6ace8d457037","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBooking?bookingId=","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listBooking"],"query":[{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","type":"text","disabled":true},{"key":"bookingId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide a bookingId or bookingEid.\"\n}"}],"_postman_id":"92c47ac0-bc05-4b33-aee9-acd13b5fd869"},{"name":"Cancel Booking","id":"a2b3f888-42ea-4160-98cf-897dc9a284bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/cancelBooking","description":"<p>This API allows you to cancel an existing booking using either the <code>bookingId</code> or <code>bookingEid</code>.</p>\n<h4 id=\"note\">Note</h4>\n<p>Currently, updating a booking is not supported. If modifications are needed, it is recommended to cancel the existing booking and create a new one.</p>\n","urlObject":{"path":["cancelBooking"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify the alphanumeric ID for the booking.</p>\n","type":"text/plain"},"key":"bookingId","value":""},{"disabled":true,"description":{"content":"<p>Specify the alphanumeric EID for the booking.</p>\n","type":"text/plain"},"key":"bookingEid","value":""}],"variable":[]}},"response":[{"id":"a8cdaedc-ac71-470f-80a0-98afb86e5b80","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/cancelBooking?bookingId=ff8080814bba432c014bba6de8fd001e","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["cancelBooking"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking.","type":"text","disabled":true},{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","type":"text","disabled":true},{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null\n}"},{"id":"d79b4d71-26c1-4144-b3d4-de2280eeb69b","name":"Missing Booking","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/cancelBooking?bookingId=ff8080814bba432c014bba6de8fd001e","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["cancelBooking"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking.","type":"text","disabled":true},{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","type":"text","disabled":true},{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"No booking was found with the ID: ff8080814bba432c014bba6de8fd001e\"\n}"},{"id":"4902059c-06a5-48f0-8d54-adbf60f547a0","name":"Invalid Booking","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/cancelBooking?bookingId=ff8080814bba432c014bba6de8fd001e","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["cancelBooking"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking.","type":"text","disabled":true},{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","type":"text","disabled":true},{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"This booking does not belong to Company A\"\n}"},{"id":"65342a19-b93d-4d94-be95-8ea373abf876","name":"Booking Already Cancelled","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/cancelBooking?bookingId=ff8080814bba432c014bba6de8fd001e","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["cancelBooking"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking.","type":"text","disabled":true},{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","type":"text","disabled":true},{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"This booking is already cancelled.\"\n}"},{"id":"c1fc32a0-88af-4a0f-b10e-3ee7020494ba","name":"Required Parameter","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/cancelBooking?bookingId=","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["cancelBooking"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking."},{"key":"bookingEid","value":"","description":"Specify the alphanumeric EID for the booking.","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide a bookingId or bookingEid.\"\n}"}],"_postman_id":"a2b3f888-42ea-4160-98cf-897dc9a284bd"},{"name":"Create Payment","id":"91f8cb53-d7ad-41d3-aaf5-f890d7ee94d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/createPayment","description":"<p>This method allows you to register a payment to a booking.</p>\n","urlObject":{"path":["createPayment"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify the alphanumeric ID for the booking to create payment for.</p>\n","type":"text/plain"},"key":"bookingId","value":""},{"disabled":true,"description":{"content":"<p>Specify the alphanumeric ID of the invoice that is being paid.</p>\n","type":"text/plain"},"key":"invoiceId","value":""},{"disabled":true,"description":{"content":"<p>Specify the ID of the payment, typically the ID provided by the payment gateway.</p>\n","type":"text/plain"},"key":"paymentId","value":""},{"disabled":true,"description":{"content":"<p>Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)</p>\n","type":"text/plain"},"key":"paymentAmount","value":""}],"variable":[]}},"response":[{"id":"e316f4c6-34b4-41ea-9369-23073f18cd6c","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=ABC321&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null\n}"},{"id":"908a4c44-82ed-43bf-aca2-e72d1e928d6e","name":"Required Booking ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=ABC321&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide bookingId.\"\n}"},{"id":"f0518739-011b-4af2-95b2-1d50a8f2a7d4","name":"Required Invoice ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=&paymentId=ABC321&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide an invoice ID.\"\n}"},{"id":"35f9546e-e1b8-40e6-8069-5bec20ca73e1","name":"Required Payment ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide a payment ID.\"\n}"},{"id":"2f421a24-8363-4cab-8689-694c0e9fc56c","name":"Required Payment Amount","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=ABC321&paymentDate=20180310&paymentAmount=","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide the payment amount\"\n}"},{"id":"bd1139fe-b89b-4858-bebb-2610f42cf053","name":"Invalid Booking","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=ABC321&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"This booking does not belong to Company A\"\n}"},{"id":"9f313123-2973-4bc8-ab73-de3cb085c39d","name":"Missing Invoice","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=ABC321&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"No invoice with invoice ID ff8080814bba432c014bba6e0877001f was found for this booking.\"\n}"},{"id":"80fc0848-e1b5-464d-afca-b1bd5099008d","name":"Invoice Already Paid","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createPayment?bookingId=ff8080814bba432c014bba6de8fd001e&invoiceId=ff8080814bba432c014bba6e0877001f&paymentId=ABC321&paymentDate=20180310&paymentAmount=100000","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createPayment"],"query":[{"key":"bookingId","value":"ff8080814bba432c014bba6de8fd001e","description":"Specify the alphanumeric ID for the booking to create payment for."},{"key":"invoiceId","value":"ff8080814bba432c014bba6e0877001f","description":"Specify the alphanumeric ID of the invoice that is being paid."},{"key":"paymentId","value":"ABC321","description":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"key":"paymentDate","value":"20180310"},{"key":"paymentAmount","value":"100000","description":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"A payment has already been made for this invoice.\"\n}"}],"_postman_id":"91f8cb53-d7ad-41d3-aaf5-f890d7ee94d0"},{"name":"List Bookings Changed on Date","id":"8203b97d-9244-43d8-91b1-497a252364c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listBookings","description":"<p>This endpoint returns all bookings that were created, modified or cancelled on a given date or range. The user may choose to list only accommodation bookings, only service bookings or both types that were created, modified or cancelled on a given date using a parameter. Specifying the query further by vendor(s) is also possible.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>bookings[].eid</td>\n<td>number</td>\n<td>The human-readable booking ID. E.g \"100000\".</td>\n</tr>\n<tr>\n<td>bookings[].customId</td>\n<td>string</td>\n<td>Optional custom ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingId</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].active</td>\n<td>boolean</td>\n<td>The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false).</td>\n</tr>\n<tr>\n<td>bookings[].extent</td>\n<td>string</td>\n<td>The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>bookings[].createdDate</td>\n<td>string</td>\n<td>The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].createdUser</td>\n<td>string</td>\n<td>The name of the user who created the booking.</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedDate</td>\n<td>string</td>\n<td>The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedUser</td>\n<td>string</td>\n<td>The name of the user who made the most recent modification to the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingType</td>\n<td>string</td>\n<td>Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingSource</td>\n<td>string</td>\n<td>The company name of the booking source.</td>\n</tr>\n<tr>\n<td>bookings[].notes</td>\n<td>string</td>\n<td>Booking note. Max. character length:  4096.</td>\n</tr>\n<tr>\n<td>bookings[].guestIntranetUrl</td>\n<td>string</td>\n<td>The Guest Intranet page URL for the booking.</td>\n</tr>\n<tr>\n<td>bookings[].hotel</td>\n<td>object</td>\n<td>Details of the hotel associated with the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead.</td>\n</tr>\n<tr>\n<td>bookings[].items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>bookings[].segment</td>\n<td>string</td>\n<td>The segment of the booking (e.g. agent, OTA, etc.), as determined by the system.</td>\n</tr>\n<tr>\n<td>bookings[].packageId</td>\n<td>string</td>\n<td>Identifier of the package this booking belongs to (ID of the lead booking).</td>\n</tr>\n<tr>\n<td>bookings[].leadGuest.additionalEmail</td>\n<td>string</td>\n<td>Secondary email address for the lead guest on this booking.</td>\n</tr>\n<tr>\n<td>bookings[].items[].arrivalTime</td>\n<td>string</td>\n<td>Scheduled arrival time for the booking item (HH:mm).</td>\n</tr>\n<tr>\n<td>bookings[].items[].departureTime</td>\n<td>string</td>\n<td>Scheduled departure time for the booking item (HH:mm).</td>\n</tr>\n<tr>\n<td>bookings[].items[].priceSell</td>\n<td>number</td>\n<td>The sell price applied to non-managed/bought products for this item after commission and adjustments.</td>\n</tr>\n<tr>\n<td>bookings[].roomStatus</td>\n<td>string</td>\n<td>The room status of a booking. Indicates whether the booking is a standard reservation or a blocked date. Possible values: STD (standard), OOS (blocked date), OOO (blocked date)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["listBookings"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify the date to search.</p>\n","type":"text/plain"},"key":"date","value":""},{"disabled":true,"description":{"content":"<p>Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. The default is ALL.</p>\n","type":"text/plain"},"key":"bookingType","value":""},{"disabled":true,"description":{"content":"<p>Optional: Start date for booking-change search in compact format yyyyMMdd (e.g., 20250101). Used together with 'to'. If both 'from' and 'to' are set, 'date' is ignored (but still required).</p>\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"<p>Optional: End date (inclusive) for booking-change search in compact format yyyyMMdd (e.g., 20250131). Used together with 'from'. If both 'from' and 'to' are set, 'date' is ignored (but still required).</p>\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"<p>Optional: List of vendor IDs to filter bookings. Repeat this parameter for multiple values (e.g., vendorIds=1234&vendorIds=5678). Omit to return all vendors.</p>\n","type":"text/plain"},"key":"vendorIds","value":""}],"variable":[]}},"response":[{"id":"22961b0b-d166-4952-aa67-89ac337b3bda","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBookings?date=20251107&bookingType=ALL&from=20251101&to=20251130&vendorIds=f808ad963f54211d013f65b88d7b35a9","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listBookings"],"query":[{"key":"date","value":"20251107","description":"Specify the date to search."},{"key":"bookingType","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."},{"key":"from","value":"20251101"},{"key":"to","value":"20251130"},{"key":"vendorIds","value":"f808ad963f54211d013f65b88d7b35a9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"bookings\": [\n        {\n            \"booking\": {\n                \"packageId\": \"2571445\",\n                \"eId\": 2571445,\n                \"customId\": \"RGB80075\",\n                \"segment\": \"\",\n                \"bookingId\": \"8a80818a9a7e7c66019a80389e470a09\",\n                \"active\": false,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": \"STD\",\n                \"items\": [\n                    {\n                        \"endDate\": 1774051200000,\n                        \"priceRetail\": 60000.0,\n                        \"priceRack\": 60000.0,\n                        \"priceNet\": 60000.0,\n                        \"priceSell\": 60000.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9a7e7c66019a80389e480a0b\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-15\",\n                        \"checkOut\": \"2026-03-21\",\n                        \"arrivalTime\": \"--:--\",\n                        \"departureTime\": \"--:--\",\n                        \"numberGuests\": 4,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": false,\n                        \"checkedOut\": false,\n                        \"roomNote\": null,\n                        \"ratePlan\": \"Base Rate Plan Winter\",\n                        \"productOptions\": []\n                    }\n                ],\n                \"createdDate\": \"2025-11-14T02:36:25.000+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": \"2025-11-14T02:53:44.000+0000\",\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": \"Example Management Group\",\n                \"notes\": null,\n                \"discountCode\": \"\",\n                \"leadGuest\": {\n                    \"title\": null,\n                    \"guestId\": null,\n                    \"givenName\": \"Will\",\n                    \"familyName\": \"Werdsworth\",\n                    \"email\": \"willwerds8253b@gmail.com\",\n                    \"additionalEmail\": \"\",\n                    \"gender\": \"MALE\",\n                    \"nationality\": \"AG\",\n                    \"age\": 0,\n                    \"phoneNumber\": \"81123456789\",\n                    \"dateOfBirth\": \"1950-01-02\",\n                    \"height\": null,\n                    \"weight\": null,\n                    \"postcode\": \"044-0123\",\n                    \"administrativeRegion\": \"Hokkaido\",\n                    \"city\": \"Kutchan\",\n                    \"address1\": \"29, Wallaby Way\",\n                    \"address2\": \"Central Business District\",\n                    \"language\": \"JA\",\n                    \"dietaryRestrictions\": \"Vegetarian and no nuts\",\n                    \"emergencyContactName\": \"Parry Hotter\",\n                    \"emergencyContactTel\": \"81123456789\",\n                    \"medicalIssues\": null\n                },\n                \"guestIntranetUrl\": null,\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            },\n            \"invoicePayments\": [\n                {\n                    \"invoiceNumber\": \"2571445-1-WEB\",\n                    \"invoiceId\": \"8a80818a9a7e7c66019a8038a02d0a1f\",\n                    \"invoiceDate\": \"2025-11-14\",\n                    \"invoiceAmount\": 12000.0,\n                    \"invoiceDueDate\": \"2025-11-14\",\n                    \"invoiceCreatedBy\": null,\n                    \"invoiceCreatedDate\": \"2025-11-14T02:36:26.000+0000\",\n                    \"invoiceModifiedBy\": null,\n                    \"invoiceModifiedDate\": \"2025-11-14T02:36:26.000+0000\",\n                    \"invoiceNotes\": null,\n                    \"paymentId\": null,\n                    \"paymentDate\": null,\n                    \"paymentAmount\": 0.0,\n                    \"paymentMethod\": null,\n                    \"paymentCreatedBy\": null,\n                    \"paymentCreatedDate\": \"2025-11-14T02:36:26.000+0000\",\n                    \"paymentModifiedBy\": null,\n                    \"paymentModifiedDate\": null,\n                    \"paymentNotes\": null\n                },\n                {\n                    \"invoiceNumber\": \"2571445-2-WEB\",\n                    \"invoiceId\": \"8a80818a9a7e7c66019a8038a0760a22\",\n                    \"invoiceDate\": \"2025-11-14\",\n                    \"invoiceAmount\": 48000.0,\n                    \"invoiceDueDate\": \"2025-12-31\",\n                    \"invoiceCreatedBy\": null,\n                    \"invoiceCreatedDate\": \"2025-11-14T02:36:26.000+0000\",\n                    \"invoiceModifiedBy\": null,\n                    \"invoiceModifiedDate\": \"2025-11-14T02:36:26.000+0000\",\n                    \"invoiceNotes\": null,\n                    \"paymentId\": null,\n                    \"paymentDate\": null,\n                    \"paymentAmount\": 0.0,\n                    \"paymentMethod\": null,\n                    \"paymentCreatedBy\": null,\n                    \"paymentCreatedDate\": \"2025-11-14T02:36:26.000+0000\",\n                    \"paymentModifiedBy\": null,\n                    \"paymentModifiedDate\": null,\n                    \"paymentNotes\": null\n                }\n            ]\n        },\n        {\n            \"booking\": {\n                \"packageId\": \"2563084\",\n                \"eId\": 2563084,\n                \"customId\": \"\",\n                \"segment\": \"\",\n                \"bookingId\": \"8a80818a9a55f783019a5d5c4a1716a6\",\n                \"active\": true,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": \"STD\",\n                \"items\": [\n                    {\n                        \"endDate\": 1764892800000,\n                        \"priceRetail\": 199992.0,\n                        \"priceRack\": 199992.0,\n                        \"priceNet\": 199992.0,\n                        \"priceSell\": 199992.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9a55f783019a5d5c4a1716a8\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": \"B\",\n                        \"resourceId\": \"f808ad963f54211d013f65bbef2235b7\",\n                        \"checkIn\": \"2025-12-01\",\n                        \"checkOut\": \"2025-12-05\",\n                        \"arrivalTime\": \"--:--\",\n                        \"departureTime\": \"--:--\",\n                        \"numberGuests\": 5,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": false,\n                        \"checkedOut\": false,\n                        \"roomNote\": null,\n                        \"ratePlan\": \"Base Rate Plan Winter\",\n                        \"productOptions\": [\n                            {\n                                \"id\": \"f808ad963f54211d013f65bb764f35af\",\n                                \"label\": \"Bedding\",\n                                \"value\": \"King\"\n                            }\n                        ]\n                    }\n                ],\n                \"createdDate\": \"2025-11-07T08:07:57.000+0000\",\n                \"createdUser\": \"Admin\",\n                \"lastModifiedDate\": null,\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": \"Example Management Group\",\n                \"notes\": \"\",\n                \"discountCode\": \"\",\n                \"leadGuest\": {\n                    \"title\": null,\n                    \"guestId\": null,\n                    \"givenName\": \"Brendon\",\n                    \"familyName\": \"Test\",\n                    \"email\": \"brendon.chow@roomboss.co.jp\",\n                    \"additionalEmail\": \"\",\n                    \"gender\": null,\n                    \"nationality\": \"JP\",\n                    \"age\": 0,\n                    \"phoneNumber\": \"09012345678\",\n                    \"dateOfBirth\": null,\n                    \"height\": 0,\n                    \"weight\": 0,\n                    \"postcode\": \"\",\n                    \"administrativeRegion\": \"\",\n                    \"city\": \"\",\n                    \"address1\": \"\",\n                    \"address2\": \"\",\n                    \"language\": \"en\",\n                    \"dietaryRestrictions\": null,\n                    \"emergencyContactName\": \"\",\n                    \"emergencyContactTel\": \"\",\n                    \"medicalIssues\": null\n                },\n                \"guestIntranetUrl\": null,\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            },\n            \"invoicePayments\": [\n                {\n                    \"invoiceNumber\": \"2563084-1\",\n                    \"invoiceId\": \"8a80818a9a6f095e019a7064366e64c5\",\n                    \"invoiceDate\": \"2025-11-11\",\n                    \"invoiceAmount\": 199992.0,\n                    \"invoiceDueDate\": \"2025-11-11\",\n                    \"invoiceCreatedBy\": \"Admin\",\n                    \"invoiceCreatedDate\": \"2025-11-11T00:49:48.000+0000\",\n                    \"invoiceModifiedBy\": \"Admin\",\n                    \"invoiceModifiedDate\": \"2025-11-11T00:50:07.000+0000\",\n                    \"invoiceNotes\": \"\",\n                    \"paymentId\": \"\",\n                    \"paymentDate\": \"2025-11-11\",\n                    \"paymentAmount\": 199992.0,\n                    \"paymentMethod\": null,\n                    \"paymentCreatedBy\": \"Admin\",\n                    \"paymentCreatedDate\": \"2025-11-11T00:49:48.000+0000\",\n                    \"paymentModifiedBy\": \"Admin\",\n                    \"paymentModifiedDate\": \"2025-11-11T00:50:07.000+0000\",\n                    \"paymentNotes\": \"\"\n                }\n            ]\n        },\n        {\n            \"booking\": {\n                \"packageId\": \"2561076\",\n                \"eId\": 2561076,\n                \"customId\": null,\n                \"segment\": \"\",\n                \"bookingId\": \"8a80818a9a55f783019a568a6f00450d\",\n                \"active\": true,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": \"OOS\",\n                \"items\": [\n                    {\n                        \"endDate\": 1762473600000,\n                        \"priceRetail\": 0.0,\n                        \"priceRack\": 0.0,\n                        \"priceNet\": 0.0,\n                        \"priceSell\": 0.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9a55f783019a568a6f00450e\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": \"A\",\n                        \"resourceId\": \"f808ad963f54211d013f65bbd91435b6\",\n                        \"checkIn\": \"2025-11-06\",\n                        \"checkOut\": \"2025-11-07\",\n                        \"arrivalTime\": \"--:--\",\n                        \"departureTime\": \"--:--\",\n                        \"numberGuests\": 1,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": false,\n                        \"checkedOut\": false,\n                        \"roomNote\": null,\n                        \"ratePlan\": \"Manual\",\n                        \"productOptions\": []\n                    }\n                ],\n                \"createdDate\": \"2025-11-06T00:21:44.000+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": null,\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": \"Example Management Group\",\n                \"notes\": \"test note\",\n                \"discountCode\": \"\",\n                \"leadGuest\": {\n                    \"title\": null,\n                    \"guestId\": null,\n                    \"givenName\": null,\n                    \"familyName\": null,\n                    \"email\": null,\n                    \"additionalEmail\": null,\n                    \"gender\": null,\n                    \"nationality\": null,\n                    \"age\": 0,\n                    \"phoneNumber\": null,\n                    \"dateOfBirth\": null,\n                    \"height\": null,\n                    \"weight\": null,\n                    \"postcode\": null,\n                    \"administrativeRegion\": null,\n                    \"city\": null,\n                    \"address1\": null,\n                    \"address2\": null,\n                    \"language\": null,\n                    \"dietaryRestrictions\": null,\n                    \"emergencyContactName\": null,\n                    \"emergencyContactTel\": null,\n                    \"medicalIssues\": null\n                },\n                \"guestIntranetUrl\": null,\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            },\n            \"invoicePayments\": []\n        }\n    ]\n}"},{"id":"930ef48c-3153-46d9-8d8b-cbfe09b441ac","name":"Required Date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBookings?date=&bookingType=ALL","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listBookings"],"query":[{"key":"date","value":"","description":"Specify the date to search."},{"key":"bookingType","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. The default is ALL."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"You must provide a date.\"\n}"},{"id":"e5dd019d-824a-4374-83d9-043b2e2656ed","name":"Unsupported Multiple Dates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBookings?date=20180310&bookingType=ALL&date=20200310","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listBookings"],"query":[{"key":"date","value":"20180310","description":"Specify the date to search."},{"key":"bookingType","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. The default is ALL."},{"key":"date","value":"20200310","type":"text"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Only one date per request is supported at present.\"\n}"},{"id":"ea660d6e-2095-4fc7-a373-2baf2edd80bf","name":"Invalid Date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBookings?date=20300310&bookingType=ALL","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listBookings"],"query":[{"key":"date","value":"20300310","description":"Specify the date to search."},{"key":"bookingType","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. The default is ALL."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The date cannot be in the future.\"\n}"},{"id":"3f5a2c40-c49a-468b-a5fc-0cb4239c64b2","name":"Invalid Booking Type","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listBookings?date=20180310&bookingType=NONE&date=20200310","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listBookings"],"query":[{"key":"date","value":"20180310","description":"Specify the date to search."},{"key":"bookingType","value":"NONE","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. The default is ALL."},{"key":"date","value":"20200310"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The search by type should either be ACCOMMODATION, NON_ACCOMMODATION or ALL.\"\n}"}],"_postman_id":"8203b97d-9244-43d8-91b1-497a252364c1"},{"name":"List Bookings by Resource","id":"f01dac64-0b78-4d8f-a36c-d43f637fe42f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/((resourceId}}/bookings","description":"<p>Retrieve all <em>active</em> bookings for a specific room/resource over the next 3 months. This endpoint is protected by Cloudflare rate limiting.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>bookings[].eid</td>\n<td>number</td>\n<td>The human-readable booking ID. E.g \"100000\".</td>\n</tr>\n<tr>\n<td>bookings[].customId</td>\n<td>string</td>\n<td>Optional custom ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingId</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].active</td>\n<td>boolean</td>\n<td>The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false).</td>\n</tr>\n<tr>\n<td>bookings[].extent</td>\n<td>string</td>\n<td>The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>bookings[].createdDate</td>\n<td>string</td>\n<td>The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].createdUser</td>\n<td>string</td>\n<td>The name of the user who created the booking.</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedDate</td>\n<td>string</td>\n<td>The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedUser</td>\n<td>string</td>\n<td>The name of the user who made the most recent modification to the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingType</td>\n<td>string</td>\n<td>Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingSource</td>\n<td>string</td>\n<td>The company name of the booking source.</td>\n</tr>\n<tr>\n<td>bookings[].notes</td>\n<td>string</td>\n<td>Booking note. Max. character length:  4096.</td>\n</tr>\n<tr>\n<td>bookings[].guestIntranetUrl</td>\n<td>string</td>\n<td>The Guest Intranet page URL for the booking.</td>\n</tr>\n<tr>\n<td>bookings[].hotel</td>\n<td>object</td>\n<td>Details of the hotel associated with the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead.</td>\n</tr>\n<tr>\n<td>bookings[].items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>bookings[].segment</td>\n<td>string</td>\n<td>The segment of the booking (e.g. agent, OTA, etc.), as determined by the system.</td>\n</tr>\n<tr>\n<td>bookings[].packageId</td>\n<td>string</td>\n<td>Identifier of the package this booking belongs to (ID of the lead booking).</td>\n</tr>\n<tr>\n<td>bookings[].leadGuest.additionalEmail</td>\n<td>string</td>\n<td>Secondary email address for the lead guest on this booking.</td>\n</tr>\n<tr>\n<td>bookings[].items[].arrivalTime</td>\n<td>string</td>\n<td>Scheduled arrival time for the booking item (HH:mm).</td>\n</tr>\n<tr>\n<td>bookings[].items[].departureTime</td>\n<td>string</td>\n<td>Scheduled departure time for the booking item (HH:mm).</td>\n</tr>\n<tr>\n<td>bookings[].items[].priceSell</td>\n<td>number</td>\n<td>The sell price applied to non-managed/bought products for this item after commission and adjustments.</td>\n</tr>\n<tr>\n<td>bookings[].roomStatus</td>\n<td>string</td>\n<td>The room status of a booking. Indicates whether the booking is a standard reservation or a blocked date. Possible values: STD (standard), OOS (blocked date), OOO (blocked date)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["resource","((resourceId}}","bookings"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Linked resource ID (e.g., the specific room/inventory resource).</p>\n","type":"text/plain"},"key":"resourceId","value":""}],"variable":[]}},"response":[{"id":"d4992f46-7675-44ae-8cc9-38057a80e173","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/f808ad963f54211d013f65bbef2235b7/bookings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"bookings\": [\n        {\n            \"packageId\": \"2563084\",\n            \"eId\": 2563084,\n            \"customId\": \"\",\n            \"segment\": \"\",\n            \"bookingId\": \"8a80818a9a55f783019a5d5c4a1716a6\",\n            \"active\": true,\n            \"extent\": \"RESERVATION\",\n            \"roomStatus\": \"STD\",\n            \"items\": [\n                {\n                    \"endDate\": 1764892800000,\n                    \"priceRetail\": 199992.0,\n                    \"priceRack\": 199992.0,\n                    \"priceNet\": 199992.0,\n                    \"priceSell\": 199992.0,\n                    \"parentCategory\": null,\n                    \"category\": null,\n                    \"itemId\": \"8a80818a9a55f783019a5d5c4a1716a8\",\n                    \"roomType\": {\n                        \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                        \"roomTypeName\": \"Family Room\",\n                        \"maxNumberGuests\": 6,\n                        \"numberBedrooms\": 1,\n                        \"numberBathrooms\": 1,\n                        \"maxNumberAdults\": 0,\n                        \"maxNumberChildren\": 0,\n                        \"maxNumberInfants\": 0\n                    },\n                    \"roomNumber\": \"B\",\n                    \"resourceId\": \"f808ad963f54211d013f65bbef2235b7\",\n                    \"checkIn\": \"2025-12-01\",\n                    \"checkOut\": \"2025-12-05\",\n                    \"arrivalTime\": \"--:--\",\n                    \"departureTime\": \"--:--\",\n                    \"numberGuests\": 5,\n                    \"numberAdults\": null,\n                    \"numberChildren\": null,\n                    \"numberInfants\": null,\n                    \"checkedIn\": false,\n                    \"checkedOut\": false,\n                    \"roomNote\": null,\n                    \"ratePlan\": \"Base Rate Plan Winter\",\n                    \"productOptions\": [\n                        {\n                            \"id\": \"f808ad963f54211d013f65bb764f35af\",\n                            \"label\": \"Bedding\",\n                            \"value\": \"King\"\n                        }\n                    ]\n                }\n            ],\n            \"createdDate\": \"2025-11-07T08:07:57.000+0000\",\n            \"createdUser\": \"Admin\",\n            \"lastModifiedDate\": null,\n            \"lastModifiedUser\": null,\n            \"bookingType\": \"ACCOMMODATION\",\n            \"bookingSource\": \"Example Management Group\",\n            \"notes\": \"\",\n            \"discountCode\": \"\",\n            \"guestIntranetUrl\": null,\n            \"hotel\": {\n                \"url\": \"alpinelodge.co.jp\",\n                \"vendorType\": \"ACCOMMODATION\",\n                \"countryCode\": \"JP\",\n                \"locationCode\": \"NISEKO_HIRAFU\",\n                \"latitude\": 42.864,\n                \"longitude\": 140.704,\n                \"currencyCode\": \"JPY\",\n                \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                \"hotelName\": \"Alpine Lodge\",\n                \"hotelUrl\": \"alpinelodge.co.jp\",\n                \"internalInventory\": true,\n                \"recordGuestType\": null,\n                \"maxAgeChildren\": 0,\n                \"maxAgeInfants\": 0,\n                \"roomTypes\": [\n                    {\n                        \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                        \"roomTypeName\": \"Family Room\",\n                        \"maxNumberGuests\": 6,\n                        \"numberBedrooms\": 1,\n                        \"numberBathrooms\": 1,\n                        \"maxNumberAdults\": 0,\n                        \"maxNumberChildren\": 0,\n                        \"maxNumberInfants\": 0\n                    },\n                    {\n                        \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                        \"roomTypeName\": \"Tatami Room\",\n                        \"maxNumberGuests\": 5,\n                        \"numberBedrooms\": 1,\n                        \"numberBathrooms\": 1,\n                        \"maxNumberAdults\": 0,\n                        \"maxNumberChildren\": 0,\n                        \"maxNumberInfants\": 0\n                    }\n                ]\n            }\n        }\n    ]\n}"},{"id":"2b479bbf-cc0b-4bf9-8f3d-18fe821dbad6","name":"Missing or Invalid Authentication","originalRequest":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/{{resourceId}}/bookings"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"error\": \"Authentication required\"}"},{"id":"eff978c2-16c7-4c28-8499-c12c9325c10b","name":"No Permission","originalRequest":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/{{resourceId}}/bookings"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"error\": \"This account does not have the permission to list resource bookings.\"}"},{"id":"cf09292b-bee1-4c5c-8fde-719d5e4f0f52","name":"Resource ID Not Found","originalRequest":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/{{resourceId}}/bookings"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"error\": \"Resource not found\"}"},{"id":"7353fec4-7935-410d-9671-2e48e2ae7864","name":"Server Error","originalRequest":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/{{resourceId}}/bookings"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"error\": \"An internal server error has occurred.\"}"},{"id":"cd2bb29a-238f-4e48-a66a-c1c19e485547","name":"Rate Limit Reached","originalRequest":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/resource/{{resourceId}}/bookings"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\"error\": \"Rate limit exceeded. Try again in 30 seconds.\"\n}"}],"_postman_id":"f01dac64-0b78-4d8f-a36c-d43f637fe42f"},{"name":"List Payment Information Changed on Date","id":"84a7e596-363e-4130-95a6-a05935c0de57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/listPayments","description":"<p>This method allows you to list the invoices and/or receipts created or changed on a given date.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceNumber</td>\n<td>string</td>\n<td>The human-readable invoice number, suffix increments with each invoice. E.g \"100000-1\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceId</td>\n<td>string</td>\n<td>Unique identifier of the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDate</td>\n<td>string</td>\n<td>The date the invoice was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceAmount</td>\n<td>number</td>\n<td>The amount billed on the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDueDate</td>\n<td>string</td>\n<td>The date the invoice is due. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceCreatedDate</td>\n<td>string</td>\n<td>The date the invoice was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceModifiedDate</td>\n<td>string</td>\n<td>The date the invoice was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceNotes</td>\n<td>string</td>\n<td>Invoice note. Max. character length:  128.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentId</td>\n<td>string</td>\n<td>Payment ID registered on the invoice payment. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentDate</td>\n<td>string</td>\n<td>The date the invoice payment was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentAmount</td>\n<td>number</td>\n<td>The amount of the invoice payment.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentMethod</td>\n<td>string</td>\n<td>The type of payment method. See \"Payment Methods\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentCreatedDate</td>\n<td>string</td>\n<td>The date the invoice payment was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentModifiedDate</td>\n<td>string</td>\n<td>The date the invoice payment was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentNotes</td>\n<td>string</td>\n<td>Payment note. Max. character length:  128.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["listPayments"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify the date to search.</p>\n","type":"text/plain"},"key":"date","value":""},{"disabled":true,"description":{"content":"<p>Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL.</p>\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"410c9c77-4017-4804-9a52-49eef2180e90","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listPayments?date=20190310&filter=ALL","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listPayments"],"query":[{"key":"date","value":"20190310","description":"Specify the date to search."},{"key":"filter","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"invoicePayments\": [\n        {\n            \"packageId\": \"ff8081816a4e4861016a4e50830800ae\",\n            \"invoiceNumber\": \"100017-1-WEB\",\n            \"invoiceId\": \"ff8081816a4e4861016a4e50832d00b3\",\n            \"invoiceDate\": \"2019-04-24\",\n            \"invoiceAmount\": 40000,\n            \"invoiceDueDate\": \"2020-01-15\",\n            \"invoiceCreatedBy\": null,\n            \"invoiceCreatedDate\": \"2019-04-24T07:47:40.000+0000\",\n            \"invoiceModifiedBy\": null,\n            \"invoiceModifiedDate\": \"2019-04-24T07:47:41.000+0000\",\n            \"invoiceNotes\": null,\n            \"paymentId\": \"TEST8497\",\n            \"paymentDate\": \"2019-04-24\",\n            \"paymentAmount\": 40000,\n            \"paymentMethod\": null,\n            \"paymentCreatedBy\": null,\n            \"paymentCreatedDate\": \"2019-04-24T07:47:40.000+0000\",\n            \"paymentModifiedBy\": null,\n            \"paymentModifiedDate\": null,\n            \"paymentNotes\": null\n        },\n        {\n            \"packageId\": \"ff8081816a4e4861016a4e515cb300e6\",\n            \"invoiceNumber\": \"100022-1\",\n            \"invoiceId\": \"ff8081816a4e4861016a4e51e85a00f6\",\n            \"invoiceDate\": \"2019-04-24\",\n            \"invoiceAmount\": 9000,\n            \"invoiceDueDate\": \"2019-04-24\",\n            \"invoiceCreatedBy\": \"Brucey\",\n            \"invoiceCreatedDate\": \"2019-04-24T07:49:11.000+0000\",\n            \"invoiceModifiedBy\": \"Brucey\",\n            \"invoiceModifiedDate\": \"2019-04-24T07:49:12.000+0000\",\n            \"invoiceNotes\": \"\",\n            \"paymentId\": \"\",\n            \"paymentDate\": null,\n            \"paymentAmount\": 0,\n            \"paymentMethod\": null,\n            \"paymentCreatedBy\": \"Brucey\",\n            \"paymentCreatedDate\": \"2019-04-24T07:49:11.000+0000\",\n            \"paymentModifiedBy\": null,\n            \"paymentModifiedDate\": null,\n            \"paymentNotes\": \"\"\n        }\n    ]\n}"},{"id":"4c12c475-dc3f-4767-ae79-4ee9fc30efe5","name":"Required Date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listPayments?date=&filter=ALL","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listPayments"],"query":[{"key":"date","value":"","description":"Specify the date to search."},{"key":"filter","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"You must provide a date.\"\n}"},{"id":"461d9908-d925-4e59-a11a-6dbc68b0c1af","name":"Unsupported Multiple Dates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listPayments?date=20190310&filter=ALL&date=20200310","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listPayments"],"query":[{"key":"date","value":"20190310","description":"Specify the date to search."},{"key":"filter","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."},{"key":"date","value":"20200310","type":"text"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Only one date per request is supported at present.\"\n}"},{"id":"b45d6f78-5e25-4210-9fac-b6614bf92257","name":"Invalid Date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listPayments?date=20300310&filter=ALL","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listPayments"],"query":[{"key":"date","value":"20300310","description":"Specify the date to search."},{"key":"filter","value":"ALL","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The date cannot be in the future.\"\n}"},{"id":"86174bdf-1a57-4e86-843e-57a55e15b28f","name":"Invalid Booking Type","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/listPayments?date=20190310&filter=NONE&date=20200310","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["listPayments"],"query":[{"key":"date","value":"20190310","description":"Specify the date to search."},{"key":"filter","value":"NONE","description":"Optional: Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."},{"key":"date","value":"20200310"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The search by type should either be INVOICES, RECEIPTS or ALL.\"\n}"}],"_postman_id":"84a7e596-363e-4130-95a6-a05935c0de57"},{"name":"Update Lead Guest","id":"8cb44c10-6d09-4851-801c-ec1abbf06007","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/booking/{bookingId}/leadguest","description":"<p>This method allows you to modify the details of the booking lead guest given the bookingID that is from listBooking API. Currently supports saving credit card tokens for Stripe.</p>\n","urlObject":{"path":["booking","{bookingId}","leadguest"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Optional: This is an optional field that sets an alternative first name for the lead guest.</p>\n","type":"text/plain"},"key":"additionalFirstName","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional field that sets an alternative last name for the lead guest.</p>\n","type":"text/plain"},"key":"additionalLastName","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.</p>\n","type":"text/plain"},"key":"eta","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional field that sets the email address of the lead guest.</p>\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional field that sets the contact number of the lead guest.</p>\n","type":"text/plain"},"key":"contactNumber","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional object that contains the address details of the lead guest.</p>\n","type":"text/plain"},"key":"address","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.</p>\n","type":"text/plain"},"key":"dateOfBirth","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)</p>\n","type":"text/plain"},"key":"nationality","value":""},{"disabled":true,"description":{"content":"<p>Optional: An optional object that contains the identification details of the lead guest.</p>\n","type":"text/plain"},"key":"idDetails","value":""},{"disabled":true,"description":{"content":"<p>Optional: An optional field that contains the specialRequests of the lead guest.</p>\n","type":"text/plain"},"key":"specialRequests","value":""},{"disabled":true,"description":{"content":"<p>Optional: An optional field that contains additional comments or notes from the system for the lead guest.</p>\n","type":"text/plain"},"key":"notes","value":""},{"disabled":true,"description":{"content":"<p>Optional: An optional object that contains the credit card token details of the lead guest. </p>\n","type":"text/plain"},"key":"creditCardDetails","value":""}],"variable":[]}},"response":[{"id":"dd14b7fa-2d28-409d-be41-6824deb29f59","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"apiVersion\": \"1.1\",\n\t\"success\": true,\n\t\"failureMessage\": null\n}"},{"id":"ea4b90c8-f86e-4841-a04b-13b5c99e1912","name":"Missing Booking","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Booking not found\"\n}"},{"id":"25eea31f-ca0b-4a77-83b0-b4d2d458e3f4","name":"Invalid Booking","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"This booking does not belong to Company A\"\n}"},{"id":"20b837fe-288f-48c3-83bf-dee139a75199","name":"Invalid Guest ETA","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"1520\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Guest ETA should be in hh:mm format\"\n}"},{"id":"243d0170-8912-491d-b0cd-3194c106da0f","name":"Invalid Guest Nationality","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"XX\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Guest Nationality should be one of ISO-3166-1 Alpha 2 notations\"\n}"},{"id":"2338619b-04a9-49e3-8bc3-d1aab5637c1d","name":"Invalid ID Country of Issue","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"XX\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Guest Id country of issue should be one of ISO-3166-1 Alpha 2 notations\"\n}"},{"id":"f9f47ac7-3e03-4904-b2fa-b016f9a3866e","name":"Required Credit Card Expiry","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Credit card expiry is required.\"\n}"},{"id":"959329e2-cd37-49fd-8d93-895781eba653","name":"Invalid Credit Card Expiry","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/2025\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Credit card expiry should be in MM/yy format\"\n}"},{"id":"46deaf10-71f6-4012-b6b2-aa361005dfc2","name":"Required Credit Card Last 4 Digits","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Credit card last four digits is required.\"\n}"},{"id":"f85af639-153f-460e-89ff-43b2e4800d81","name":"Required Credit Card Token","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountType\": \"STRIPE\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Credit card token is required.\"\n}"},{"id":"d1b54b8b-66d3-484c-bcad-7dc7eba85e5f","name":"Required Payment Account Type","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"additionalFirstName\": \"ウィル\",\n    \"additionalLastName\": \"ワエルジウォース\",\n    \"eta\": \"15:20\",\n    \"email\": \"willwerds8253b@gmail.com\",\n    \"contactNumber\": \"81123456789\",\n    \"address\": {\n        \"address1\": \"29, Wallaby Way\",\n        \"city\": \"Kutchan\",\n        \"state\": \"Hokkaido\",\n        \"postCode\": \"044-0123\"\n    },\n    \"dateOfBirth\": \"1950-01-02\",\n    \"nationality\": \"AG\",\n    \"idDetails\": {\n        \"idNumber\": \"ABC123XYZ\",\n        \"dateOfIssue\": \"2023-01-01\",\n        \"dateOfExpiry\": \"2033-01-01\",\n        \"placeOfIssue\": \"Kutchan, JP\",\n        \"countryOfIssue\": \"JP\"\n    },\n    \"specialRequests\": \"This is a guest special request.\",\n    \"notes\": \"This is an agent comment.\",\n    \"creditCardDetails\": {\n        \"cardExpiryDate\": \"02/25\",\n        \"tokenExpiryDate\": \"2022-12-31\",\n        \"lastFourDigits\": \"4321\",\n        \"token\": \"pi_0d378d586d511ee\",\n        \"brand\": \"MASTERCARD\",\n        \"cardHolderName\": \"Will Werdsworth\",\n        \"paymentAccountId\": \"pk_Strb9621P3xxxaCcId\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/leadguest","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","leadguest"],"query":[{"key":"additionalFirstName","value":"","description":"Optional: This is an optional field that sets an alternative first name for the lead guest.","type":"text","disabled":true},{"key":"additionalLastName","value":"","description":"Optional: This is an optional field that sets an alternative last name for the lead guest.","type":"text","disabled":true},{"key":"eta","value":"","description":"Optional: This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour.","type":"text","disabled":true},{"key":"email","value":"","description":"Optional: This is an optional field that sets the email address of the lead guest.","type":"text","disabled":true},{"key":"contactNumber","value":"","description":"Optional: This is an optional field that sets the contact number of the lead guest.","type":"text","disabled":true},{"key":"address","value":"","description":"Optional: This is an optional object that contains the address details of the lead guest.","type":"text","disabled":true},{"key":"dateOfBirth","value":"","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd.","type":"text","disabled":true},{"key":"nationality","value":"","description":"Optional: This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","type":"text","disabled":true},{"key":"idDetails","value":"","description":"Optional: An optional object that contains the identification details of the lead guest.","type":"text","disabled":true},{"key":"specialRequests","value":"","description":"Optional: An optional field that contains the specialRequests of the lead guest.","type":"text","disabled":true},{"key":"notes","value":"","description":"Optional: An optional field that contains additional comments or notes from the system for the lead guest.","type":"text","disabled":true},{"key":"creditCardDetails","value":"","description":"Optional: An optional object that contains the credit card token details of the lead guest. ","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Payment account type is required.\"\n}"}],"_postman_id":"8cb44c10-6d09-4851-801c-ec1abbf06007"},{"name":"Post Booking Pre-Registration","id":"999b4e91-e0ef-454d-98c6-426532d251b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/booking/{bookingId}/online-registration","description":"<p>This method allows you to mark the booking as pre-registered once the guest has finished the online check-in process.</p>\n","urlObject":{"path":["booking","{bookingId}","online-registration"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>This is a required boolean field that indicates whether the booking should be marked as pre-registered or not.</p>\n","type":"text/plain"},"key":"pre_registered","value":""}],"variable":[]}},"response":[{"id":"4162c33f-1cde-4296-92f0-7b8c65f30a24","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"pre_registered\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/online-registration","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","online-registration"],"query":[{"key":"pre_registered","value":"","description":"This is a required boolean field that indicates whether the booking should be marked as pre-registered or not.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null\n}"},{"id":"2a89bda0-d678-4dcc-9958-77042205c1db","name":"Missing Booking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"pre_registered\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/online-registration","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","online-registration"],"query":[{"key":"pre_registered","value":"","description":"This is a required boolean field that indicates whether the booking should be marked as pre-registered or not.","type":"text","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Booking not found\"\n}"},{"id":"ae754623-15ec-4eac-adad-5a1ed618fffb","name":"Invalid Booking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"pre_registered\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/ff8084912324c6d5011dd17/online-registration","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","ff8084912324c6d5011dd17","online-registration"],"query":[{"key":"pre_registered","value":"","description":"This is a required boolean field that indicates whether the booking should be marked as pre-registered or not.","type":"text","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"This booking does not belong to Company A\"\n}"}],"_postman_id":"999b4e91-e0ef-454d-98c6-426532d251b6"},{"name":"Update Room Status and Housekeeping Tasks","id":"1d102e0e-074b-49e2-bdc9-ad495b9e4952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/booking/{{bookingId}}/housekeeping","description":"<h3 id=\"update-room-status-and-housekeeping-tasks\"><strong>Update Room Status and Housekeeping Tasks</strong></h3>\n<p>Updates the housekeeping status of a room linked to a booking and optionally replaces or appends housekeeping tasks for a specific booking element (<em>Item</em>).</p>\n<h4 id=\"modes\"><strong>Modes</strong></h4>\n<ul>\n<li><p><strong>Replace (default)</strong>: Replaces all existing housekeeping tasks for the item.</p>\n</li>\n<li><p><strong>Add</strong> (<code>?mode=add</code>): Appends new tasks without removing existing ones.</p>\n</li>\n</ul>\n","urlObject":{"path":["booking","{{bookingId}}","housekeeping"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>The ID of the booking you wish to register a payment for.</p>\n","type":"text/plain"},"key":"bookingId","value":""},{"disabled":true,"description":{"content":"<p>Linked resource ID (e.g., the specific room/inventory resource).</p>\n","type":"text/plain"},"key":"roomId","value":""},{"disabled":true,"description":{"content":"<p>Current room state: DIRTY, CLEAN, INSPECTED</p>\n","type":"text/plain"},"key":"roomStatus","value":""},{"disabled":true,"description":{"content":"<p>Optional unless tasks are provided. Internal identifier of the booking item.</p>\n","type":"text/plain"},"key":"itemId","value":""},{"disabled":true,"description":{"content":"<p>Optional:List of housekeeping tasks</p>\n","type":"text/plain"},"key":"tasks","value":""},{"disabled":true,"description":{"content":"<p>Task date Format: \"YYYY-MM-DD\".</p>\n","type":"text/plain"},"key":"date","value":""},{"disabled":true,"description":{"content":"<p>The task status: NOT_COMPLETED, COMPLETED, WONT_COMPLETE</p>\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"<p>The task type: HOUSEKEEPING_ARRIVAL, HOUSEKEEPING_DEPARTURE, HOUSEKEEPING_INSPECTION, HOUSEKEEPING_STAY1–10</p>\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"<p>Optional: Optional note or description</p>\n","type":"text/plain"},"key":"note","value":""},{"disabled":true,"description":{"content":"<p>The mode for updating housekeeping tasks: replace (default) or add.</p>\n","type":"text/plain"},"key":"mode","value":""}],"variable":[]}},"response":[{"id":"1fdb4d98-9c0e-46df-99be-efc18e44dc17","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"roomId\": \"550e8400e29b41d4a716446655440000\",\n  \"roomStatus\": \"DIRTY\",\n  \"itemId\": \"ff80818139f66fb70139f67664a40007\",\n  \"tasks\": [\n    {\n      \"date\": \"2025-07-15\",\n      \"status\": \"NOT_COMPLETED\",\n      \"type\": \"HOUSEKEEPING_ARRIVAL\",\n      \"note\": \"Additional check for this one\"\n    },\n    {\n      \"date\": \"2025-07-16\",\n      \"status\": \"NOT_COMPLETED\",\n      \"type\": \"HOUSEKEEPING_STAY1\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/booking/550e8400e29b41d4a716446655440000/housekeeping","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["booking","550e8400e29b41d4a716446655440000","housekeeping"],"query":[{"key":"bookingId","value":null,"description":"The ID of the booking you wish to register a payment for.","disabled":true},{"key":"roomID","value":null,"description":"Linked resource ID (e.g., the specific room/inventory resource).","disabled":true},{"key":"roomStatus","value":null,"description":"Current room state: DIRTY, CLEAN, INSPECTED","disabled":true},{"key":"itemId","value":null,"description":"Optional unless tasks are provided. Internal identifier of the booking item.","disabled":true},{"key":"tasks","value":null,"description":"Optional:List of housekeeping tasks","disabled":true},{"key":"date","value":null,"description":"Task date Format: \"YYYY-MM-DD\".","disabled":true},{"key":"status","value":null,"description":"The task status: NOT_COMPLETED, COMPLETED, WONT_COMPLETE","disabled":true},{"key":"type","value":null,"description":"The task type: HOUSEKEEPING_ARRIVAL, HOUSEKEEPING_DEPARTURE, HOUSEKEEPING_INSPECTION, HOUSEKEEPING_STAY1–10","disabled":true},{"key":"note","value":null,"description":"Optional: Optional note or description","disabled":true},{"key":"mode%3Dadd","value":null,"description":"If \"mode=add\", new tasks are appended; otherwise all existing tasks are replaced","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"bookingId\": \"550e8400e29b41d4a716446655440000\",\n    \"roomId\": \"550e8400e29b41d4a716446655440000\",\n    \"itemId\": \"ff80818139f66fb70139f67664a40007\",\n    \"tasks\": [\n        {\n            \"id\": \"6ba7b8109dad11d180b400c04fd430c8\",\n            \"date\": \"2025-07-15\",\n            \"status\": \"NOT_COMPLETED\",\n            \"type\": \"HOUSEKEEPING_ARRIVAL\",\n            \"note\": \"Additional check for this one\"\n        },\n        {\n            \"id\": \"6ba7b8119dad11d180b400c04fd430c8\",\n            \"date\": \"2025-07-16\",\n            \"status\": \"NOT_COMPLETED\",\n            \"type\": \"HOUSEKEEPING_STAY1\"\n        }\n    ]\n}"}],"_postman_id":"1d102e0e-074b-49e2-bdc9-ad495b9e4952"},{"name":"Create Booking","id":"ebfe879e-f36b-4a80-8a97-40cdbadae9d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://api.roomboss.com/extws/hotel/v1/createBooking","description":"<blockquote>\n<p>⚠️ <strong>Important</strong><br />This method replaces the deprecated <code>GET Create Booking</code>. We recommend using this version of Create Booking. </p>\n</blockquote>\n<p>This method allows you to create a new booking for one or more rooms.</p>\n<p>The ability to make bookings via this method mirrors what a user of the account can do from a widget like book &amp; pay or Order02. This includes checks such as:</p>\n<ul>\n<li><p><strong>Minimum nights</strong>: Minimum nights will be enforced for REQUEST INTERNAL, REQUEST or RESERVATION if an agent booking; or for RESERVATIONS if a direct booking.</p>\n</li>\n<li><p><strong>Request/Reservation Window</strong>: The request or reservation window will be enforced for both direct and agent bookings. For instance, if the vendor settings state that a direct RESERVATION can only be made 2 days or more from the check-in date, this is enforced.</p>\n</li>\n</ul>\n<p>Creating a booking also triggers the creation of invoices if an invoice strategy exists. An invoice strategy is necessary if one wishes to create an end-to-end flow using the REST API- from creating a booking to accepting payment for the same.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>order</td>\n<td>object</td>\n<td>Object containing package information, including package bookings, package guests, and package invoice details.</td>\n</tr>\n<tr>\n<td>order.posId</td>\n<td>string</td>\n<td>Unique identifier of the Point of Sale. The company making the API call or purchase.</td>\n</tr>\n<tr>\n<td>order.leadGuest</td>\n<td>array</td>\n<td>Guest details. The lead guest of the primary booking in the package.</td>\n</tr>\n<tr>\n<td>order.bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>order.invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookings\">Package Bookings</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bookings</td>\n<td>array</td>\n<td>List of bookings in the package and their details.</td>\n</tr>\n<tr>\n<td>bookings[].eid</td>\n<td>number</td>\n<td>The human-readable booking ID. E.g \"100000\".</td>\n</tr>\n<tr>\n<td>bookings[].customId</td>\n<td>string</td>\n<td>Optional custom ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingId</td>\n<td>string</td>\n<td>The ID of the booking.</td>\n</tr>\n<tr>\n<td>bookings[].active</td>\n<td>boolean</td>\n<td>The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false).</td>\n</tr>\n<tr>\n<td>bookings[].extent</td>\n<td>string</td>\n<td>The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\".</td>\n</tr>\n<tr>\n<td>bookings[].createdDate</td>\n<td>string</td>\n<td>The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].createdUser</td>\n<td>string</td>\n<td>The name of the user who created the booking.</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedDate</td>\n<td>string</td>\n<td>The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\".</td>\n</tr>\n<tr>\n<td>bookings[].lastModifiedUser</td>\n<td>string</td>\n<td>The name of the user who made the most recent modification to the booking.</td>\n</tr>\n<tr>\n<td>bookings[].bookingType</td>\n<td>string</td>\n<td>Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\".</td>\n</tr>\n<tr>\n<td>bookings[].bookingSource</td>\n<td>string</td>\n<td>The company name of the booking source.</td>\n</tr>\n<tr>\n<td>bookings[].notes</td>\n<td>string</td>\n<td>Booking note. Max. character length:  4096.</td>\n</tr>\n<tr>\n<td>bookings[].guestIntranetUrl</td>\n<td>string</td>\n<td>The Guest Intranet page URL for the booking.</td>\n</tr>\n<tr>\n<td>bookings[].hotel</td>\n<td>object</td>\n<td>Details of the hotel associated with the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead.</td>\n</tr>\n<tr>\n<td>bookings[].items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>bookings[].roomStatus</td>\n<td>string</td>\n<td>The room status of a booking. Indicates whether the booking is a standard reservation or a blocked date. Possible values: STD (standard), OOS (blocked date), OOO (blocked date)</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackagebookingitems\">Package Booking Items</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>items</td>\n<td>array</td>\n<td>List of booking items, with their booking details and product option selections.</td>\n</tr>\n<tr>\n<td>items[].roomType</td>\n<td>string</td>\n<td>Details of the room type associated with the booking.</td>\n</tr>\n<tr>\n<td>items[].checkIn</td>\n<td>string</td>\n<td>The check-in date for the booking item.</td>\n</tr>\n<tr>\n<td>items[].checkOut</td>\n<td>string</td>\n<td>The check-out date for the booking item.</td>\n</tr>\n<tr>\n<td>items[].numberGuests</td>\n<td>number</td>\n<td>The number of guests of a room in a booking.</td>\n</tr>\n<tr>\n<td>items[].priceRetail</td>\n<td>number</td>\n<td>The gross price of the room type.</td>\n</tr>\n<tr>\n<td>items[].priceRack</td>\n<td>number</td>\n<td>The gross price after price adjustments.</td>\n</tr>\n<tr>\n<td>items[].priceNet</td>\n<td>number</td>\n<td>The gross price after commission.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"miscpackageinvoicepayments\">Package Invoice Payments</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>invoicePayments</td>\n<td>array</td>\n<td>List of package invoice details.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceNumber</td>\n<td>string</td>\n<td>The human-readable invoice number, suffix increments with each invoice. E.g \"100000-1\".</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceId</td>\n<td>string</td>\n<td>Unique identifier of the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[].invoiceDate</td>\n<td>string</td>\n<td>The date the invoice was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceAmount</td>\n<td>number</td>\n<td>The amount billed on the invoice.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceDueDate</td>\n<td>string</td>\n<td>The date the invoice is due. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceCreatedDate</td>\n<td>string</td>\n<td>The date the invoice was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceModifiedDate</td>\n<td>string</td>\n<td>The date the invoice was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .invoiceNotes</td>\n<td>string</td>\n<td>Invoice note. Max. character length:  128.</td>\n</tr>\n<tr>\n<td>invoicePayments[].paymentId</td>\n<td>string</td>\n<td>Payment ID registered on the invoice payment. Max. character length:  32.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentDate</td>\n<td>string</td>\n<td>The date the invoice payment was registered for. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentAmount</td>\n<td>number</td>\n<td>The amount of the invoice payment.</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentMethod</td>\n<td>string</td>\n<td>The type of payment method. See \"Payment Methods\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentCreatedBy</td>\n<td>string</td>\n<td>The name of the user that created the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentCreatedDate</td>\n<td>string</td>\n<td>The date the invoice payment was created. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentModifiedBy</td>\n<td>string</td>\n<td>The name of the user that last modified the invoice payment. E.g \"James F\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentModifiedDate</td>\n<td>string</td>\n<td>The date the invoice payment was last modified. Format: \"YYYY-MM-DD\".</td>\n</tr>\n<tr>\n<td>invoicePayments[] .paymentNotes</td>\n<td>string</td>\n<td>Payment note. Max. character length:  128.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"miscresponsevalidationerrors\">Response Validation Errors</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Error Message</strong></th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Please provide a valid hotel ID</td>\n<td>The request is missing a valid hotelId. A valid hotel identifier must be provided.</td>\n</tr>\n<tr>\n<td>Please provide at least one room type.</td>\n<td>The booking request must include at least one roomType.</td>\n</tr>\n<tr>\n<td>The requested room types must belong to the same vendor.</td>\n<td>All selected roomTypes must be from the same hotel to proceed with the booking.</td>\n</tr>\n<tr>\n<td>The booking extent can only be REQUEST or RESERVATION for vendor/portal bookings.</td>\n<td>For vendor or portal bookings, REQUEST_INTERNAL booking extent is not allowed.</td>\n</tr>\n<tr>\n<td>The booking extent RESERVATION is not enabled for portal bookings</td>\n<td>Portal bookings do not support the RESERVATION extent type for this hotel.</td>\n</tr>\n<tr>\n<td>The booking extent can only be REQUEST, REQUEST_INTERNAL or RESERVATION.</td>\n<td>The provided bookingExtent value is invalid. It must be one of: REQUEST, REQUEST_INTERNAL, or RESERVATION.</td>\n</tr>\n<tr>\n<td>One of the selected room types is currently inactive.</td>\n<td>At least one of the chosen roomTypes is inactive and cannot be booked.</td>\n</tr>\n<tr>\n<td>One or more of the requested room types cannot be booked due to the lack of permissions by the vendor.</td>\n<td>The agent does not have the required permissions to book one or more of the selected roomTypes.</td>\n</tr>\n<tr>\n<td>The number of check-in dates provided does not match the number of room types.</td>\n<td>The number of checkInDates should align with the number of roomTypes in the request.</td>\n</tr>\n<tr>\n<td>The number of check-out dates provided does not match the number of room types.</td>\n<td>The number of checkOutDatesshould align with the number of roomTypes.</td>\n</tr>\n<tr>\n<td>The number of guest head counts provided does not match the number of room types.</td>\n<td>The total guest count (numberGuests) should align with the number of roomTypes in the booking.</td>\n</tr>\n<tr>\n<td>The number of maximum retail prices provided does not match the number of room types.</td>\n<td>The number of priceRetailMax values should align with the number of roomTypes.</td>\n</tr>\n<tr>\n<td>Please provide the guest's given name</td>\n<td>The booking request must include guestGivenName.</td>\n</tr>\n<tr>\n<td>Please provide the guest's family name</td>\n<td>The booking request must include guestFamilyName.</td>\n</tr>\n<tr>\n<td>The check-in date must be at least day(s) in advance.</td>\n<td>The checkInDate must be set at least X days in advance.</td>\n</tr>\n<tr>\n<td>One of the given check-in dates was of an invalid format. Please follow the yyyyMMdd format. (ex. 19700101)</td>\n<td>A checkInDate is incorrectly formatted. It should follow the yyyyMMdd format.</td>\n</tr>\n<tr>\n<td>One of the given check-out dates was of an invalid format. Please follow the yyyyMMdd format. (ex. 19700101)</td>\n<td>A checkOutDate is incorrectly formatted. It should follow the yyyyMMdd format.</td>\n</tr>\n<tr>\n<td>Maximum booking duration is 180 nights</td>\n<td>The stay duration cannot exceed 180 nights.</td>\n</tr>\n<tr>\n<td>Please provide number of adults in each room.</td>\n<td>If hotel.recordGuestType is enabled, the request must specify numberAdults for each roomType.</td>\n</tr>\n<tr>\n<td>Please provide number of children in each room.</td>\n<td>If hotel.recordGuestType is enabled, the request must specify numberChildren for each roomType.</td>\n</tr>\n<tr>\n<td>Please provide number of infants in each room.</td>\n<td>If hotel.recordGuestType is enabled, the request must specify numberInfants for each roomType.</td>\n</tr>\n<tr>\n<td>The room type can hold a maximum of guests only.</td>\n<td>The total numberGuests exceeds the maximum allowed capacity (maxNumberGuests) for the roomType.</td>\n</tr>\n<tr>\n<td>Total number of guests differs from total number of adults and number of children</td>\n<td>If hotel.recordGuestType is enabled, the sum of numberAdults and numberChildren must equal numberGuests.</td>\n</tr>\n<tr>\n<td>The guest gender is invalid. Please choose between MALE, FEMALE or OTHER.</td>\n<td>The provided guest gender value is invalid and must be MALE, FEMALE, or OTHER.</td>\n</tr>\n<tr>\n<td>The guest nationality is invalid. Please use the ISO 3166 country codes.</td>\n<td>The guest nationality (country) value must follow the ISO 3166 country code format.</td>\n</tr>\n<tr>\n<td>The guest date of birth was of an invalid format. Please follow the yyyyMMdd format. (ex. 19700101)</td>\n<td>The guest date of birth (dob) must be in the yyyyMMdd format.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["createBooking"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>Specify the hotel ID of the hotel.</p>\n","type":"text/plain"},"key":"hotelId","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest.</p>\n","type":"text/plain"},"key":"adminRegion","value":""},{"disabled":true,"description":{"content":"<p>Optional: {{description.createBooking.bookingSegment}}</p>\n","type":"text/plain"},"key":"bookingSegment","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the address line 1 of the guest.</p>\n","type":"text/plain"},"key":"address1","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the address line 2 of the guest.</p>\n","type":"text/plain"},"key":"address2","value":""},{"disabled":true,"description":{"content":"<p>Optional: The extent of the booking. Can be REQUEST_INTERNAL, REQUEST, RESERVATION. This parameter is optional; the default is assumed to be RESERVATION. The booking extent cannot be set to REQUEST_INTERNAL if it is a direct booking.</p>\n","type":"text/plain"},"key":"bookingExtent","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the city of the guest.</p>\n","type":"text/plain"},"key":"city","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss.</p>\n","type":"text/plain"},"key":"comment","value":""},{"disabled":true,"description":{"content":"<p>Optional: {{description.createBooking.company}}</p>\n","type":"text/plain"},"key":"company","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the contact number of the guest.</p>\n","type":"text/plain"},"key":"contactNumber","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)</p>\n","type":"text/plain"},"key":"country","value":""},{"disabled":true,"description":{"content":"<p>Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional.</p>\n","type":"text/plain"},"key":"customId","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the dietary restrictions of the guest.</p>\n","type":"text/plain"},"key":"dietRestrictions","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which allows the use of a discount code for the booking. If the discount code is invalid, then the booking is created without the application of the discount. No specific feedback is shown at present to determine if the discount code was successfully used or not.</p>\n","type":"text/plain"},"key":"discountCode","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API.</p>\n","type":"text/plain"},"key":"dob","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the emergency contact name of the guest</p>\n","type":"text/plain"},"key":"emContactName","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the emergency contact number of the guest.</p>\n","type":"text/plain"},"key":"emContactTel","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER.</p>\n","type":"text/plain"},"key":"gender","value":""},{"disabled":true,"description":{"content":"<p>Optional: The email address of the lead guest. This parameter is optional.</p>\n","type":"text/plain"},"key":"guestEmail","value":""},{"disabled":true,"description":{"content":"<p>The family name / last name of the lead guest.</p>\n","type":"text/plain"},"key":"guestFamilyName","value":""},{"disabled":true,"description":{"content":"<p>The given name / first name of the lead guest.</p>\n","type":"text/plain"},"key":"guestGivenName","value":""},{"disabled":true,"description":{"content":"<p>Optional: {{description.createBooking.height}}</p>\n","type":"text/plain"},"key":"height","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the locale language of the guest.</p>\n","type":"text/plain"},"key":"lang","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the postcode of the guest.</p>\n","type":"text/plain"},"key":"postcode","value":""},{"disabled":true,"description":{"content":"<p>Must be `ota` and indicates new OTA style rate plans should be used.</p>\n","type":"text/plain"},"key":"rate","value":""},{"disabled":true,"description":{"content":"<p>Optional: {{description.createBooking.weight}}</p>\n","type":"text/plain"},"key":"weight","value":""},{"disabled":true,"description":{"content":"<p>Optional: This is an optional parameter which sets the Widget URL of the booking. This is useful to store a URL with the booking to determine its source.</p>\n","type":"text/plain"},"key":"widgetUrl","value":""},{"disabled":true,"description":{"content":"<p>Specify the check-in date of a room in the booking. Format: yyyyMMdd</p>\n","type":"text/plain"},"key":"items.checkIn","value":""},{"disabled":true,"description":{"content":"<p>Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.</p>\n","type":"text/plain"},"key":"items.checkOut","value":""},{"disabled":true,"description":{"content":"<p>Specifies the number of adults of a room in the booking. If recordGuestType is enabled, this parameter must be set as 1 or more, and may not exceed the maxNumberGuests or maxNumberAdults of the room type.</p>\n","type":"text/plain"},"key":"items.numberAdults","value":""},{"disabled":true,"description":{"content":"<p>Specifies the number of children of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberChildren of the room type.</p>\n","type":"text/plain"},"key":"items.numberChildren","value":""},{"disabled":true,"description":{"content":"<p>Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n</p>\n","type":"text/plain"},"key":"items.numberGuests","value":""},{"disabled":true,"description":{"content":"<p>Specifies the number of infants of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberInfants of the room type.</p>\n","type":"text/plain"},"key":"items.numberInfants","value":""},{"disabled":true,"description":{"content":"<p>The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing.</p>\n","type":"text/plain"},"key":"items.priceRetailMax","value":""},{"disabled":true,"description":{"content":"<p>Index reference of the product option. </p>\n","type":"text/plain"},"key":"items.productOptions.position","value":""},{"disabled":true,"description":{"content":"<p>Selected value for the product option.</p>\n","type":"text/plain"},"key":"items.productOptions.value","value":""},{"disabled":true,"description":{"content":"<p>This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids.</p>\n","type":"text/plain"},"key":"items.ratePlanId","value":""},{"disabled":true,"description":{"content":"<p>Specify the room type of the first room to book.</p>\n","type":"text/plain"},"key":"items.roomTypeId","value":""}],"variable":[]}},"response":[{"id":"3e843348-00a0-46bd-aa24-3226bb9a4961","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"hotelId\": \"ff8081811b103444011b10344bb30001\",\n  \"adminRegion\": \"Japan\",\n  \"bookingSegment\": \"mysegment\",\n  \"address1\": \"address1\",\n  \"address2\": \"address2\",\n  \"bookingExtent\": \"REQUEST\",\n  \"city\": \"city\",\n  \"comment\": \"comment\",\n  \"company\": \"company\",\n  \"contactNumber\": \"contactnumber\",\n  \"country\": \"JP\",\n  \"customId\": \"customid\",\n  \"dietRestrictions\": \"dietary\",\n  \"discountCode\": \"mypromo\",\n  \"dob\": \"20000101\",\n  \"emContactName\": \"emergencycontactname\",\n  \"emContactTel\": \"emergencycontacttel\",\n  \"gender\": \"MALE\",\n  \"guestEmail\": \"guestemail@email.com\",\n  \"guestFamilyName\": \"guestfamilyname\",\n  \"guestGivenName\": \"guestgivenname\",\n  \"height\": \"100\",\n  \"lang\": \"en\",\n  \"postcode\": \"postcode\",\n  \"rate\": \"ota\",\n  \"weight\": \"100\",\n  \"widgetUrl\": \"mywidgeturl\",\n  \"items\": [\n    {\n      \"checkIn\": \"20250625\",\n      \"checkOut\": \"20250626\",\n      \"numberAdults\": \"2\",\n      \"numberChildren\": \"2\",\n      \"numberGuests\": \"4\",\n      \"numberInfants\": \"1\",\n      \"priceRetailMax\": \"100\",\n      \"productOptions\": [\n        {\n          \"position\": \"2\",\n          \"value\": \"2\"\n        },\n        {\n          \"position\": \"3\",\n          \"value\": \"2\"\n        }\n      ],\n      \"ratePlanId\": \"1\",\n      \"roomTypeId\": \"ff8081811c21f6e4011c220306020001\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"hotelId","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel.","disabled":true},{"key":"adminRegion","value":"Japan","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest.","disabled":true},{"key":"bookingSegment","value":"mysegment","description":"Optional: {{description.createBooking.bookingSegment}}","disabled":true},{"key":"address1","value":"address1","description":"Optional: This is an optional parameter which sets the address line 1 of the guest.","disabled":true},{"key":"address2","value":"address2","description":"Optional: This is an optional parameter which sets the address line 2 of the guest.","disabled":true},{"key":"bookingExtent","value":"REQUEST","description":"Optional: The extent of the booking. Can be REQUEST_INTERNAL, REQUEST, RESERVATION. This parameter is optional; the default is assumed to be RESERVATION. The booking extent cannot be set to REQUEST_INTERNAL if it is a direct booking.","disabled":true},{"key":"city","value":"city","description":"Optional: This is an optional parameter which sets the city of the guest.","disabled":true},{"key":"comment","value":"comment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss.","disabled":true},{"key":"company","value":"roomboss","description":"Optional: {{description.createBooking.company}}","disabled":true},{"key":"contactNumber","value":"contactnumber","description":"Optional: This is an optional parameter which sets the contact number of the guest.","disabled":true},{"key":"country","value":"JP","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)","disabled":true},{"key":"customId","value":"customid","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional.","disabled":true},{"key":"dietRestrictions","value":"dietary","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest.","disabled":true},{"key":"discountCode","value":"mypromo","description":"Optional: This is an optional parameter which allows the use of a discount code for the booking. If the discount code is invalid, then the booking is created without the application of the discount. No specific feedback is shown at present to determine if the discount code was successfully used or not.","disabled":true},{"key":"dob","value":"20000101","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API.","disabled":true},{"key":"emContactName","value":"emergencycontactname","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest","disabled":true},{"key":"emContactTel","value":"emergencycontacttel","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest.","disabled":true},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER.","disabled":true},{"key":"guestEmail","value":"guestemail@email.com","description":"Optional: The email address of the lead guest. This parameter is optional.","disabled":true},{"key":"guestFamilyName","value":"guestfamilyname","description":"The family name / last name of the lead guest.","disabled":true},{"key":"guestGivenName","value":"guestgivenname","description":"The given name / first name of the lead guest.","disabled":true},{"key":"height","value":"100","description":"Optional: {{description.createBooking.height}}","disabled":true},{"key":"lang","value":"en","description":"Optional: This is an optional parameter which sets the locale language of the guest.","disabled":true},{"key":"postcode","value":"postcode","description":"Optional: This is an optional parameter which sets the postcode of the guest.","disabled":true},{"key":"rate","value":"ota","description":"Must be `ota` and indicates new OTA style rate plans should be used.","disabled":true},{"key":"weight","value":"100","description":"Optional: {{description.createBooking.weight}}","disabled":true},{"key":"widgetUrl","value":"mywidgeturl","description":"Optional: This is an optional parameter which sets the Widget URL of the booking. This is useful to store a URL with the booking to determine its source.","disabled":true},{"key":"items[0].checkIn","value":"20250625","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd","disabled":true},{"key":"items[0].checkOut","value":"20250626","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date.","disabled":true},{"key":"items[0].numberAdults","value":"2","description":"Specifies the number of adults of a room in the booking. If recordGuestType is enabled, this parameter must be set as 1 or more, and may not exceed the maxNumberGuests or maxNumberAdults of the room type.","disabled":true},{"key":"items[0].numberChildren","value":"2","description":"Specifies the number of children of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberChildren of the room type.","disabled":true},{"key":"items[0].numberGuests","value":"4","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n","disabled":true},{"key":"items[0].numberInfants","value":"1","description":"Specifies the number of infants of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberInfants of the room type.","disabled":true},{"key":"items[0].priceRetailMax","value":"100","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing.","disabled":true},{"key":"items[0].productOptions.position","value":"2","description":"Index reference of the product option. ","disabled":true},{"key":"items[0].productOptions.value","value":"2","description":"Selected value for the product option.","disabled":true},{"key":"items[0].ratePlanId","value":"1","description":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids.","disabled":true},{"key":"items[0].roomTypeId","value":"ff8081811c21f6e4011c220306020001","description":"Specify the room type of the first room to book.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"order\": {\n        \"posId\": \"ff8081811b0af2d8011b0af2e0430001\",\n        \"leadGuest\": {\n            \"title\": null,\n            \"guestId\": null,\n            \"givenName\": \"guestgivenname\",\n            \"familyName\": \"guestfamilyname\",\n            \"email\": \"guestemail@email.com\",\n            \"additionalEmail\": null,\n            \"gender\": \"MALE\",\n            \"nationality\": \"JP\",\n            \"age\": 0,\n            \"phoneNumber\": \"contactnumber\",\n            \"dateOfBirth\": \"2000-01-01\",\n            \"height\": 100,\n            \"weight\": 100,\n            \"postcode\": \"postcode\",\n            \"administrativeRegion\": \"Japan\",\n            \"city\": \"city\",\n            \"address1\": \"address1\",\n            \"address2\": \"address2\",\n            \"language\": \"en\",\n            \"dietaryRestrictions\": \"dietary\",\n            \"emergencyContactName\": \"emergencycontactname\",\n            \"emergencyContactTel\": \"emergencycontacttel\",\n            \"medicalIssues\": null\n        },\n        \"bookings\": [\n            {\n                \"eId\": 100018,\n                \"customId\": \"customid\",\n                \"bookingId\": \"ff808181979bbc6b01979bcb01640066\",\n                \"active\": true,\n                \"extent\": \"REQUEST\",\n                \"items\": [\n                    {\n                        \"endDate\": 1750896000000,\n                        \"priceRetail\": 10000,\n                        \"priceRack\": 10000,\n                        \"priceNet\": 10000,\n                        \"priceSell\": 0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"roomType\": {\n                            \"roomTypeId\": \"ff8081811c21f6e4011c220306020001\",\n                            \"roomTypeName\": \"2 BDR\",\n                            \"maxNumberGuests\": 4,\n                            \"numberBedrooms\": 2,\n                            \"numberBathrooms\": 2,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"checkIn\": \"2025-06-25\",\n                        \"checkOut\": \"2025-06-26\",\n                        \"arrivalTime\": null,\n                        \"departureTime\": null,\n                        \"numberGuests\": 4,\n                        \"numberAdults\": 2,\n                        \"numberChildren\": 2,\n                        \"numberInfants\": 1\n                    }\n                ],\n                \"createdDate\": \"2025-06-23T07:57:42.103+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": null,\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": null,\n                \"notes\": \"comment\",\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\n                \"hotel\": {\n                    \"url\": null,\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.8556,\n                    \"longitude\": 140.7078,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"ff8081811b103444011b10344bb30001\",\n                    \"hotelName\": \"Block 1\",\n                    \"hotelUrl\": null,\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"ff8081811c21f6e4011c220306020001\",\n                            \"roomTypeName\": \"2 BDR\",\n                            \"maxNumberGuests\": 4,\n                            \"numberBedrooms\": 2,\n                            \"numberBathrooms\": 2,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"ff80818132ecdff00132ecf4f94b0001\",\n                            \"roomTypeName\": \"2 BDR Config\",\n                            \"maxNumberGuests\": 2,\n                            \"numberBedrooms\": 2,\n                            \"numberBathrooms\": 2,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"ff8081811c21f6e4011c2203591d0002\",\n                            \"roomTypeName\": \"3 BDR\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 3,\n                            \"numberBathrooms\": 3,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            }\n        ],\n        \"invoicePayments\": []\n    }\n}"},{"id":"ec3ffd1a-e512-4793-9274-4baeee87eaac","name":"Success - Multiple Rooms","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?numberGuests=3&priceRetailMax=28000&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789&customId=RGB8007456&roomTypeId=2c98902a54bb76cc0154cba342c34378&hotelId=f808ad963f54211d013f65b88d7b35a9&checkIn=20260322&checkOut=20260326&roomTypeId=f808ad963f54211d013f65b88d7b35aa&checkIn=20260322&checkOut=20260326&numberGuests=1&rate=ota&ratePlanId=432872&ratePlanId=432872","protocol":"https","host":["api","roomboss","com"],"path":["extws","hotel","v1","createBooking"],"query":[{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."},{"key":"customId","value":"RGB8007456","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"roomTypeId","value":"2c98902a54bb76cc0154cba342c34378","description":"Specify the room type of the first room to book."},{"key":"hotelId","value":"f808ad963f54211d013f65b88d7b35a9","description":"Specify the hotel ID of the hotel."},{"key":"checkIn","value":"20260322","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20260326","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"roomTypeId","value":"f808ad963f54211d013f65b88d7b35aa","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20260322","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20260326","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"1","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"rate","value":"ota","description":"Must be `ota` and indicates new OTA style rate plans should be used."},{"key":"ratePlanId","value":"432872","description":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids."},{"key":"ratePlanId","value":"432872","description":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null,\n    \"order\": {\n        \"posId\": \"4028808c11f7ee4d0111f7ee55980001\",\n        \"leadGuest\": {\n            \"title\": null,\n            \"guestId\": null,\n            \"givenName\": \"Will\",\n            \"familyName\": \"Werdsworth\",\n            \"email\": \"willwerds8253b@gmail.com\",\n            \"additionalEmail\": null,\n            \"gender\": \"MALE\",\n            \"nationality\": \"AG\",\n            \"age\": 0,\n            \"phoneNumber\": \"81123456789\",\n            \"dateOfBirth\": \"1950-01-02\",\n            \"height\": null,\n            \"weight\": null,\n            \"postcode\": \"044-0123\",\n            \"administrativeRegion\": \"Hokkaido\",\n            \"city\": \"Kutchan\",\n            \"address1\": \"29, Wallaby Way\",\n            \"address2\": \"Central Business District\",\n            \"language\": \"JA\",\n            \"dietaryRestrictions\": \"Vegetarian and no nuts\",\n            \"emergencyContactName\": \"Parry Hotter\",\n            \"emergencyContactTel\": \"81123456789\",\n            \"medicalIssues\": null\n        },\n        \"bookings\": [\n            {\n                \"eId\": 2596456,\n                \"customId\": \"RGB8007456\",\n                \"bookingId\": \"8a80818a9ae0553b019ae3395db506b1\",\n                \"active\": true,\n                \"extent\": \"RESERVATION\",\n                \"roomStatus\": null,\n                \"items\": [\n                    {\n                        \"endDate\": 1774483200000,\n                        \"priceRetail\": 40000.0,\n                        \"priceRack\": 40000.0,\n                        \"priceNet\": 40000.0,\n                        \"priceSell\": 0.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9ae0553b019ae3395db506b3\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-22\",\n                        \"checkOut\": \"2026-03-26\",\n                        \"arrivalTime\": null,\n                        \"departureTime\": null,\n                        \"numberGuests\": 3,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": null,\n                        \"checkedOut\": null,\n                        \"roomNote\": null,\n                        \"ratePlan\": null,\n                        \"productOptions\": null\n                    },\n                    {\n                        \"endDate\": 1774483200000,\n                        \"priceRetail\": 40000.0,\n                        \"priceRack\": 40000.0,\n                        \"priceNet\": 40000.0,\n                        \"priceSell\": 0.0,\n                        \"parentCategory\": null,\n                        \"category\": null,\n                        \"itemId\": \"8a80818a9ae0553b019ae3395db506b9\",\n                        \"roomType\": {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        \"roomNumber\": null,\n                        \"resourceId\": null,\n                        \"checkIn\": \"2026-03-22\",\n                        \"checkOut\": \"2026-03-26\",\n                        \"arrivalTime\": null,\n                        \"departureTime\": null,\n                        \"numberGuests\": 1,\n                        \"numberAdults\": null,\n                        \"numberChildren\": null,\n                        \"numberInfants\": null,\n                        \"checkedIn\": null,\n                        \"checkedOut\": null,\n                        \"roomNote\": null,\n                        \"ratePlan\": null,\n                        \"productOptions\": null\n                    }\n                ],\n                \"createdDate\": \"2025-12-03T07:59:38.862+0000\",\n                \"createdUser\": null,\n                \"lastModifiedDate\": null,\n                \"lastModifiedUser\": null,\n                \"bookingType\": \"ACCOMMODATION\",\n                \"bookingSource\": null,\n                \"notes\": \"testComment\",\n                \"discountCode\": null,\n                \"guestIntranetUrl\": \"https://cw4.roomboss.com/public/yourbooking.jsf\",\n                \"hotel\": {\n                    \"url\": \"alpinelodge.co.jp\",\n                    \"vendorType\": \"ACCOMMODATION\",\n                    \"countryCode\": \"JP\",\n                    \"locationCode\": \"NISEKO_HIRAFU\",\n                    \"latitude\": 42.864,\n                    \"longitude\": 140.704,\n                    \"currencyCode\": \"JPY\",\n                    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n                    \"hotelName\": \"Alpine Lodge\",\n                    \"hotelUrl\": \"alpinelodge.co.jp\",\n                    \"internalInventory\": true,\n                    \"recordGuestType\": null,\n                    \"maxAgeChildren\": 0,\n                    \"maxAgeInfants\": 0,\n                    \"roomTypes\": [\n                        {\n                            \"roomTypeId\": \"f808ad963f54211d013f65b88d7b35aa\",\n                            \"roomTypeName\": \"Family Room\",\n                            \"maxNumberGuests\": 6,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        },\n                        {\n                            \"roomTypeId\": \"2c98902a54bb76cc0154cba342c34378\",\n                            \"roomTypeName\": \"Tatami Room\",\n                            \"maxNumberGuests\": 5,\n                            \"numberBedrooms\": 1,\n                            \"numberBathrooms\": 1,\n                            \"maxNumberAdults\": 0,\n                            \"maxNumberChildren\": 0,\n                            \"maxNumberInfants\": 0\n                        }\n                    ]\n                }\n            }\n        ],\n        \"invoicePayments\": [\n            {\n                \"invoiceNumber\": \"2596456-1-WEB\",\n                \"invoiceId\": \"8a80818a9ae0553b019ae339602906ce\",\n                \"invoiceDate\": \"2025-12-03\",\n                \"invoiceAmount\": 16000.0,\n                \"invoiceDueDate\": \"2025-12-03\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            },\n            {\n                \"invoiceNumber\": \"2596456-2-WEB\",\n                \"invoiceId\": \"8a80818a9ae0553b019ae339607406d1\",\n                \"invoiceDate\": \"2025-12-03\",\n                \"invoiceAmount\": 64000.0,\n                \"invoiceDueDate\": \"2025-12-31\",\n                \"invoiceCreatedBy\": null,\n                \"invoiceCreatedDate\": null,\n                \"invoiceModifiedBy\": null,\n                \"invoiceModifiedDate\": null,\n                \"invoiceNotes\": null,\n                \"paymentId\": null,\n                \"paymentDate\": null,\n                \"paymentAmount\": 0.0,\n                \"paymentMethod\": null,\n                \"paymentCreatedBy\": null,\n                \"paymentCreatedDate\": null,\n                \"paymentModifiedBy\": null,\n                \"paymentModifiedDate\": null,\n                \"paymentNotes\": null\n            }\n        ]\n    }\n}"},{"id":"1d7a2f2b-f5bd-48e2-b37b-5f3e5d9c281a","name":"Validation Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270321&numberGuests=3&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the hotel ID of the hotel."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"Please provide a valid hotel ID\"\n}"},{"id":"aa83564e-913c-4f9e-b7dd-c1b64e1eae50","name":"Unset Rates","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&hotelID=ff8081811b103444011b10344bb30001&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20180315&checkOut=20180321&numberGuests=3&priceRetailMax=28000&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20180315&checkOut=20180321&numberGuests=1&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"hotelID","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20180315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20180321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20180315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20180321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"1","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The booking cannot be made as rates have not been set for one or more of the specified room types for one or more of the specified periods.\"\n}"},{"id":"649b6ad9-e14a-4baf-9775-849638c7413e","name":"Rate Mismatch","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&hotelID=ff8081811b103444011b10344bb30001&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270321&numberGuests=3&priceRetailMax=28000&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270321&numberGuests=1&priceRetailMax=200&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"hotelID","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270321","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"1","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"200","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"The offer price was higher than the maximum retail price specified.\"\n}"},{"id":"61101cb8-6505-4156-af8f-b8e69a4456d9","name":"Invalid Stay Length","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/createBooking?customId=RGB80074&hotelID=ff8081811b103444011b10344bb30001&roomTypeId=ff8081811b103444011b10344bb23451&checkIn=20270315&checkOut=20270315&numberGuests=3&priceRetailMax=28000&guestGivenName=Will&guestFamilyName=Werdsworth&guestEmail=willwerds8253b@gmail.com&comment=testComment&gender=MALE&country=AG&dob=19500102&contactNumber=81123456789&postcode=044-0123&adminRegion=Hokkaido&city=Kutchan&address1=29%2C+Wallaby+Way&address2=Central+Business+District&lang=JA&dietRestrictions=Vegetarian+and+no+nuts&emContactName=Parry+Hotter&emContactTel=81123456789","host":["https://api.roomboss.com/extws/hotel/v1"],"path":["createBooking"],"query":[{"key":"customId","value":"RGB80074","description":"Optional: Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"key":"hotelID","value":"ff8081811b103444011b10344bb30001","description":"Specify the hotel ID of the hotel."},{"key":"roomTypeId","value":"ff8081811b103444011b10344bb23451","description":"Specify the room type of the first room to book."},{"key":"checkIn","value":"20270315","description":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"key":"checkOut","value":"20270315","description":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"key":"numberGuests","value":"3","description":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"key":"priceRetailMax","value":"28000","description":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"key":"guestGivenName","value":"Will","description":"The given name / first name of the lead guest."},{"key":"guestFamilyName","value":"Werdsworth","description":"The family name / last name of the lead guest."},{"key":"guestEmail","value":"willwerds8253b@gmail.com","description":"Optional: The email address of the lead guest. This parameter is optional."},{"key":"comment","value":"testComment","description":"Optional: This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"key":"gender","value":"MALE","description":"Optional: This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"key":"country","value":"AG","description":"Optional: This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"key":"dob","value":"19500102","description":"Optional: This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"key":"contactNumber","value":"81123456789","description":"Optional: This is an optional parameter which sets the contact number of the guest."},{"key":"postcode","value":"044-0123","description":"Optional: This is an optional parameter which sets the postcode of the guest."},{"key":"adminRegion","value":"Hokkaido","description":"Optional: This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"key":"city","value":"Kutchan","description":"Optional: This is an optional parameter which sets the city of the guest."},{"key":"address1","value":"29%2C+Wallaby+Way","description":"Optional: This is an optional parameter which sets the address line 1 of the guest."},{"key":"address2","value":"Central+Business+District","description":"Optional: This is an optional parameter which sets the address line 2 of the guest."},{"key":"lang","value":"JA","description":"Optional: This is an optional parameter which sets the locale language of the guest."},{"key":"dietRestrictions","value":"Vegetarian+and+no+nuts","description":"Optional: This is an optional parameter which sets the dietary restrictions of the guest."},{"key":"emContactName","value":"Parry+Hotter","description":"Optional: This is an optional parameter which sets the emergency contact name of the guest"},{"key":"emContactTel","value":"81123456789","description":"Optional: This is an optional parameter which sets the emergency contact number of the guest."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": \"One or more of the booking elements should be at least 1 nights long for a RESERVATION.\"\n}"}],"_postman_id":"ebfe879e-f36b-4a80-8a97-40cdbadae9d2"}],"id":"ab6d4809-e789-4812-a48f-d52e09b8752d","_postman_id":"ab6d4809-e789-4812-a48f-d52e09b8752d","description":""},{"name":"Product","item":[{"name":"Product Options","id":"93f5f1ab-a8fd-4d9e-a611-adb9de16c55b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.roomboss.com/extws/hotel/v1/vendor/productOptions/{vendorId}","description":"<p>This method allows you to return a list of products and their product options, each with the product option ID, position, label, and whether the product option is compulsory; as well as their selectable values.</p>\n<p>Only products with product options are returned.</p>\n<h3 id=\"miscresponsefields\">Response Fields</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>hotelId</td>\n<td>string</td>\n<td>The ID of the hotel.</td>\n</tr>\n<tr>\n<td>products</td>\n<td>array</td>\n<td>A list of products for the hotel, each containing its available options.</td>\n</tr>\n<tr>\n<td>products[].productId</td>\n<td>string</td>\n<td>The ID of the product.</td>\n</tr>\n<tr>\n<td>products[].productOptions</td>\n<td>array</td>\n<td>List of product options and their details.</td>\n</tr>\n<tr>\n<td>apiVersion</td>\n<td>string</td>\n<td>API version used to generate the response.</td>\n</tr>\n<tr>\n<td>success</td>\n<td>boolean</td>\n<td>Indicates whether the request was successful.</td>\n</tr>\n<tr>\n<td>failureMessage</td>\n<td>string/null</td>\n<td>Populated only if the request fails; otherwise <code>null</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h3 id=\"miscproductoptions\">Product Options</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>products[].productOptions</td>\n<td>array</td>\n<td>A list of available product option groups.</td>\n</tr>\n<tr>\n<td>products[].productOptions[].id</td>\n<td>string</td>\n<td>Internal identifier of the item option.</td>\n</tr>\n<tr>\n<td>products[].productOptions[].position</td>\n<td>number</td>\n<td>Index reference of the product option. </td>\n</tr>\n<tr>\n<td>products[].productOptions[].label</td>\n<td>string</td>\n<td>The label describing a product option. E.g \"Skill Level\", or \"Number of Days\". *</td>\n</tr>\n<tr>\n<td>products[].productOptions[].compulsory</td>\n<td>boolean</td>\n<td>When true, a value for this product option is required in order to book the product.</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h3 id=\"product-option-select-items\">Product Option: Select Items</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field Path</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>selectItems</td>\n<td>array</td>\n<td>A list of options from which the product option value can be selected. Provided if the product option input type is \"DROP_DOWN\".</td>\n</tr>\n<tr>\n<td>selectItems[].label</td>\n<td>string</td>\n<td>The label of the select item option. E.g \"Beginner\", or \"2 Days\". *</td>\n</tr>\n<tr>\n<td>selectItems[].value</td>\n<td>number/null</td>\n<td>The value of the select item option. E.g \"Beginner\", or 2.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["vendor","productOptions","{vendorId}"],"host":["https://api.roomboss.com/extws/hotel/v1"],"query":[{"disabled":true,"description":{"content":"<p>The ID of the target vendor.</p>\n","type":"text/plain"},"key":"vendorId","value":""},{"disabled":true,"description":{"content":"<p>Optional: Specify the language to return. Legal values are {\"en\",\"ja\",\"fr\",\"zh-cn\",\"zh\",\"ko\"}.\nNote the hotel name has entered in just 1 language; value won't change as the local parameter is changed. (We should address this in the future.)\nNote it will return English text if there is no text for the selected language.\n</p>\n","type":"text/plain"},"key":"locale","value":""}],"variable":[]}},"response":[{"id":"50f3fbf9-d88e-467e-a713-3525ca83c40a","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.roomboss.com/extws/hotel/v1/vendor/productOptions/f808ad963f54211d013f65b88d7b35a9","protocol":"https","host":["api","roomboss","com"],"path":["extws","hotel","v1","vendor","productOptions","f808ad963f54211d013f65b88d7b35a9"],"query":[{"key":"vendorId","value":null,"disabled":true},{"key":"locale","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n    \"hotelId\": \"f808ad963f54211d013f65b88d7b35a9\",\n    \"products\": [\n        {\n            \"productId\": \"f808ad963f54211d013f65b88d7b35aa\",\n            \"productOptions\": [\n                {\n                    \"id\": \"f808ad963f54211d013f65bb764f35af\",\n                    \"position\": 1,\n                    \"label\": \"Bedding\",\n                    \"selectItems\": [\n                        {\n                            \"label\": \"-- Please Select --\",\n                            \"value\": null\n                        },\n                        {\n                            \"label\": \"King\",\n                            \"value\": 1\n                        },\n                        {\n                            \"label\": \"Twin\",\n                            \"value\": 2\n                        },\n                        {\n                            \"label\": \"Superior\",\n                            \"value\": 3\n                        }\n                    ],\n                    \"compulsory\": true\n                }\n            ]\n        }\n    ],\n    \"apiVersion\": \"1.1\",\n    \"success\": true,\n    \"failureMessage\": null\n}"}],"_postman_id":"93f5f1ab-a8fd-4d9e-a611-adb9de16c55b"}],"id":"d5eb126a-219a-4921-9c76-87453d8a02c1","_postman_id":"d5eb126a-219a-4921-9c76-87453d8a02c1","description":""},{"name":"Webhooks","item":[{"name":"Booking Update Notification","id":"068ee280-b297-44d2-9452-99f1257647a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://webhook-endpoint.example.com/booking-update","description":"<h2 id=\"overview\">Overview</h2>\n<p>Our webhook system automatically notifies your application when bookings are created, modified, or cancelled within 7 days of check-in. This enables real-time synchronization between our system and yours.</p>\n<h2 id=\"how-it-works\">How It Works</h2>\n<p>When a booking change occurs that meets the notification criteria, we send an HTTPS POST request to your registered webhook endpoint with the complete booking details.</p>\n<h2 id=\"notification-triggers\">Notification Triggers</h2>\n<p>You'll receive webhook notifications when:</p>\n<ul>\n<li><p><strong>New bookings created</strong> with check-in within the next 7 days</p>\n</li>\n<li><p><strong>Check-in or check-out dates modified</strong> for bookings within the 7-day window</p>\n</li>\n<li><p><strong>Room allocations assigned</strong> for bookings checking in within 7 days</p>\n</li>\n<li><p><strong>Booking status changes</strong> between Request and Reservation (within the 7-day window)</p>\n</li>\n<li><p><strong>Bookings cancelled</strong> that were scheduled to check in within 7 days</p>\n</li>\n</ul>\n<h2 id=\"notification-window\">Notification Window</h2>\n<ul>\n<li><p><strong>Timeframe</strong>: 7 days before check-in date</p>\n</li>\n<li><p><strong>Timezone</strong>: All dates calculated using your company's configured timezone</p>\n</li>\n<li><p><strong>Booking types</strong>: Accommodation bookings only</p>\n</li>\n</ul>\n<h2 id=\"webhook-payload-structure\">Webhook Payload Structure</h2>\n<p>Each webhook POST contains a JSON payload matching our standard booking API response format. See <strong>Example Request</strong> for an example of what RoomBoss will push. For more details of the payload, please see <a href=\"https://developers.roomboss.com/#92c47ac0-bc05-4b33-aee9-acd13b5fd869\">here</a>.</p>\n<h2 id=\"security\">Security</h2>\n<p><strong>Authentication</strong>: All webhook requests include HTTP Basic Authentication headers using the credentials you provided during webhook registration.</p>\n<p><strong>HTTPS Required</strong>: Your endpoint must use HTTPS (port 443 or 8443 only).</p>\n<h2 id=\"response-requirements\">Response Requirements</h2>\n<p>Your endpoint must respond to webhook requests. See <strong>Example Request</strong> for an example of what RoomBoss expects to receive.</p>\n<p><strong>Error Handling</strong>: If your endpoint returns a non-200 status code, we'll track the failure but won't automatically retry. Monitor your webhook delivery status through the admin interface.</p>\n<h2 id=\"best-practices\">Best Practices</h2>\n<ol>\n<li><p><strong>Respond quickly</strong>: Return 200 OK immediately, then process the booking asynchronously</p>\n</li>\n<li><p><strong>Validate authentication</strong>: Always verify the Basic Auth credentials match your registration</p>\n</li>\n<li><p><strong>Handle duplicates</strong>: The same booking may trigger multiple webhooks if modified multiple times</p>\n</li>\n<li><p><strong>Log all webhooks</strong>: Keep audit logs of received notifications for debugging</p>\n</li>\n<li><p><strong>Use idempotent processing</strong>: Design your system to handle receiving the same booking update multiple times</p>\n</li>\n</ol>\n<h2 id=\"testing\">Testing</h2>\n<p>Before going live, register a test/staging webhook endpoint to verify:</p>\n<ul>\n<li><p>Your endpoint correctly handles the payload structure</p>\n</li>\n<li><p>Authentication is working</p>\n</li>\n<li><p>Response times are under 5 seconds</p>\n</li>\n<li><p>Error scenarios are handled gracefully</p>\n</li>\n</ul>\n<h2 id=\"rate-limits\">Rate Limits</h2>\n<p>During high-volume periods (e.g., busy booking days), you may receive:</p>\n<ul>\n<li><p>Up to 1000 webhooks per day</p>\n</li>\n<li><p>Bursts of 50+ webhooks within a few minutes</p>\n</li>\n</ul>\n<p>Ensure your endpoint can handle this load.</p>\n<h2 id=\"monitoring\">Monitoring</h2>\n<p>Track these metrics on your side:</p>\n<ul>\n<li><p>Webhook delivery success rate</p>\n</li>\n<li><p>Processing time per webhook</p>\n</li>\n<li><p>Duplicate webhook frequency</p>\n</li>\n<li><p>Failed authentications</p>\n</li>\n</ul>\n<h2 id=\"troubleshooting\">Troubleshooting</h2>\n<p><strong>Not receiving webhooks?</strong></p>\n<ul>\n<li><p>Verify your webhook registration is active</p>\n</li>\n<li><p>Check your endpoint is publicly accessible via HTTPS</p>\n</li>\n<li><p>Confirm no firewall blocking our requests</p>\n</li>\n<li><p>Review authentication credentials</p>\n</li>\n</ul>\n<p><strong>Receiving duplicate notifications?</strong></p>\n<ul>\n<li><p>This is expected behavior when bookings are modified multiple times</p>\n</li>\n<li><p>Implement idempotent processing using booking ID as the key</p>\n</li>\n</ul>\n<p><strong>Missing some bookings?</strong></p>\n<ul>\n<li><p>Webhooks only trigger for bookings within the 7-day check-in window</p>\n</li>\n<li><p>Use the List Bookings by Resource endpoint for complete snapshots</p>\n</li>\n</ul>\n<h2 id=\"support\">Support</h2>\n<p>For webhook registration issues or technical questions, contact our API support team with:</p>\n<ul>\n<li><p>Your company ID</p>\n</li>\n<li><p>Webhook endpoint URL</p>\n</li>\n<li><p>Example webhook payloads (if applicable)</p>\n</li>\n<li><p>Error messages or logs</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["booking-update"],"host":["webhook-endpoint","example","com"],"query":[],"variable":[]}},"response":[{"id":"fffae232-7dc3-48b5-9e3b-f8277ea70a17","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"apiVersion\": \"1.1\",\n  \"success\": true,\n  \"order\": {\n    \"posId\": \"company-id\",\n    \"leadGuest\": {\n      \"givenName\": \"John\",\n      \"familyName\": \"Doe\",\n      \"email\": \"guest@example.com\",\n      ...\n    },\n    \"bookings\": [\n      {\n        \"bookingId\": \"abc123\",\n        \"eId\": 1234567,\n        \"checkIn\": \"2025-10-10\",\n        \"checkOut\": \"2025-10-12\",\n        ...\n      }\n    ],\n    \"invoicePayments\": [...]\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://webhook-endpoint.example.com/booking-update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n  \"received\": true,\n  \"bookingId\": \"abc123\"\n}"}],"_postman_id":"068ee280-b297-44d2-9452-99f1257647a6"}],"id":"10230972-c50c-4eb2-bc3c-8801d5872261","_postman_id":"10230972-c50c-4eb2-bc3c-8801d5872261","description":""}],"id":"f1cb98aa-ce71-47e6-9cb0-6ed48e39a588","description":"<h1 id=\"pageintroheaderscope\">Scope</h1>\n<p>This API is intended for holders of a ROOMBOSS account. The purpose of the API is to allow you to create/maintain your own booking interfaces via a data connection.</p>\n<p>This API allows you to:</p>\n<ol>\n<li><p>Retrieve hotels by region.</p>\n</li>\n<li><p>Retrieve available stay options for specified hotels, date range, and number of guests.</p>\n</li>\n<li><p>Retrieve available images for specified hotels.</p>\n</li>\n<li><p>Retrieve texts (hotel name, hotel description, room name, room description) in selected language for specified hotels.</p>\n</li>\n<li><p>Retrieve rate plan descriptions.</p>\n</li>\n<li><p>Create a booking.</p>\n</li>\n<li><p>Register a payment on a booking.</p>\n</li>\n<li><p>View a booking.</p>\n</li>\n<li><p>Cancel a booking.</p>\n</li>\n<li><p>List all bookings (accommodation/non-accommodation/all) changed on date.</p>\n</li>\n<li><p>List all invoices/receipts/both changed on date.</p>\n</li>\n<li><p>Update lead guest details.</p>\n</li>\n<li><p>Mark booking as pre-registered.</p>\n</li>\n</ol>\n","_postman_id":"f1cb98aa-ce71-47e6-9cb0-6ed48e39a588"},{"name":"OTA Rates & Availability API","item":[{"name":"Rates","id":"0240f1ca-ef7d-465f-affd-998b77137f93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:26:43+00:00\" Version=\"3.0\">\n    <RateAmountMessages HotelCode=\"hotelID\">\n        <RateAmountMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2022-02-01\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanId\"/>\n            <Rates>\n                <Rate>\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"56000\" NumberOfGuests=\"1\"/>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"66000\" NumberOfGuests=\"2\"/>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n        <RateAmountMessage LocatorID=\"2\">\n            <StatusApplicationControl Start=\"2022-02-06\" End=\"2022-03-10\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanId\"/>\n            <Rates>\n                <Rate>\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"88000\" NumberOfGuests=\"1\"/>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"99000\" NumberOfGuests=\"2\"/>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n    </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelRateAmountNotifRQ","description":"<p>This API is used by RoomBoss to push rates to your system.\n\nRoomBoss supports occupancy-based pricing, rates are sent for each applicable room type/ rate plan/ stay date combination.\n\nPlease note that BaseByGuestAmt/@NumberOfGuests will always start from 1, and iterate through each occupancy until it reaches the maximum occupancy per room set by property users in RoomBoss\n</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>RateAmountMessages@HotelCode</code></td>\n<td>String</td>\n<td>RoomBoss hotel identifier.</td>\n</tr>\n<tr>\n<td><code>RateAmountMessage</code></td>\n<td>Object</td>\n<td>Defines pricing details.</td>\n</tr>\n<tr>\n<td><code>StatusApplicationControl</code></td>\n<td></td>\n<td>Defines applicable date range, room type and rate plan.</td>\n</tr>\n<tr>\n<td><code>StatusApplicationControl@Start</code></td>\n<td>Date</td>\n<td>Start date for the update.</td>\n</tr>\n<tr>\n<td><code>StatusApplicationControl@End</code></td>\n<td>Date</td>\n<td>End date for the update(Inclusive).</td>\n</tr>\n<tr>\n<td><code>StatusApplicationControl@InvTypeCode</code></td>\n<td>String</td>\n<td>RoomBoss roomtype identifier.</td>\n</tr>\n<tr>\n<td><code>StatusApplicationControl@RatePlanCode</code></td>\n<td>String</td>\n<td>RoomBoss rate plan identifier.</td>\n</tr>\n<tr>\n<td><code>Rates</code></td>\n<td>List</td>\n<td>Holds one or more rate elements.</td>\n</tr>\n<tr>\n<td><code>Rate</code></td>\n<td>Object</td>\n<td>Defines pricing details.</td>\n</tr>\n<tr>\n<td><code>BaseByGuestAmts</code></td>\n<td>List</td>\n<td>Holds rates per guest count.</td>\n</tr>\n<tr>\n<td><code>BaseByGuestAmt</code></td>\n<td>Object</td>\n<td>Rate for a specific number of guests.</td>\n</tr>\n<tr>\n<td><code>BaseByGuestAmt@AgeQualifyingCode</code></td>\n<td>Integer</td>\n<td>Guest age category (always 10).</td>\n</tr>\n<tr>\n<td><code>BaseByGuestAmt@AmountAfterTax</code></td>\n<td>Decimal</td>\n<td>Rate amount after taxes.</td>\n</tr>\n<tr>\n<td><code>BaseByGuestAmt@NumberOfGuests</code></td>\n<td>Integer</td>\n<td>Number of guests the rate applies to.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["OTA_HotelRateAmountNotifRQ"],"host":["{{your_api_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"036f302d-a785-4117-b1cc-a0aaa87f3f9a","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:26:43+00:00\" Version=\"3.0\">\n    <RateAmountMessages HotelCode=\"hotelID\">\n        <RateAmountMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanId\"/>\n            <Rates>\n                <Rate>\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"56000\" NumberOfGuests=\"1\"/>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"66000\" NumberOfGuests=\"2\"/>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n    </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelRateAmountNotifRQ"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelRateAmountNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <success/>\n</OTA_HotelRateAmountNotifRS>"},{"id":"36adb50c-e078-46ed-9d66-4502dade4f78","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:26:43+00:00\" Version=\"3.0\">\n    <RateAmountMessages HotelCode=\"hotelID\">\n        <RateAmountMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanId\"/>\n            <Rates>\n                <Rate>\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"56000\" NumberOfGuests=\"1\"/>\n                        <BaseByGuestAmt AgeQualifyingCode=\"10\" AmountAfterTax=\"66000\" NumberOfGuests=\"2\"/>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n    </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_push_url}}/OTA_HotelRateAmountNotifRQ"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelRateAmountNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <Errors>\n        <Error Code=\"INVALID_ROOMTYPE_ID\">Invalid InvTypeCode 'roomTypeID'</Error>\n    </Errors>\n</OTA_HotelRateAmountNotifRS>"}],"_postman_id":"0240f1ca-ef7d-465f-affd-998b77137f93"},{"name":"Restrictions","id":"798a9afc-7eb5-45a3-b69e-46ddf87ee1ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:30:03+00:00\" Version=\"3.0\">\n    <AvailStatusMessages HotelCode=\"hotelID\">\n        <AvailStatusMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Open\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"2\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Close\" Restriction=\"Arrival\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"3\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Open\" Restriction=\"Departure\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"4\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"1ratePlanID\"/>\n            <RestrictionStatus MinAdvancedBookingOffset=\"5\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"5\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus MaxAdvancedBookingOffset=\"14\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"6\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <LengthsOfStay>\n                <LengthOfStay Time=\"3\" MinMaxMessageType=\"SetMinLOS\"/>\n                <LengthOfStay Time=\"5\" MinMaxMessageType=\"SetMaxLOS\"/>\n            </LengthsOfStay>\n        </AvailStatusMessage>\n    </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelAvailNotifRQ","description":"<p>This API is used by RoomBoss to push restrictions to your system.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>AvailStatusMessages@HotelCode</td>\n<td>String</td>\n<td>RoomBoss hotel identifier.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@Start</td>\n<td>Date</td>\n<td>Start date for the update.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@End</td>\n<td>Date</td>\n<td>End date for the update(Inclusive).</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@InvTypeCode</td>\n<td>String</td>\n<td>RoomBoss roomtype identifier.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@RatePlanCode</td>\n<td>String</td>\n<td>RoomBoss rate plan identifier.</td>\n</tr>\n<tr>\n<td>RestrictionStatus@Status</td>\n<td>String</td>\n<td>Availability status (Open/Close).</td>\n</tr>\n<tr>\n<td>RestrictionStatus@Restriction</td>\n<td>String</td>\n<td>Type of restriction (Arrival/Departure/Empty).</td>\n</tr>\n<tr>\n<td>RestrictionStatus@MinAdvancedBookingOffset</td>\n<td>Integer</td>\n<td>Minimum number of night before the checkin date guests will be allowed to make a booking</td>\n</tr>\n<tr>\n<td>RestrictionStatus@MaxAdvancedBookingOffset</td>\n<td>Integer</td>\n<td>Maxmimum number of night before the checkin date guests will be allowed to make a booking.</td>\n</tr>\n<tr>\n<td>LengthsOfStay@Time</td>\n<td>Integer</td>\n<td>Number of nights for length-of-stay restriction.</td>\n</tr>\n<tr>\n<td>LengthsOfStay@MinMaxMessageType</td>\n<td>String</td>\n<td>Specifies whether it is a minimum or maximum length of stay (SetMinLOS/SetMaxLOS).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["OTA_HotelAvailNotifRQ"],"host":["{{your_api_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fb12271b-c676-43bc-a0b3-f0f1b2af9e96","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:30:03+00:00\" Version=\"3.0\">\n    <AvailStatusMessages>\n        <AvailStatusMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Open\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"2\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Close\" Restriction=\"Arrival\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"3\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Open\" Restriction=\"Departure\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"4\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"1ratePlanID\"/>\n            <RestrictionStatus MinAdvancedBookingOffset=\"P5D\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"5\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus MaxAdvancedBookingOffset=\"P14D\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"6\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <LengthsOfStay>\n                <LengthOfStay Time=\"3\" MinMaxMessageType=\"SetMinLOS\"/>\n                <LengthOfStay Time=\"5\" MinMaxMessageType=\"SetMaxLOS\"/>\n            </LengthsOfStay>\n        </AvailStatusMessage>\n    </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelAvailNotifRQ"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"},{"key":"","value":"","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <success/>\n</OTA_HotelAvailNotifRS>"},{"id":"66773540-941c-4ce1-ae7a-ceb973b96c36","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:30:03+00:00\" Version=\"3.0\">\n    <AvailStatusMessages>\n        <AvailStatusMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Open\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"2\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Close\" Restriction=\"Arrival\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"3\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus Status=\"Open\" Restriction=\"Departure\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"4\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"1ratePlanID\"/>\n            <RestrictionStatus MinAdvancedBookingOffset=\"P5D\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"5\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <RestrictionStatus MaxAdvancedBookingOffset=\"P14D\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage LocatorID=\"6\">\n            <StatusApplicationControl Start=\"2022-02-03\" End=\"2022-03-05\" InvTypeCode=\"roomTypeID\" RatePlanCode=\"ratePlanID\"/>\n            <LengthsOfStay>\n                <LengthOfStay Time=\"3\" MinMaxMessageType=\"SetMinLOS\"/>\n                <LengthOfStay Time=\"5\" MinMaxMessageType=\"SetMaxLOS\"/>\n            </LengthsOfStay>\n        </AvailStatusMessage>\n    </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelAvailNotifRQ"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <Errors>\n        <Error Code=\"INVALID_ROOMTYPE_ID\">Invalid InvTypeCode 'roomTypeID'</Error>\n    </Errors>\n</OTA_HotelAvailNotifRS>"}],"_postman_id":"798a9afc-7eb5-45a3-b69e-46ddf87ee1ff"},{"name":"Availability","id":"4e173ffb-57fc-42c4-a2f5-e368374a25ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:30:03+00:00\" Version=\"3.0\">\n    <AvailStatusMessages HotelCode=\"hotelID\">\n        <AvailStatusMessage BookingLimit=\"2\">\n            <StatusApplicationControl InvTypeCode=\"roomTypeID\" Start=\"2025-03-24\" End=\"2025-03-28\"/>\n        </AvailStatusMessage>\n        <AvailStatusMessage BookingLimit=\"5\">\n            <StatusApplicationControl InvTypeCode=\"roomTypeID\" Start=\"2025-03-29\" End=\"2025-03-30\"/>\n        </AvailStatusMessage>\n    </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelAvailNotifRQ","description":"<p>This API is used by RoomBoss to push availability to your system.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Type</th>\n<th>Information</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>AvailStatusMessages@HotelCode</td>\n<td>String</td>\n<td>RoomBoss hotel identifier.</td>\n</tr>\n<tr>\n<td>AvailStatusMessage</td>\n<td>Object</td>\n<td>Represents an availability status message.</td>\n</tr>\n<tr>\n<td>AvailStatusMessage@BookingLimit</td>\n<td>Integer</td>\n<td>Number of rooms available to book.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl</td>\n<td>Object</td>\n<td>Contains room type and date range details.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@InvTypeCode</td>\n<td>String</td>\n<td>RoomBoss roomtype identifier.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@Start</td>\n<td>Date</td>\n<td>Start date for the update.</td>\n</tr>\n<tr>\n<td>StatusApplicationControl@End</td>\n<td>Date</td>\n<td>End date for the update(Inclusive).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["OTA_HotelAvailNotifRQ"],"host":["{{your_api_base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e343da87-8268-4709-8647-c3c15010b7db","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:30:03+00:00\" Version=\"3.0\">\n    <AvailStatusMessages HotelCode=\"2c98902a6259e9f101625fec9b203ec6\">\n        <AvailStatusMessage BookingLimit=\"2\">\n            <StatusApplicationControl InvTypeCode=\"roomTypeID\" Start=\"2025-03-24\" End=\"2025-03-28\"/>\n        </AvailStatusMessage>\n    </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelAvailNotifRQ"},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <success/>\n</OTA_HotelAvailNotifRS>"},{"id":"5df38bbb-42c5-4c76-9354-8bd8413ea99b","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2022-02-03T06:30:03+00:00\" Version=\"3.0\">\n    <AvailStatusMessages HotelCode=\"2c98902a6259e9f101625fec9b203ec6\">\n        <AvailStatusMessage BookingLimit=\"2\">\n            <StatusApplicationControl InvTypeCode=\"roomTypeID\" Start=\"2025-03-24\" End=\"2025-03-28\"/>\n        </AvailStatusMessage>\n    </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>","options":{"raw":{"language":"xml"}}},"url":"{{your_api_base_url}}/OTA_HotelAvailNotifRQ"},"status":"Bad Request","code":400,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <Errors>\n        <Error Code=\"INVALID_ROOMTYPE_ID\">Invalid InvTypeCode 'roomTypeID'</Error>\n    </Errors>\n</OTA_HotelAvailNotifRS>"}],"_postman_id":"4e173ffb-57fc-42c4-a2f5-e368374a25ec"}],"id":"8b5eec04-6c82-4cd1-9987-d4eeb862d8c7","description":"<h1 id=\"ratesintrohead3\">Scope</h1>\n<p>This API is intended for holders of a ROOMBOSS account. This document should be used as guide for implementing APIs that would be consumed by RoomBoss to push rates, restrictions and availability.</p>\n<h1 id=\"ratesintrohead1\"><strong>Message Types</strong></h1>\n<p>RoomBoss sends the following OTA messages to keep your system up to date:</p>\n<h2 id=\"1-ota_hotelrateamountnotifrq\"><strong>1. OTA_HotelRateAmountNotifRQ</strong></h2>\n<p>Used to send rate updates at the room type/rate plan level.</p>\n<h2 id=\"2-ota_hotelavailnotifrq\"><strong>2. OTA_HotelAvailNotifRQ</strong></h2>\n<p>Used to send:</p>\n<ul>\n<li><p>Restrictions at the room type/rate plan level.</p>\n</li>\n<li><p>Availability at the room type level.</p>\n</li>\n</ul>\n<h4 id=\"ratesintrohead2\"><strong>Implementation Requirements</strong></h4>\n<ul>\n<li><p>This API works in conjunction with the Hotel API, which your system uses to manage bookings and retrieve hotel details such as room types and rate plans.</p>\n</li>\n<li><p>To start receiving updates, please implement listed APIs and share your API URL along with API credentials.</p>\n</li>\n</ul>\n<h1 id=\"ratesintrohead4\"><strong>Connection</strong></h1>\n<p>All calls are to be made via secure HTTP (HTTPS).</p>\n<h2 id=\"ratesintrohead5\"><strong>Authentication</strong></h2>\n<p>API requests should be authorized using Basic Authentication. Please share your API username and password to start receiving updates.</p>\n<h2 id=\"ratesintrohead6\"><strong>Push Frequency</strong></h2>\n<p>RoomBoss has two types of data pushes:</p>\n<ul>\n<li><p>Delta Push – Incremental updates triggered by changes in rates, restrictions and availability inside RoomBoss.</p>\n</li>\n<li><p>Full Sync – A full data push for next 1 year, which occurs daily at 7 AM JST (Only availability).</p>\n</li>\n</ul>\n<h2 id=\"ratesintrohead7\"><strong>API Errors</strong></h2>\n<ul>\n<li><p>Bad Request – Request processing failure because of validation checks in your system.</p>\n<ul>\n<li><p>Response Status code: 400</p>\n</li>\n<li><p>Response Body: Please check error case for each request.</p>\n</li>\n</ul>\n</li>\n<li><p>Unauthorized – Authentication failed due to incorrect credentials.</p>\n<ul>\n<li><p>Response Status code: 401</p>\n</li>\n<li><p>Response Body: Free text</p>\n</li>\n</ul>\n</li>\n</ul>\n","_postman_id":"8b5eec04-6c82-4cd1-9987-d4eeb862d8c7"}],"event":[{"listen":"prerequest","script":{"id":"6c36765f-85a0-43f6-b4d2-41ac538d7d47","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"7459d07b-17dd-4ed3-a1c8-3b91a2efa8f7","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"id":"92379ec8-200f-479f-ae55-9c9769ad20b1","key":"baseUrl","value":"https://api.roomboss.com/extws/gs/v1/"},{"id":"7545e997-1067-4724-914b-bb609ef1c5e3","key":"hotelApiBaseUrl","value":"https://api.roomboss.com/extws/hotel/v1"},{"id":"524a8ee4-672b-42cc-a055-7d1b2e83c968","key":"document.apiVersion","value":"1.0"},{"id":"632ac975-2e03-47e5-b56c-7cbdd4c69ac9","key":"page.intro.header.scope","value":"Scope"},{"id":"3e903f71-1f7e-48a8-88eb-e2ca73594dc4","key":"page.intro.preamble","value":"This API is intended for holders of a ROOMBOSS account.\n\nThe purpose of this API is to facilitate functionality found on the Order02 Booking widget and Customer Intranet page, allowing you to create/maintain your own booking interfaces via a data connection.\n\nThis API allows you to:\n"},{"id":"8990ef49-0323-489e-8762-9d03fe2e548d","key":"page.intro.method.listVendors","value":"List vendors by area."},{"id":"70b03af3-fe00-4ad9-8019-bc7a10ae58bc","key":"page.intro.method.listCategories","value":"List categories by vendor."},{"id":"14115c00-d48d-49c5-a25b-57e7943918b5","key":"page.intro.method.listProducts","value":"List products by category."},{"id":"f6eb9870-9826-460f-8763-7247c53e6bef","key":"page.intro.method.getOffer","value":"Get available pricing for a specified product, date, and product options."},{"id":"a6f3fcc5-5f99-4d39-9248-3fec945e414c","key":"page.intro.method.listGuestDetails","value":"List guest details."},{"id":"6a2dc387-dcdc-46a3-aa6e-9855e3b86632","key":"page.intro.method.listGuestFields","value":"List required guest fields for a set of vendors."},{"id":"52a7757f-2b23-429e-8c17-139491acb1c3","key":"page.intro.method.uploadGuestImage","value":"Upload guest images."},{"id":"1f2fb843-b6ab-4c15-bf43-17274cbc3042","key":"page.intro.method.createPackage","value":"Create a package."},{"id":"d7fcdcb4-c60b-4bbc-a9ed-c931a175b358","key":"page.intro.method.listPackage","value":"Get package details."},{"id":"91d6d27a-f999-422a-9748-724e30d81d8b","key":"page.intro.method.createPayment","value":"Register a payment on a package."},{"id":"91af7eca-cba0-4dbf-aa57-8884f827b4ac","key":"page.intro.header.connection","value":"Connection"},{"id":"84fe7d1a-39cd-474a-8c89-8572322b70a7","key":"page.intro.header.baseUrl","value":"Base URL"},{"id":"f7c7bd92-debd-4bf5-911c-c0817e12a0e5","key":"page.intro.header.authentication","value":"Authentication"},{"id":"e17ef021-a3de-4f95-ac86-2e817dfcbc67","key":"page.intro.text.authentication","value":"Two methods of authentication are available, depending on the intended usage:"},{"id":"f2e1d869-9724-4737-9f48-8ff4d4b7d8f4","key":"page.intro.header.serverSide","value":"Server-side"},{"id":"d392fa27-f025-4192-b28d-1bf271f8c28a","key":"page.intro.text.serverSide","value":"Callers are required to use HTTP Basic Authentication to authenticate themselves, for which credentials will be provided."},{"id":"a960d305-16ca-48c0-a1d0-7071b9ecbe08","key":"page.intro.header.clientSide","value":"Client-side"},{"id":"ef953350-edd3-466d-8716-332a9d50e8d6","key":"page.intro.text.clientSide","value":"Calls can be made via a browser-based application using origin authentication. Origins can be configured by creating a website configuration within the applicable RoomBoss account."},{"id":"d9c76a2f-fcf4-42d0-8c63-2a9767bb2d05","key":"page.intro.header.security","value":"Security"},{"id":"e144349b-6a8c-4cd9-bac3-402fd0dac6ba","key":"page.intro.text.security","value":"All calls are to be made via secure HTTP (HTTPS)."},{"id":"63df3e11-8764-4ad5-b6d9-2ca7c3ef0a39","key":"description.isLeadGuest","value":"Indicates whether the guest is the lead guest on a package."},{"id":"df3ef441-d4c3-4e20-8c02-665d23ae29d3","key":"document.footer","value":"Private and Confidential. © RoomBoss Co. Ltd. 2025, All Rights Reserved."},{"id":"aca20877-a79e-4468-9b74-2ba140bb53f7","key":"page.listVendors.overview","value":"This method allows you to query receive a list of vendors and their details, such as ID, name, media URLs, and other booking-related settings, located in the specified area.\n\nVendor IDs are required for multiple operations, including listing categories and products, querying pricing and guest field settings, and for creating packages.\n"},{"id":"650792e6-b807-4858-907f-f2c312df985f","key":"page.listVendors.header.countryLocationCodes","value":"Country & Location Codes"},{"id":"e8335fec-a84b-4aa4-9113-c67535002d1a","key":"page.listVendors.text.countryLocationCodes","value":"When listing vendors, query by area location to include results from all sublocations associated with it. To limit vendors to a specific zone, instead query by sublocation."},{"id":"eb2b70d7-1a41-46ce-ac49-91a64ad2c256","key":"misc.countryCode","value":"Country Code"},{"id":"d52db6dd-df06-41eb-982e-f6455565d365","key":"misc.locationCode","value":"Location Code"},{"id":"e210d940-2946-4360-bbba-b83ccb3f1c4b","key":"misc.area","value":"Area"},{"id":"371df268-84d2-491e-9cff-d62e1e938d39","key":"misc.sublocations","value":"Sublocations"},{"id":"61e98b03-57e5-4062-a8cf-1e41d1c196fd","key":"country.japan","value":"Japan"},{"id":"385263ef-16ec-4dc8-b7fd-f9b7b26bb0e6","key":"country.newZealand","value":"New Zealand"},{"id":"8cef8836-3baf-4f11-b711-bc096aa8e5ea","key":"country.chile","value":"Chile"},{"id":"179f5198-2661-4eba-83be-c31fa23b4b03","key":"country.canada","value":"Canada"},{"id":"a4bd3509-32ec-4191-b96e-dbe301d9ce36","key":"country.indonesia","value":"Indonesia"},{"id":"ca3e3014-13da-41b3-8d6b-710e8025131c","key":"country.australia","value":"Australia"},{"id":"a46bbad3-af84-4d94-8c72-115f1ec2d96e","key":"country.usa","value":"United States of America"},{"id":"0d8aa47f-1458-4128-a095-dc8f510eaf73","key":"country.thailand","value":"Thailand"},{"id":"1cd16481-b469-47d4-976a-244afd61b53c","key":"country.malaysia","value":"Malaysia"},{"id":"26effaca-9fbc-42cd-b58e-160d301061b1","key":"country.other","value":"OTHER"},{"id":"d2cbe8f3-6f82-4ca6-b007-fc783056a56a","key":"misc.responseFields","value":"Response Fields"},{"id":"ecb8e84f-1c6f-4c77-aefe-3220d189ddb0","key":"misc.fieldPath","value":"Field Path"},{"id":"85b8f590-6a9f-4d11-ae5f-51c199707a09","key":"misc.type","value":"Type"},{"id":"7f8b3a70-1c55-42f3-928c-9d879350b966","key":"misc.information","value":"Information"},{"id":"bb1d7885-e0a3-4bcc-a746-d7039c5c3c9c","key":"i18n.lang","value":"en"},{"id":"553cfc39-2480-4e16-aa27-4fd343f37945","key":"page.listCategories.overview","value":"This method allows you list the categories of a specified vendor, returning details such as ID, media URLs, localised names & descriptions, and any child categories."},{"id":"f9db9026-47d3-4e9b-a8d9-b32035957ee4","key":"misc.categories","value":"Categories"},{"id":"468e566a-e02f-4854-894b-57f758ec2422","key":"page.listCategories.text.categories","value":"Categories are used to group and organise products. Products are associated with a category, which in turn belong to a parent category. For example:"},{"id":"1d36cb2d-790f-430e-a803-af5b044a8ca1","key":"page.listCategories.text.exampleParent","value":"Ski & Snowboard Lessons (Parent Category)"},{"id":"adec6ba2-c917-4e27-ac47-b75efe76f81a","key":"page.listCategories.text.exampleChild","value":"Ski Lessons (Child Category)"},{"id":"247a0675-69dd-4a5d-b048-5fe250fdde99","key":"page.listCategories.text.exampleProduct","value":"Private Ski Lesson (Product)"},{"id":"204a589d-2611-4a75-8284-1083d5dc3e6f","key":"page.listProducts.overview","value":"This method allows you to list the products of a specified category, returning product options, product details such as ID, media URLs, localised names & descriptions, product settings, and availability for booking."},{"id":"f85d2c19-a7a3-4141-b6ce-439ad1dc3892","key":"misc.productOptions","value":"Product Options"},{"id":"5b1025ce-64ac-4c1f-b5f8-5fb872656fa7","key":"page.listProducts.text.productOptions","value":"Product options are used to collect information about a guest or the product they are buying. \n\nEach product is configurable with up to 10 independent product options, such as \"Number of Days\", \"Start Time\", or \"Shoe Size\". Some options can be price affecting, and can also be set as compulsory for booking.\n\nThe format of a product option value is dependent upon its input type. This determines if the product option is intended to allow for selection from a list, accept free text input, or to display a fixed value.\n\nThe product options object provides the necessary data required to build/present these options.\n"},{"id":"4bf305ba-1c28-4241-ae76-573e97d65edc","key":"misc.unavailableDates","value":"Unbookable Dates"},{"id":"64772d12-dd19-4f5b-9c69-56c8e7620916","key":"page.listProducts.text.unavailableDates","value":"A list of date ranges where the specified product is unavailable for booking. E.g Jan 1 - 5, Jan 10, Jan 15 - 31.\n\nIn the context of a booking UI, these ranges can be used to block dates on a date calendar, preventing selection/querying of offers for unbookable dates for a product.\n"},{"id":"c9e1ff52-08a3-434e-a24c-e378be5f19b9","key":"page.getOffer.overview","value":"This method returns pricing, availability and booking restrictions for the specified product ID, product options, and date. Optionally define a discount code to be applied."},{"id":"dab0ef83-8366-47cb-9c3d-504770790233","key":"misc.bookingExtent","value":"Booking Extent"},{"id":"9c3a5ca9-d41f-4faa-823e-94166dd58999","key":"misc.extent.internal","value":"An Internal booking is only sent to the vendor when you change it to a Request."},{"id":"0332cfc1-97a2-45de-9473-89f351647702","key":"misc.extent.request","value":"A Request is a booking that has been submitted to a vendor, but is not confirmed until the vendor changes it to Reservation."},{"id":"afba8d2a-4115-40f3-8bc5-8c956776764d","key":"misc.extent.reservation","value":"A Reservation is a booking that has been confirmed by the vendor."},{"id":"60793794-3c18-4fc7-ab47-c6ec00a2378b","key":"page.getOffer.text.bookingExtent","value":"The extent of a booking can be Internal, Request or Reservation."},{"id":"79c6ba2f-9d4c-4714-8312-a55e6c9f1dfe","key":"misc.requestFields","value":"Request Fields"},{"id":"a2440eef-cd9d-4906-9fb7-de83d954b1cd","key":"page.listGuestDetails.overview","value":"This method allows you to list guest information by guest email and/or guest ID. Returns guest details for the lead guest and any associated additional guests.\n\nIt is possible for multiple guests to share the same email. If a guest email is used to query without specifying a guest ID, the most recently created guest (and any associated guests) matching that email will be returned.\n"},{"id":"df22c83d-5d73-4637-9cc6-321461e7dc4b","key":"misc.access","value":"Access"},{"id":"60330a13-63f4-4299-9715-30ff092c3794","key":"misc.guestDetails","value":"Guest Details"},{"id":"b646a3b6-7d01-4a95-bc45-88b81e8339a9","key":"page.listGuestDetails.text.guestDetails","value":"Each vendor is able to define which fields are compulsory in order to create a booking."},{"id":"888ead80-b2f0-40f7-b087-b657ae3575ec","key":"page.listGuestFields.overview","value":"This method allows you to query guest field requirements for a specified subset of vendors (each vendor being booked in the package)."},{"id":"e9b52996-4a4b-4271-8dee-ce2db348606f","key":"page.listGuestFields.text.require","value":"Indicates the specified guest field is required for booking."},{"id":"47fe3801-838e-4ab3-942c-48dcb6bc61fc","key":"page.listGuestFields.text.show","value":"Indicates the vendors will accept the guest field, but it is not required for booking."},{"id":"7b5aec93-8212-4722-bbcb-701bcecb6c55","key":"page.listGuestFields.overview_2","value":"When multiple products from different vendors are being purchased, the most restrictive requirements will be returned for that context.\n\nFor example, Vendor A requires Date of Birth; Vendor B requires Emergency Contact Name. For this context, Date of Birth and Emergency Contact Name will be returned as required for booking.\n"},{"id":"62ff3fa3-c455-4ed8-a255-042b7ed4e606","key":"page.uploadGuestImage.overview","value":"This method allows you to upload a guest image, for later association with the guest when creating a package. Returns the path of the image."},{"id":"a8933def-9ace-49da-8fee-294cc51c25f8","key":"page.createPackage.overview","value":"This method allows you to create a new package for the specified booking settings, guest details, and product choices. Optionally apply a booking segment and/or discount code.\n\nCreating a package triggers the automatic creation of invoices if the appropriate account settings and invoice strategy exist."},{"id":"a9b76eea-94c0-4d54-9b60-1de7d887ba7b","key":"misc.guests","value":"Guests"},{"id":"2e0054ee-094d-40dc-81e5-1ba36d9f705c","key":"page.createPackage.text.guests","value":"The list of guests to be included on the package. At least one lead guest is required."},{"id":"34254a38-8c9f-4ee5-bfda-c47253d2caf4","key":"page.createPackage.text.guestsNew","value":"New guests will be created upon booking using the guest details provided."},{"id":"9fcbaa9f-8a0e-442f-9682-84949971d159","key":"page.createPackage.text.guestsExisting","value":"Existing guests can be included when using credential-authenticated access."},{"id":"183b536f-dfd6-43ba-b038-d93b552134e8","key":"page.createPackage.text.guestsExistingUpdate","value":"Existing guests can be updated by providing additional guest details alongside the guest ID."},{"id":"f2a44a5e-e137-460c-b0c9-f9c676e6fbfa","key":"misc.items","value":"Items"},{"id":"6a2a6476-7a6d-48a4-98ea-231dafbeb551","key":"page.createPackage.text.items","value":"The list of products being booked. Each item is intended to be built from its Get Offer response."},{"id":"81e9443d-72ec-4d32-a074-c5e0c43cde36","key":"misc.responseValidationErrors","value":"Response Validation Errors"},{"id":"b7c51da1-7bc7-416b-8b0b-158a085fe9ee","key":"page.createPackage.responseValidationErrors","value":"If there are errors with guest or item validation, validationErrors will be displayed; including the error code and index of the invalid entity."},{"id":"bbdbe679-2c35-45ff-9fbd-201912f07726","key":"page.listPackage.overview","value":"This method returns the details of a specified package, queried by the package or booking ID, and includes information on all bookings within the package, guest details, service provider information, and invoice and payments details.\n\nWhen queried by booking ID, the package containing the booking will be returned."},{"id":"157117be-21a9-42c9-ac05-16c2bd835d32","key":"page.listPackage.text.access","value":"When accessed via origin-based calls, only limited details for the lead guest will be returned."},{"id":"83538e69-0cde-4eaf-a733-e76e8f398171","key":"misc.packageBookings","value":"Package Bookings"},{"id":"5bc004e8-c04b-49ae-a81a-85dcd82cd627","key":"misc.bookingServiceProvider","value":"Booking Service Provider"},{"id":"5f620f30-abce-479f-b9f8-cb087c64cec5","key":"misc.packageInvoicePayments","value":"Package Invoice Payments"},{"id":"470e5c90-08a0-4e12-8660-00e4f0f55296","key":"page.createPayment.overview","value":"This method allows you to register a payment for the specified invoice & booking ID."},{"id":"c2ba5544-8864-4028-ab18-a6b5c0a9c777","key":"description.invoice.paymentMethod","value":"The type of payment method. See \"Payment Methods\"."},{"id":"7bddd614-17a1-4a53-8a4a-fbfe8d7d5292","key":"description.error.vendor_product_mismatch","value":"The specified product does not belong to the specified vendor."},{"id":"71c3ff60-8213-4eb6-87b1-b27ea553554f","key":"description.error.incomplete_guest_information","value":"A guest which has one or more missing required guest fields has been provided."},{"id":"154bce44-2a39-4140-8074-97df8d839da9","key":"description.error.invalid_guest_email","value":"An invalid guest email has been provided."},{"id":"388a07f9-2750-4531-aa1c-af12549d599c","key":"description.error.invalid_guest_gender","value":"An invalid guest gender has been provided."},{"id":"1a3b242e-6925-4df2-a630-6d885e1287b6","key":"description.error.invalid_guest_country_code","value":"An invalid guest nationality has been provided."},{"id":"00f35ff2-c90e-4cba-9b0b-33f4cbd791fb","key":"description.error.invalid_associated_guest_count","value":"The number of guests associated to the product is too few or too many."},{"id":"70487f06-c4eb-4c0d-b71e-187ec0ff3818","key":"description.error.invalid_associated_guest","value":"An invalid associated guest or guest index has been provided."},{"id":"6a94766e-5271-4c71-89d4-ee1ed5e20fbc","key":"description.error.missing_guest_image","value":"A guest which does not have a compulsory guest image has been provided."},{"id":"38a31e2d-c2c7-4997-8551-e949cfde548b","key":"description.error.invalid_item_price","value":"The specified price is invalid or missing."},{"id":"f594e19a-bf93-44f9-b9b5-7c3d7e3ae438","key":"description.error.invalid_first_name_format","value":"A guest first name which does not match the required name format has been provided."},{"id":"ff17b1e8-54ca-4836-ae05-9e107675f391","key":"description.error.invalid_additional_first_name_format","value":"A guest additional first name which does not match the required additional name format has been provided."},{"id":"71311457-d238-4768-a1ba-636d42d87843","key":"description.error.invalid_additional_last_name_format","value":"A guest additional last name which does not match the required additional name format has been provided."},{"id":"566b0b60-8b30-4258-9de7-b9deb8bdf1aa","key":"description.error.invalid_last_name_format","value":"A guest last name which does not match the required name format has been provided."},{"id":"0774b89e-e275-4a9f-b5c6-d3e9574eae73","key":"description.error.invalid_product_options","value":"Invalid product options have been provided."},{"id":"ffb8366a-0f06-4819-82e9-b1ce9571b215","key":"description.error.date_not_available","value":"The specified booking date is not available."},{"id":"a8960920-4fb1-4be6-a772-065507b96688","key":"description.request.bookingId","value":"The ID of the booking you wish to register a payment for."},{"id":"a63cee8b-6fe0-4a83-a5b3-8aff093c5af1","key":"description.request.bookingSegment","value":"The booking segment to be applied to the package. E.g \"APP\". When valid, the segment will be added for bookings made in this order."},{"id":"60b962ea-1276-44a4-8a34-7a90f63875c7","key":"description.booking.lastModifiedDate","value":"The date the booking was last modified. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\"."},{"id":"3e7121da-5d85-4268-8241-43805d3c91fb","key":"description.invoice.amount","value":"The amount billed on the invoice."},{"id":"5787afc2-74e7-43c9-8c3a-d1c85d424eeb","key":"description.order.guests","value":"List of guests to be added to the package and their details."},{"id":"1e53a145-806d-4568-be36-1f1e0f41ab07","key":"description.item.associatedGuests","value":"List of guests to be associated to the booking item, referenced by guest index."},{"id":"8f6ac907-41a0-4fff-8ee1-3aa4253eb4ba","key":"description.item.vendorId","value":"The vendor ID of the booking item."},{"id":"ec06ae42-0a35-4c11-81ba-97555b6f4d0d","key":"description.item.productId","value":"The product ID of the booking item."},{"id":"e0ea0fff-24c6-4e91-b4da-e4751bdc32ab","key":"description.package.currencyCode","value":"The currency used in the package. Format: ISO 4217 currency code, e.g. \"JPY\"."},{"id":"d9b8df15-943a-420d-b628-9ca2f28cb985","key":"description.item.price","value":"The requested sale price of the booking item."},{"id":"7d72d690-3bf6-4fca-9b2c-332177974542","key":"description.item.extent","value":"The requested extent of the product booking. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\"."},{"id":"3eb0d15c-9d5b-4f28-ba35-db4103a5ff90","key":"description.productId","value":"The ID of the product."},{"id":"95e27c64-6109-4cc9-bf9f-6df1d5c2ab29","key":"description.item","value":""},{"id":"31fb842b-4d26-4ba0-a352-fde7fa98e6d2","key":"description.booking.guestIntranetUrl","value":"The Guest Intranet page URL for the booking."},{"id":"2f9f203c-c996-476c-8f1b-68cfe7eeebd0","key":"description.booking.notes","value":"Booking note. Max. character length:  4096."},{"id":"35ed5cc4-534e-4308-a60e-74b1c8e93487","key":"description.booking.bookingSource","value":"The company name of the booking source."},{"id":"426316f3-e119-4493-95ac-5fe987b34bbd","key":"description.booking.bookingType","value":"Indicates whether the booking is a non-accommodation service or accommodation stay. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\"."},{"id":"d597d779-0d7c-41aa-8dc1-f29c473cc94c","key":"description.booking.createdDate","value":"The date the booking was created. Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\"."},{"id":"f779897f-6c2c-4f39-82c0-652f3433cd33","key":"description.booking.extent","value":"The extent of the booking. Indicates whether the booking is confirmed, unconfirmed, or internal. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\"."},{"id":"f9371960-f1c6-4d53-9cba-a043f85573b7","key":"description.booking.active","value":"The status of the booking. Indicates whether a booking is active (true) or has been cancelled (false)."},{"id":"82115c79-089b-4f90-b152-c242381d9687","key":"description.booking.customId","value":"Optional custom ID of the booking."},{"id":"ff4d092e-f4f7-467a-84b7-24d621c64ba2","key":"description.booking.eid","value":"The human-readable booking ID. E.g \"100000\"."},{"id":"9a343e37-4ca4-4ce0-9034-988d679f0bbf","key":"description.serviceProvider","value":"Details of the vendor providing the booking."},{"id":"cc190765-8bcf-4de8-9f80-91c09fb592aa","key":"description.request.package.bookingId","value":"The ID of a booking. The package which contains the booking will be returned."},{"id":"5dd568e4-e216-4ecf-b91c-39c43706165f","key":"description.invoice.paymentModifiedDate","value":"The date the invoice payment was last modified. Format: \"YYYY-MM-DD\"."},{"id":"6628687c-da33-4eee-8477-13b979477bef","key":"description.invoice.paymentCreatedBy","value":"The name of the user that created the invoice payment. E.g \"James F\"."},{"id":"e0776640-d312-48ea-9614-0d44e2aab922","key":"description.invoice.paymentCreatedDate","value":"The date the invoice payment was created. Format: \"YYYY-MM-DD\"."},{"id":"f9fa1339-fad5-498d-9d08-6c3ff03531d9","key":"description.invoicePaymentModifiedDate","value":"The date the invoice payment was last modified. Format: \"YYYY-MM-DD\"."},{"id":"5ebb38b1-9755-42d3-a42c-52281f85bb5e","key":"description.invoice.paymentDate","value":"The date the invoice payment was registered for. Format: \"YYYY-MM-DD\"."},{"id":"579f69db-ba93-45b3-8307-fe26c0d82d87","key":"description.request.package.packageId","value":"The ID of a package."},{"id":"e3956e6a-8b80-44bc-9f6b-b583125b4ea7","key":"description.invoice.note","value":"Invoice note. Max. character length:  128."},{"id":"305e3864-0ae4-46e7-8723-6dbe60c8c4f4","key":"description.invoice.modifiedBy","value":"The name of the user that last modified the invoice. E.g \"James F\"."},{"id":"b271f2c7-8487-43ab-a886-0d0921520eb2","key":"description.invoice.createdDate","value":"The date the invoice was created. Format: \"YYYY-MM-DD\"."},{"id":"cf628a64-3dbd-42b6-9ad7-23db13a16fca","key":"description.invoice.createdBy","value":"The name of the user that created the invoice. E.g \"James F\"."},{"id":"b7fda8ef-4393-46c0-9874-2f882a5d5d17","key":"description.invoice.dueDate","value":"The date the invoice is due. Format: \"YYYY-MM-DD\"."},{"id":"654cb415-3711-44f2-a9a7-1b270519eb9f","key":"format.date.simple","value":"Format: \"YYYY-MM-DD\"."},{"id":"df390e47-6115-4396-9250-36868116f893","key":"format.date.long","value":"Format: ISO 8601 extended. E.g \"2025-01-01T09:00:00.000Z\"."},{"id":"d4bfa518-a222-449f-8253-3e72eca3e0a2","key":"description.booking.id","value":"The ID of the booking."},{"id":"96595555-07d9-416c-a0fc-c4a66c6a7b99","key":"description.invoice.id","value":"Unique identifier of the invoice."},{"id":"17813322-1de8-4432-90a0-e96d99fe6df3","key":"description.invoice.number","value":"The human-readable invoice number, suffix increments with each invoice. E.g \"100000-1\"."},{"id":"7daa95e3-5db8-48f1-8d26-49e67baca082","key":"description.invoicePayments","value":"List of package invoice details."},{"id":"1d0274b6-8d7f-4327-9aac-bebacc0f8a6a","key":"description.request.invoiceId","value":"The ID of the invoice you wish to register a payment for."},{"id":"f6c7a9a3-2c6e-4dfc-9c44-12db170f6dc5","key":"description.package.guests","value":"List of additional guests in the package and their details."},{"id":"39a1d0a4-ada8-433a-987d-cb443fbcd93d","key":"description.package.leadGuest","value":"Guest details. The lead guest of the primary booking in the package."},{"id":"149c87fd-07cf-4013-a5ff-4ee7528600e1","key":"description.package.companyPhone","value":"Contact phone number of the POS."},{"id":"e8e9712d-c83c-4b00-a796-18150cacdc2e","key":"description.package.companyEmail","value":"Contact email of the POS."},{"id":"9114ccb1-f51a-4082-8681-d3a442656cec","key":"description.invoice.paymentId","value":"Payment ID registered on the invoice payment. Max. character length:  32."},{"id":"b22a71de-91b9-43ff-bf67-1767c27d4136","key":"description.package.bookings","value":"List of bookings in the package and their details."},{"id":"d2d256db-7a20-4b55-b211-7699f2a0a176","key":"description.package.id","value":"Unique identifier of the package."},{"id":"7e813a1b-ca5a-4780-89c5-57e70cb0a330","key":"description.packageObject","value":"Object containing package information, including package bookings, package guests, and package invoice details."},{"id":"423291df-0ada-470c-92a9-37fa494eaac8","key":"description.item.notes","value":"Internal booking notes. Max. character length:  1024."},{"id":"f84ca544-3b07-4c46-a343-d466fcc0750f","key":"description.package.discountCode","value":"A discount code to apply to the package. E.g \"WINTER20\". Required if any products in the order are using discount code informed pricing."},{"id":"e957c25a-2481-4e0c-af60-dd9569f6cf4a","key":"description.reqAdditionalNameFormat","value":"The required format for guest additionalFirstName and additionalLastName fields. Values: \"ANY_FORMAT\", \"LATIN_ONLY\", \"HIRAGANA_ONLY\", \"KATAKANA_ONLY\"."},{"id":"57603d75-508a-4ce8-8722-13b13bc1a69e","key":"description.invoice.date","value":"The date the invoice was registered for. Format: \"YYYY-MM-DD\"."},{"id":"a51d134c-7db1-4fa4-8291-8c9fb4468240","key":"description.request.listGuests.guests","value":"List of guests and their details. Includes the queried guest, and any additional guests included on bookings where the queried guest is the lead guest."},{"id":"367a781e-409e-4a51-8485-57b486cb62e3","key":"description.guestDetails.address1","value":"Guest address 1. Max. character length:  120."},{"id":"223f5226-216b-4494-9c92-d1ec68f0b6f0","key":"description.guestDetails.language","value":"Guest language. Values: \"en\" (English), \"ja\" (Japanese), \"ko\" (Korean), \"fr\" (French), \"zh\" (Chinese - Traditional), \"zh-CN\" (Chinese - Simplified). "},{"id":"92d6ae09-1520-4b99-b9a0-8120d66e9f6d","key":"description.guestDetails.state","value":"Guest state/province/region. Max. character length:  50."},{"id":"5aa88779-5f0f-4bc0-a810-242f87ed3ef2","key":"description.guestDetails.dietaryRestrictions","value":"Notes on guest dietary restrictions. Max. character length:  1024."},{"id":"3fd794a6-a063-4e57-9540-4ff4288aeb0a","key":"description.guestDetails.city","value":"Guest city. Max. character length:  50."},{"id":"a224c143-5f5f-4786-9cef-fc3ac138d46b","key":"description.guestDetails.medicalIssues","value":"Notes on guest medical issues. Max. character length:  1024."},{"id":"d6c74d38-b7dd-4e90-83be-df002c83d5c9","key":"description.guestDetails.address2","value":"Guest address 2. Max. character length:  120."},{"id":"f51042f1-8900-4bff-8892-80c7cb6664e2","key":"description.guestDetails.emergencyContactName","value":"Guest emergency contact name. Max. character length:  64."},{"id":"935b54d8-4c5e-42b2-ac6b-fcbf6bf91425","key":"description.guestDetails.emergencyContactTel","value":"Guest emergency contact phone number. Max. character length:  32."},{"id":"27b3d225-988a-4370-bd62-10cf839230b7","key":"description.guestDetails.postCode","value":"Guest ZIP/Postcode. Max. character length:  20."},{"id":"55dc2f85-2258-45e9-8f22-795a38c2b6c5","key":"description.guestDetails.nationality","value":"Guest country of residence. Format: ISO 3166 Country Code, e.g \"JP\"."},{"id":"1dd54b16-2194-47dc-baf2-7eb9444acd62","key":"description.product.sequence","value":"Indicates the order in which products should be displayed in a sales UI."},{"id":"3f0963b8-7507-497d-9716-57691ff0de93","key":"description.guestDetails.height","value":"Guest height in centimeters (cm). Min 80, max 200. Format: integer."},{"id":"dad9b802-d44f-47cb-a374-24c8b30a9cb5","key":"description.guestDetails.weight","value":"Guest weight in kilograms (kg). Format: integer. Min 10, max 120."},{"id":"70139b8e-2b93-436c-b734-94f7f54ba1af","key":"description.product.image","value":"Product image. The URL of the image."},{"id":"cd7476e2-0c0a-49cd-add2-8c7b7c610273","key":"description.request.offer.productOptions.position","value":"Index reference of the product option. "},{"id":"5061186a-a832-4ded-85ac-e216fc962611","key":"description.product.description","value":"Product description. Text providing a brief overview or introduction. *"},{"id":"856dd2b0-2102-4aaa-bfd5-5388609ce031","key":"description.products","value":"List of products and their details."},{"id":"a2a34719-072e-46d9-b3ff-6d70e96c453a","key":"description.productOption.value","value":"The value of the product option. Provided if the product option input type is \"FIXED\"."},{"id":"c017a141-5e31-4193-acee-5ea4ff6cd665","key":"description.product.id","value":"Unique identifier of the product."},{"id":"4b36836b-1c6d-44a3-be00-3613a30e1ee7","key":"description.categoryId","value":"The category ID of the product."},{"id":"4902ae1b-faaf-4790-9711-f819b384af47","key":"document.version","value":"DOC VERSION 1.0"},{"id":"64db872b-7041-4d10-b2b1-6a07a66269d7","key":"description.package.totalAmount","value":"Total price of the package bookings."},{"id":"eae1b59a-def1-4840-ba89-a69cfdf6894b","key":"description.priceRack","value":"The gross price after price adjustments."},{"id":"60364a84-4a4f-4050-801c-454ce8f4b86a","key":"description.dateRange.startDate","value":"The start date of the date range.  Format: \"YYYY-MM-DD\"."},{"id":"6b854c04-a16b-4c33-82a7-50f16563ace2","key":"description.dateRange.endDate","value":"The end date of the date range.  Format: \"YYYY-MM-DD\"."},{"id":"cfb0a564-9179-4514-a266-903aad763c93","key":"description.request.productId","value":"The ID of the target product."},{"id":"42d7d5fc-8882-46ee-9c95-e77722bcb772","key":"description.numberGuests","value":"The number of guests the product can accommodate."},{"id":"28951cc2-6b04-4835-bf5a-3290fc0a9df7","key":"description.package.receivedAmount","value":"Total payments received towards package bookings."},{"id":"6e2bfef5-cc42-45cd-9c86-0f86347d4e3e","key":"description.package.companyName","value":"Company name of the POS."},{"id":"4cb90e19-f8e1-4d49-a915-ddb5b6bfd176","key":"description.invoice.paymentModifiedBy","value":"The name of the user that last modified the invoice payment. E.g \"James F\"."},{"id":"268adec2-bdc3-432c-a8bf-29773182bc46","key":"description.guestDetails.dateOfBirth","value":"Guest date of birth.  Format: \"YYYY-MM-DD\"."},{"id":"0b72bdab-287f-4528-b8b4-3cc544b51e56","key":"description.guestDetails.additionalFirstName","value":"An additional or alternate guest first name. May be required to consist of only Japanese hiragana, Japanese katakana, or latin characters depending on vendor settings. Max. character length:  32."},{"id":"de303f89-3026-4a77-b737-c104a1283690","key":"description.guestDetails.lastName","value":"Guest last name. Max. character length:  32."},{"id":"d8d03041-b970-4622-b8b5-2790dfa93f5a","key":"description.guestDetails.title","value":"Guest title. Values: \"MR\", \"MRS\", \"MS\", \"DR\"."},{"id":"364f9e7b-1d0c-41eb-8c14-15e065924ec8","key":"description.request.categoryId","value":"The ID of the target category."},{"id":"5580ab78-13e6-4d3d-bf99-c2c97ccd1ea2","key":"description.productOption.compulsory","value":"When true, a value for this product option is required in order to book the product."},{"id":"d285a090-3c23-4c14-859d-d0b556277764","key":"description.productOption.selectItems.label","value":"The label of the select item option. E.g \"Beginner\", or \"2 Days\". *"},{"id":"43791802-31e6-48d0-97d6-3e15326601ab","key":"description.auth.authOnlyMethod","value":"This method returns sensitive information and is only accessible via credential-authenticated request. Not for public usage."},{"id":"2796abe8-700d-4970-9c03-80c9d3c9eb92","key":"description.item.startDate","value":"The start date of the booking item.  Format: \"YYYY-MM-DD\"."},{"id":"fe3fd339-0fc0-4ad7-9361-34602c6d74ab","key":"description.items","value":"List of booking items, with their booking details and product option selections."},{"id":"280d8706-1776-4478-b73c-bd06e0890914","key":"description.request.guestFields","value":"List of guest fields with their visibility/requirement settings. Values: \"SHOW\", \"REQUIRE\"."},{"id":"c818b89a-4b06-4414-8ee1-deddbdd5dc3d","key":"description.productOption.selectItems","value":"A list of options from which the product option value can be selected. Provided if the product option input type is \"DROP_DOWN\"."},{"id":"245ba6a0-3ed2-43df-97e5-4a19b6f1b199","key":"description.guestDetails.gender","value":"Guest gender. Values: \"MALE\", \"FEMALE\", \"OTHER\"."},{"id":"0571aed0-4a86-41cb-9634-241eb629c2fd","key":"description.priceGross","value":"The gross price of the product."},{"id":"d57b4a32-9e0f-4f2d-b980-c141d1f39e62","key":"description.guestDetails.firstName","value":"Guest first name. Max. character length:  32."},{"id":"929b3b1b-2df6-492c-83e8-a656be6e75a4","key":"description.offer.quantityAvailable","value":"The amount of stock available for the specified product. A value of 5 indicates at least 5+ items available for booking. A non-numeric value indicates the product is not limited by stock."},{"id":"41bac61a-d3c4-4f09-91a6-49b36de2cf3f","key":"description.offer.minAssociatedGuests","value":"The minimum number of guests required to be associated to a product when making a booking."},{"id":"0e812855-58a5-4c17-bd05-719a5a69326d","key":"description.offer.productOptions","value":"List of product options and their selected values."},{"id":"f0f2a6cb-309e-4f98-9edd-5564375c81a9","key":"description.item.bookingElementId","value":"The ID of the booking element."},{"id":"0b295c0f-b107-4b01-944e-e3d7020b0c21","key":"description.request.vs","value":"When a valid vendor set code is provided, only vendors belonging to the specified vendor set will be returned."},{"id":"d14df1f2-828e-499f-b634-bf63683497cd","key":"description.productOption.inputType","value":"The input type of the product option. Indicates if submitted values can be free text, are limited to preset select item options, or are a fixed value. Values: \"FREE_TEXT\", \"DROP_DOWN\", \"FIXED\"."},{"id":"97c47663-f616-4a6e-8955-56e34df1bad5","key":"description.invoice.modifiedDate","value":"The date the invoice was last modified. Format: \"YYYY-MM-DD\"."},{"id":"a9f3ba0b-9609-4e8b-a893-3ed654469fc2","key":"description.request.lang","value":"The language in which localised content will be returned. Defaults to English."},{"id":"fa5d01fa-5aa4-4b6a-8f29-1a46d32f8316","key":"description.request.vendorId","value":"The ID of the target vendor."},{"id":"dd64b58a-ea8e-4152-9f15-3a6433f2eb39","key":"description.request.countryCode","value":"The country code of the city or resort area."},{"id":"bc48bd99-ebce-4067-a4d6-257cd480a401","key":"description.request.locationCode","value":"The city or resort area."},{"id":"34a80cd6-a65c-4189-b6e9-b92cd4770d33","key":"description.invoice.paymentAmount","value":"The amount of the invoice payment."},{"id":"8cff018f-0bb2-4105-8355-44c560b8a6fd","key":"description.product.guestImageRequired","value":"When true, association of a guest with a Guest Image is required to book this product."},{"id":"eb1f6707-5933-4fec-a744-3e38c0f26be9","key":"description.posId","value":"Unique identifier of the Point of Sale. The company making the API call or purchase."},{"id":"dc5efb2a-15bd-49cb-93ee-c1fc51723710","key":"description.lang","value":"The language in which localised content will be returned."},{"id":"db16c77c-8b4a-47e1-898c-fff1a88bf855","key":"description.vendorId","value":"The vendor ID of the product."},{"id":"72718203-d3af-4160-82ed-ca333b74b4e3","key":"description.productOption.label","value":"The label describing a product option. E.g \"Skill Level\", or \"Number of Days\". *"},{"id":"2b0f8490-e757-4269-9ccd-b44da71a6db1","key":"description.productOption.id","value":"Unique identifier of the product option."},{"id":"67d6a959-a57d-474e-be56-73761f6f9066","key":"description.countryCode","value":"The country code used in the request."},{"id":"cb8823b8-0430-4ff2-9bb8-d8150a70236e","key":"description.locationCode","value":"The location code used in the request."},{"id":"5d294513-37bd-4e8e-a921-686b97c2408a","key":"description.product.unavailableDates","value":"List of date ranges where this product cannot be booked."},{"id":"ab1b1124-9d4c-4b7a-b786-db5a699b28c5","key":"description.context.categoryId","value":"The category used in the request."},{"id":"60c69059-a52d-4df5-8175-40c822ccf6f1","key":"description.invoice.paymentNotes","value":"Payment note. Max. character length:  128."},{"id":"c9f1170d-214d-4c78-bf0f-6813911c2147","key":"description.vendors","value":"List of vendors and their details."},{"id":"fe70fb1b-f9e6-4c80-a37b-e5d6a0385748","key":"description.request.discountCode","value":"A discount code to apply to the package. E.g \"WINTER20\". If valid, adjusted pricing will be returned with the offer. Only one discount code may be applied to a single package order."},{"id":"8edcf5b9-171a-4ba4-8349-0af8525abe0e","key":"description.vendor.id","value":"The ID of the vendor."},{"id":"b3850b6b-5990-4707-92da-3ef0ff85d2e3","key":"description.vendor.name","value":"Vendor name."},{"id":"f55abd88-ea2f-490e-9ff0-c149b5fc3c7f","key":"description.vendor.image","value":"Vendor image/logo. The URL of the image."},{"id":"dd964ab2-bfdb-447e-b956-3bdb4656489d","key":"description.vendor.url","value":"Vendor URL. The website or landing page of the vendor."},{"id":"2641c999-5539-4d25-a8ab-7bb59a4836c5","key":"description.vendor.description","value":"Vendor description. Text providing a brief overview or introduction. *"},{"id":"0609260b-3698-4e2c-96f5-c7e4938ed382","key":"description.vendor.countryCode","value":"The country which the vendor location belongs to."},{"id":"a898e1f7-989f-43a0-857e-294345b0d3b4","key":"description.vendor.locationCode","value":"The city or resort area in which the vendor is located. "},{"id":"6c4fcd15-cf64-4cb0-b752-5d9ddb8a5305","key":"description.request.offer.productOptions.value","value":"Selected value for the product option."},{"id":"0b412f14-22e8-425c-9228-51af428289fd","key":"description.vendor.latitude","value":"The latitude coordinate of the vendor. Used in conjunction with the \"longitude\" value to indicate the location on a map."},{"id":"70e7c2f9-dc9b-4a2a-8cda-67bd19961c30","key":"description.vendor.longitude","value":"The longitude coordinate of the vendor. Used in conjunction with the \"latitude\" value to indicate the location on a map."},{"id":"cc41bb70-d1c0-4598-8930-f656ed621931","key":"description.vendor.currencyCode","value":"The currency used by the vendor. Format: ISO 4217 currency code, e.g. \"JPY\"."},{"id":"c76b3007-0d3e-4feb-9223-bd79e389022b","key":"description.vendor.vendorType","value":"Distinguishes a vendor as a seller of either non-accommodation services or accommodation stays. Values: \"NON_ACCOMMODATION\", \"ACCOMMODATION\"."},{"id":"c81388a6-2220-4598-94bc-deb275966284","key":"description.offer.startDate","value":"The start date of the product booking."},{"id":"20841301-66fd-4eb3-bb10-71346bd32cee","key":"description.product.productOptions","value":"List of product options and their details."},{"id":"cb967359-3b83-4887-97b4-8778a7d36163","key":"description.vendor.bookingPermission","value":"Indicates the maximum booking extent the point of sale can make. Represents the level of booking access is granted by the vendor. Values: \"RESERVATION\", \"REQUEST\", \"REQUEST_INTERNAL\". Note availability, stock and other factors may prevent bookings from being made at the stated level."},{"id":"d8372660-0117-4264-a4ef-0449abd92c40","key":"description.productOption.selectItems.value","value":"The value of the select item option. E.g \"Beginner\", or 2."},{"id":"320936c3-9307-4381-a967-4bd1a49df1b6","key":"description.request.guestEmail","value":"The email of the target guest."},{"id":"509f8aba-637d-473f-81f1-4024f39ff57d","key":"description.productOption.position","value":"Indicates the order in which product options should be displayed in a sales UI."},{"id":"fb58dc5e-290d-4dc8-bb26-386b02d9a44e","key":"description.vendor.bookAndPayEnabled","value":"Enabled when the vendor has the required settings in place to take online payments."},{"id":"e555acd9-1d33-4c84-821d-8c9a878b5566","key":"description.vendor.hideRequestIfBookAndPayEnabled","value":"Indicates the UI should not present the option to make a booking enquiry if a booking reservation can be made."},{"id":"926068f5-9586-4677-ba61-27d196ea2116","key":"description.categories","value":"List of categories and their details."},{"id":"8b963381-ba40-4ef6-82c6-53147b61f29c","key":"description.request.listGuests.guestId","value":"The guest ID of the queried guest."},{"id":"d2aadbca-4957-4744-b67f-c1f6d284a4b8","key":"description.reqNameFormat","value":"The required format for guest firstName and lastName fields. Values: \"ANY_FORMAT\", \"LATIN_ONLY\", \"HIRAGANA_ONLY\", \"KATAKANA_ONLY\"."},{"id":"b9f55498-7806-461c-889b-02e711d3f6b7","key":"description.request.vendorIds","value":"List of vendor IDs to be queried."},{"id":"a7b11915-ff33-4355-88e7-534183fe4818","key":"description.request.guestId","value":"The ID of the target guest."},{"id":"1f4e8a12-d7c1-4217-9b0b-4dd88aca6732","key":"description.product.name","value":"Product name. *"},{"id":"8c50ec74-fb58-4121-a50b-7e9153a2bb2f","key":"description.category.id","value":"Unique identifier of the category."},{"id":"2cd9466f-7f86-46ff-9037-633e69f2163f","key":"description.category.name","value":"Category name. *"},{"id":"131bb51c-2932-43cc-a73b-93b57307d34f","key":"description.category.image","value":"Category Image. The URL of the image."},{"id":"6cdfb4d6-35b5-451c-8b62-822775541929","key":"description.category.sequence","value":"Indicates the order in which categories should be displayed in a sales UI."},{"id":"739d9391-1f73-4cb8-929b-4e0b3e49b81d","key":"description.category.description","value":"Category Description. Text providing a brief overview or introduction. *"},{"id":"5ae6d02d-d92f-486b-8d49-22da79e06587","key":"description.guestDetails.phoneNumber","value":"Guest phone number. Max. character length:  64."},{"id":"9d984bbe-bd50-4e3f-95db-da3d22eb6342","key":"description.guestDetails.additionalLastName","value":"An additional or alternate guest last name. May be required to consist of only Japanese hiragana, Japanese katakana, or latin characters depending on vendor settings. Max. character length:  32."},{"id":"1198ccf3-b3f9-403c-b026-aee5088b6311","key":"description.guestDetails.email","value":"Guest email. Max. character length:  64."},{"id":"60844130-a2ec-41f7-9658-bbfad6cb0317","key":"description.category.active","value":"The active status of a category."},{"id":"5fcfeb15-d7b6-45a7-8910-e3150be52f58","key":"description.category.children","value":"List of child categories."},{"id":"b8299f60-2559-4512-80ac-7b70a46344fb","key":"description.guestImage","value":"Guest Image. The URL of the image."},{"id":"02f1110e-6215-4d92-8450-69da15dcec22","key":"description.localisedContent","value":"Localised content (*): If available, text for this field will be returned in the language specified by the lang parameter. If unavailable, English text will be returned."},{"id":"a8be00c9-32e6-4df5-82fb-f6266d9562b4","key":"description.context.vendorId","value":"The vendor ID used in the request."},{"id":"6b820a05-ee01-4370-8362-2027199646c2","key":"description.optional","value":"Optional:"},{"id":"d84f6ff3-0352-4fdc-91bf-9ec097c724ff","key":"description.product.hasOffers","value":"Indicates whether a product has availability for booking within the next two years."},{"id":"a2e32c04-945a-4b8c-b838-97715a32c69c","key":"description.request.offer.productOptions","value":"List of product options and their selected values, referenced by position index."},{"id":"3ac2f4a4-7f92-423d-acef-b559b594658d","key":"misc.maxCharacterLength","value":"Max. character length: "},{"id":"17ce7820-576a-41b3-b7fa-5c9f8d8db77c","key":"ACCOUNTSRECEIVABLE","value":"Accounts Receivable"},{"id":"b03ef29a-5970-4656-836f-c910ee76d637","key":"BANKTRANSFER","value":"Bank Transfer"},{"id":"d0c8e33b-bbd7-4152-a6b9-130ef1eda1d5","key":"CASH","value":"Cash"},{"id":"3a165f00-40ae-40e9-a65a-7a7132051055","key":"CHEQUE","value":"Cheque"},{"id":"ba91a42d-e550-4e39-8974-d89c04963f8f","key":"CREDITCARD","value":"Credit Card"},{"id":"772b11a1-fe9b-495d-952d-7efd68deb25a","key":"ECPAY","value":"ECPay"},{"id":"f6bd5f6f-1278-4fe9-ba75-daba29932bf0","key":"PAYGENT","value":"Paygent"},{"id":"14b4600c-0207-4031-a2f5-0524e34abd22","key":"PAYPAL","value":"Paypal"},{"id":"9d726d79-d54d-467b-8333-15863b06946b","key":"SOFTBANK","value":"Softbank"},{"id":"05228c26-b412-4f45-bbe1-8354ee1a0848","key":"SQUARE","value":"Square"},{"id":"a73dddf6-a2ce-4af2-9567-d74f859cab59","key":"STRIPE","value":"Stripe"},{"id":"10775a21-c214-4d1a-a429-3b1b367503ff","key":"FLYWIRE","value":"Flywire"},{"id":"c2287d22-4002-43ea-bc67-64d84a5a5c3a","key":"VERITRANS","value":"Zenryo Payment"},{"id":"26390846-a52d-4339-a7c6-62f9b7a4fcdc","key":"CHECKOUTCOM","value":"Checkout.com"},{"id":"ea8b19a5-3078-4298-8c8c-a38cca698476","key":"VOUCHER","value":"Voucher"},{"id":"c645650c-2a27-4468-be27-38644150c7e1","key":"COUPON","value":"Coupon"},{"id":"ce76dda2-5551-4ee1-a61b-4674ff56db95","key":"OWNERACCOUNT","value":"Owner Account"},{"id":"8af81884-f894-4719-9975-26b6f5236bd1","key":"OTHER","value":"Other"},{"id":"4ff6810f-c993-4eb6-9dd7-0bf362bd393c","key":"PROMOTIONAL","value":"Promotional"},{"id":"bc05013e-b267-47b8-9c9c-b835d448e1c8","key":"ROOMCHARGE","value":"Room Charge"},{"id":"403071bd-bebd-4ad6-ad80-a78999c73d9a","key":"FURUSATO_NOZEI","value":"Furusato Nozei"},{"id":"f3e1f295-e9f2-4e40-8516-7db2a935a7d2","key":"ALIPAY","value":"Alipay"},{"id":"3988f108-ef0a-4cb5-b1fb-05276ff7e2a4","key":"PAYPAY","value":"PayPay"},{"id":"299a0eb9-4833-43e8-8af1-c55ba4e95eb7","key":"CREDITCARD_AMEX","value":"Credit Card-AMEX"},{"id":"f1888b5c-4750-4024-940d-c83e393913cb","key":"CREDITCARD_DC","value":"Credit Card-DC"},{"id":"ec12ff2a-710d-4423-90cc-0f75fbeb79fa","key":"CREDITCARD_GINREI","value":"Credit Card-Ginrei"},{"id":"a5c57121-339e-4906-bde7-dde300d13799","key":"CREDITCARD_JCB","value":"Credit Card-JCB"},{"id":"06448b01-0da3-42d1-8bf4-deaa60bce866","key":"CREDITCARD_MASTERCARD","value":"Credit Card-Mastercard"},{"id":"5a4972cd-be89-4b8c-8fc6-9b09cd254924","key":"CREDITCARD_MUFG","value":"Credit Card-MUFG"},{"id":"2d999c44-c5ec-46c0-b8a4-6ce89193d8f1","key":"CREDITCARD_NICOS","value":"Credit Card-NICOS"},{"id":"2e2fcf26-5493-421e-ac73-3ec0fc2b8e1b","key":"CREDITCARD_RAKUTEN","value":"Credit Card-Rakuten"},{"id":"7f5eac63-2827-48c7-a297-3aa83b1066ee","key":"CREDITCARD_VISA","value":"Credit Card-VISA"},{"id":"bae306c8-cc09-47aa-b6ae-488e577473f5","key":"CREDITCARD_UC","value":"Credit Card-UC"},{"id":"018e201f-271b-4dd5-aca6-b39c8fa9376e","key":"GOTO_PAPER_COUPON","value":"GoTo Paper Coupons"},{"id":"768faec2-f474-44e5-b5d9-82c95627c8e1","key":"GOTO_E_COUPON","value":"GoTo E-Coupons"},{"id":"38870c50-230f-481d-a947-50341af10533","key":"GMO","value":"GMO"},{"id":"57bfe229-491b-4726-ac0c-30516dce7377","key":"misc.code","value":"Code"},{"id":"a201a740-8b4d-4df2-9a79-b1e2482aa232","key":"misc.paymentMethods","value":"Payment Methods"},{"id":"26e06118-b152-4526-a170-8450ab5450dd","key":"misc.paymentMethod","value":"Payment Method"},{"id":"edb9f8fc-fd01-4137-8dfb-61c392084f34","key":"description.booking","value":"Object containing details of the booking. Includes the id, status, and items of the booking."},{"id":"e15765b2-59c7-4153-93e3-1c751e7606cb","key":"description.booking.status","value":"The status of the booking. Values: \"ACTIVE\", \"CANCELLED\""},{"id":"9bd8b019-644b-4e77-99f6-ebe347cba7d6","key":"description.booking.items","value":"List of item sync details."},{"id":"aeacfff0-7952-42cb-8fd9-729e11162a72","key":"description.item.guest.id","value":"The ID of the guest associated to the item."},{"id":"02377bca-39ac-41b3-ab12-1243c8408af8","key":"description.item.skidata.syncStatus","value":"The status of the sync to SKIDATA. Values: \"SYNCED\", \"CANCELLED\", \"NOT_SYNCED\", \"NOT_QUEUED\""},{"id":"966ce61f-43a1-41a8-a7df-1718bdd962da","key":"description.item.skidata.status","value":"The status of the item in SKIDATA. Values: \"PENDING\", \"RESERVED\", \"BOOKED\", \"BOOKED_AND_TRANSFERRED\", \"BOOKED_AND_REJECTED\",  \"CANCELED\", \"CANCELED_AND_TRANSFERRED\", \"CANCELED_AND_REJECTED\", \"CORRECTED\",  \"NO_STATUS\", \"NOT_PAID\", \"PAID\", \"REFUNDED\", \"REFUNDED_AND_TRANSFERRED\",  \"REFUNDED_AND_REJECTED\""},{"id":"08ac0bd1-6fd4-41b1-b5ab-2bfbaa6cd518","key":"description.item.skidata.orderId","value":"The order ID of the item in SKIDATA."},{"id":"32c35b5c-b955-4d32-bb87-8d21942a67b5","key":"description.item.skidata.confirmationNumber","value":"The confirmation number provided by SKIDATA."},{"id":"44bece0b-3b55-4c92-a3b7-6d3dfa3ccf62","key":"description.item.skidata.orderType","value":"The order type of the item. Values: \"NEW\", \"RECHARGE\"."},{"id":"d7bd2457-b69d-40d9-a8bf-53d5d6490bb2","key":"description.item.skidata.liftPassNumber","value":"The lift pass number from SKIDATA. This is null if the pass has not yet been collected."},{"id":"0ccfeb5a-a867-4d92-9e5b-2b8dad7ee030","key":"description.item.skidata.permissionNumber","value":"The permission serial number from SKIDATA. This is null if the pass has not yet been collected."},{"id":"e02ad829-5f27-4c32-9d56-7baec8df8f5f","key":"page.getSkidataSync.overview","value":"This method returns information about the synchronization status of the SKIDATA booking."},{"id":"73f260ad-91c4-4dfe-aad8-856b959643f6","key":"description.priceNet","value":"The gross price after commission."},{"id":"b5345eca-8001-4efd-86c8-d03417bf49b2","key":"misc.packageBookingItems","value":"Package Booking Items"},{"id":"94189db7-325e-4365-8f6f-7aff87903bbc","key":"description.package.itemAssociatedGuests","value":"List of guests associated with the booking item. "},{"id":"a60a7cf6-2e47-4fa0-a9b9-4456f5f47bad","key":"description.category.hasOffers","value":"Indicates whether a category product has availability for booking within the next two years."},{"id":"7303392b-4f82-4d6d-b26d-12640e037ac8","key":"description.item.skiPassNumber","value":"The SKIDATA ski pass number. Required for SKIDATA recharge bookings."},{"id":"923a4692-74d4-4dbb-9cbe-2afbb3553882","key":"description.error.guest_associated_to_mutiple_items","value":"The guest cannot be associated to multiple items in a booking."},{"id":"e9094203-9059-472b-b4a5-d8e5358a06b6","key":"description.error.missing_ski_pass_number","value":"The ski pass number is missing."},{"id":"f9291b31-0b6e-48d6-843d-a05a35a58df5","key":"description.error.invalid_ski_pass_number","value":"The specified ski pass number is invalid."},{"id":"e0268e5d-8035-44b2-bcca-e7ccc685127e","key":"page.listProducts.text.productOptions1","value":"Product options are used to collect information about a guest or the product they are buying."},{"id":"a7059aa8-5985-4efa-a5ba-f4d785d90dcb","key":"page.listProducts.text.productOptions2","value":"Each product is configurable with up to 10 independent product options, such as \"Number of Days\", \"Start Time\", or \"Shoe Size\". Some options can be price affecting, and can also be set as compulsory for booking."},{"id":"7d272eaf-2ecd-4fab-969e-6b6f03ddb067","key":"page.listProducts.text.productOptions3","value":"The format of a product option value is dependent upon its input type. This determines if the product option is intended to allow for selection from a list, accept free text input, or to display a fixed value."},{"id":"c2658e51-d96e-406c-8cc3-f323a194bda5","key":"page.listProducts.text.productOptions4","value":"The product options object provides the necessary data required to build/present these options."},{"id":"953db059-22f8-4c1c-9dc7-063d53b8de34","key":"apiVersion","value":"1.0"},{"id":"cd91c7f8-e7d6-4654-9e50-066c32dda903","key":"page.intro.method.skidataSync","value":"Retrieve synchronisation status for SKIDATA lift pass bookings."},{"id":"4bf9dc1c-12e2-487c-8ce8-0def1957e918","key":"description.request.package.bookingEid","value":"The 7-digit EID of a booking. The package which contains the booking will be returned."},{"id":"78a5e3ad-1f0f-4871-bbbb-cfdaf6b4a5a8","key":"description.request.list.countryCode","value":"The country code of the resort."},{"id":"bc98459c-7b51-4d98-a7d3-eabfb2e27c74","key":"description.request.list.locationCode","value":"A city or resort area."},{"id":"9ae241dc-cba3-4ed4-84b2-510547edeaae","key":"description.request.listAvailable.hotelId","value":"Specify which hotel(s) you wish to query. This parameter may be specified multiple times."},{"id":"672531ec-6dce-449e-9cd5-49941691ec44","key":"description.request.listAvailable.checkIn","value":"Specify the check-in date. Format: yyyyMMdd"},{"id":"f9388804-0854-492b-996b-e15f7844fc23","key":"description.request.listAvailable.checkOut","value":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"id":"43278030-8733-4539-ac49-a15a4b8d13b7","key":"description.request.listAvailable.numberGuests","value":"Specify the number of guests in the group"},{"id":"fbacc04e-a3db-4891-89e4-15827ea0f50e","key":"description.listAvailable.excludeConditionsNotMet","value":"Optional flag to exclude those room types which do not have rates for the given dates, or cannot be booked due to booking window restrictions."},{"id":"dc4e5118-070f-45b5-841f-84189da98921","key":"description.listAvailable.discountCode","value":"Optional field to specify a discount code to view rates after the application of the discount code. If the discount code is invalid or not applicable, then the rates are displayed without the application of the discount."},{"id":"a5fe29d8-22ce-4cd2-a486-8476dfb9ccbc","key":"description.listAvailable.rate","value":"Must be `ota`. Indicates OTA style rate plans should be used."},{"id":"42127930-c096-4256-89a1-451af5ed903f","key":"description.createBooking.customId","value":"Specify an alphanumeric custom ID for the booking. This parameter is optional."},{"id":"54c009d8-9fdf-44dc-81f0-277761e58f88","key":"description.request.createBooking.hotelId","value":"Specify the hotel ID of the hotel."},{"id":"ba2527c8-2865-4de7-9681-c9960f1e47be","key":"description.request.createBooking.roomTypeId","value":"Specify the room type of the first room to book."},{"id":"b038818d-fdcb-4fa5-8a66-8d5b6cdccea7","key":"description.request.createBooking.checkIn","value":"Specify the check-in date of a room in the booking. Format: yyyyMMdd"},{"id":"50c6cdf1-aba9-4bf3-a94e-6df612a43c51","key":"description.request.createBooking.checkOut","value":"Specify the check-out date. Format: yyyyMMdd. Note the check-out date can be at most 20 days after the check-in date."},{"id":"0891aa0a-fce5-4538-baac-4b1d88141c2e","key":"description.request.createBooking.numberGuests","value":"Specify the number of guests of a room in the booking.\nIf recordGuestType is enabled, the total numberAdults + numberChildren for a room must be equal to this value.\n"},{"id":"5c2bd81f-df19-41e6-92a6-e1add21943dd","key":"description.request.createBooking.numberAdults","value":"Specifies the number of adults of a room in the booking. If recordGuestType is enabled, this parameter must be set as 1 or more, and may not exceed the maxNumberGuests or maxNumberAdults of the room type."},{"id":"f828518d-57d6-4769-ad40-8a1f45b0b836","key":"description.request.createBooking.numberChildren","value":"Specifies the number of children of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberChildren of the room type."},{"id":"fde6f3b1-c814-443a-92d0-4de3bc01e457","key":"description.request.createBooking.numberInfants","value":"Specifies the number of infants of a room in the booking. If recordGuestType is enabled, this parameter must be set as 0 or more, and may not exceed the maxNumberGuests or maxNumberInfants of the room type."},{"id":"bd9dd9b9-ff6e-409b-b6e1-bb70bf046a41","key":"description.request.createBooking.priceRetailMax","value":"The maximum retail price to complete the booking. This should be set using the priceRetail value provided to you via the listAvailable method. It acts as a safety mechanism to prevent booking creation if the price is now higher, for example due to dynamic pricing."},{"id":"67c016d9-f7e6-4e0c-b824-523728f1791b","key":"description.request.createBooking.guestGivenName","value":"The given name / first name of the lead guest."},{"id":"d5bbc23a-fa0b-429d-9ca0-f2f546a66ae8","key":"description.request.createBooking.guestFamilyName","value":"The family name / last name of the lead guest."},{"id":"9e6d8c78-8dfc-47f7-89b6-aaa242777b7f","key":"description.createBooking.guestEmail","value":"The email address of the lead guest. This parameter is optional."},{"id":"bbee8ceb-451a-4fc6-98ce-96a3ec480c91","key":"description.createBooking.bookingExtent","value":"The extent of the booking. Can be REQUEST_INTERNAL, REQUEST, RESERVATION. This parameter is optional; the default is assumed to be RESERVATION. The booking extent cannot be set to REQUEST_INTERNAL if it is a direct booking."},{"id":"b6fe8749-cddc-49d1-8a27-1f16f1ead1e7","key":"description.createBooking.widgetUrl","value":"This is an optional parameter which sets the Widget URL of the booking. This is useful to store a URL with the booking to determine its source."},{"id":"c182a14c-e275-47a9-b130-5050b45f6986","key":"description.createBooking.discountCode","value":"This is an optional parameter which allows the use of a discount code for the booking. If the discount code is invalid, then the booking is created without the application of the discount. No specific feedback is shown at present to determine if the discount code was successfully used or not."},{"id":"115fa504-1a3a-48dd-bb59-9818fb12bf38","key":"description.createBooking.comment","value":"This is an optional parameter which sets the vendor/agent message based on whether the booking is a direct/agent booking respectively. This functions in the same manner as the booking widgets provided by RoomBoss."},{"id":"26822e01-bab2-4105-8edd-cd799711da78","key":"description.createBooking.gender","value":"This is an optional parameter which sets the gender of the guest. Accepted values are MALE, FEMALE or OTHER."},{"id":"ceca378c-5835-4b0e-97f7-f7d98298e14b","key":"description.createBooking.country","value":"This is an optional parameter which sets the country of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"id":"6ddb6a40-7369-4757-9d8a-849f83b8135f","key":"description.createBooking.dob","value":"This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyyMMdd, as with all other dates offered by the Hotel REST API."},{"id":"cf691ca3-a835-4a2f-85b3-c09721e31f89","key":"description.createBooking.contactNumber","value":"This is an optional parameter which sets the contact number of the guest."},{"id":"cf970af4-f628-43d2-afff-1d24b5800c96","key":"description.createBooking.postcode","value":"This is an optional parameter which sets the postcode of the guest."},{"id":"3d380cc9-610e-4f47-91ea-3c3084433de6","key":"description.createBooking.adminRegion","value":"This is an optional parameter which sets the administrative region (state, province, prefecture, protectorate, etc.) of the guest."},{"id":"cceb8fe8-7b38-41e7-8894-452710f14243","key":"description.createBooking.city","value":"This is an optional parameter which sets the city of the guest."},{"id":"11536daf-2102-489e-8e36-dbab6d3c25a6","key":"description.createBooking.address1","value":"This is an optional parameter which sets the address line 1 of the guest."},{"id":"fce9b4d8-6fc1-45c3-b610-6156a1793f12","key":"description.createBooking.address2","value":"This is an optional parameter which sets the address line 2 of the guest."},{"id":"c0cf29db-8c3c-477a-9f09-4aa65f197de3","key":"description.createBooking.lang","value":"This is an optional parameter which sets the locale language of the guest."},{"id":"6d206729-70bf-4628-b611-3d6e0638c73d","key":"description.createBooking.dietRestrictions","value":"This is an optional parameter which sets the dietary restrictions of the guest."},{"id":"11be9a1e-72cf-420a-872f-484f8c3a6256","key":"description.createBooking.emContactName","value":"This is an optional parameter which sets the emergency contact name of the guest"},{"id":"037653b6-b825-44ad-a3c7-51158b0180f8","key":"description.createBooking.emContactTel","value":"This is an optional parameter which sets the emergency contact number of the guest."},{"id":"871c4319-641a-4231-bb75-1f2bc1744e2a","key":"description.createBooking.rate","value":"Must be `ota` and indicates new OTA style rate plans should be used."},{"id":"600d0011-b822-412f-9dec-9b887dcd99da","key":"description.createBooking.ratePlanId","value":"This is a required parameter as `rate` param value is set to `ota`. List of selected rate plan Ids."},{"id":"fa470b56-6458-47ce-a7f8-4b74945a38a8","key":"description.request.listBooking.bookingId","value":"Specify the alphanumeric ID for the booking."},{"id":"8a141914-25ec-4022-bce5-07424136949e","key":"description.request.listBooking.bookingEid","value":"Specify the alphanumeric EID for the booking."},{"id":"1e17d2f1-3c2a-42f8-8c5c-44b5c24fbf9c","key":"description.request.cancelBooking.bookingId","value":"Specify the alphanumeric ID for the booking."},{"id":"1415aac4-01f2-4190-9a28-53caadf3d3cc","key":"description.request.cancelBooking.bookingEid","value":"Specify the alphanumeric EID for the booking."},{"id":"97a2c231-506d-4a3f-9c61-c46f69afd041","key":"description.request.createPayment.bookingId","value":"Specify the alphanumeric ID for the booking to create payment for."},{"id":"870f6d15-61ac-4d3c-a338-a054dfda4d0d","key":"description.request.createPayment.bookingEid","value":"Specify the alphanumeric ID of the invoice that is being paid."},{"id":"3fbe7f69-36d9-40dc-998d-718cfd71138f","key":"description.request.createPayment.paymentId","value":"Specify the ID of the payment, typically the ID provided by the payment gateway."},{"id":"32e68c6c-2db3-4c03-becc-c1836e465ca9","key":"description.request.createPayment.paymentAmount","value":"Specify the payment amount. (The currency defined by the currencyCode of the hotel is assumed.)"},{"id":"2b34dcda-eda6-418a-afdf-e07c8b414de0","key":"description.request.listBookings.date","value":"Specify the date to search."},{"id":"6822b4ab-5bed-4124-9e59-9a98c2988183","key":"description.listBookings.bookingType","value":"Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. The default is ALL."},{"id":"8127ac98-ff06-4a60-b8e6-a0eba4f5f69c","key":"description.request.listPayments.date","value":"Specify the date to search."},{"id":"9fc2f5da-e4d4-4665-8702-d75032985948","key":"description.listPayments.filter","value":"Specify whether only accommodation or only service bookings, or both should be retrieved. The accepted values are ACCOMMODATION, NON_ACCOMMODATION or ALL. This parameter is optional. The default, if not specified, is ALL."},{"id":"5d389ec0-af21-47df-9e92-b0c356436411","key":"description.request.listImage.hotelId","value":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."},{"id":"80f03384-4f15-4a28-9881-60332f0a3185","key":"description.request.listDescription.hotelId","value":"Specify which hotel(s) you wish to receive images for. This parameter may be specified multiple times to receive images for multiple hotels."},{"id":"9d5eb9c1-579e-4171-a275-42752d9b55da","key":"description.request.listDescription.locale","value":"Specify the language to return. Legal values are {\"en\",\"ja\",\"fr\",\"zh-cn\",\"zh\",\"ko\"}.\nNote the hotel name has entered in just 1 language; value won't change as the local parameter is changed. (We should address this in the future.)\nNote it will return English text if there is no text for the selected language.\n"},{"id":"d87287ea-2547-4c58-a570-236c1e1dc4ad","key":"description.request.listRatePlanDescription.hotelId","value":"Specify which hotel(s) you wish to receive rate plan descriptions for. This parameter may be specified multiple times to receive rate plan description for multiple hotels."},{"id":"1230f885-232a-47b9-8b82-d016e0d8f3bf","key":"description.leadguest.additionalFirstName","value":"This is an optional field that sets an alternative first name for the lead guest."},{"id":"c0f5dd23-92ff-42af-b7f5-24c984d9885c","key":"description.leadguest.additionalLastName","value":"This is an optional field that sets an alternative last name for the lead guest."},{"id":"ebab5ee2-4cc8-4fc9-b7c6-dedbc09b0ef6","key":"description.leadguest.eta","value":"This is an optional field that sets the estimated time of arrival of the guest.\nFormat: hh:mm 24 hour."},{"id":"fbcb313e-2ed3-421c-a411-adf6cdc54aa8","key":"description.leadguest.email","value":"This is an optional field that sets the email address of the lead guest."},{"id":"de3bb8f8-b072-40af-a206-89171ce319f0","key":"description.leadguest.contactNumber","value":"This is an optional field that sets the contact number of the lead guest."},{"id":"dd4326f0-57dc-4dbd-a95b-39f969e76b2c","key":"description.leadguest.address","value":"This is an optional object that contains the address details of the lead guest."},{"id":"c61f8f82-46b7-46cc-a392-e5502a5b7c10","key":"description.leadguest.dateOfBirth","value":"This is an optional parameter which sets the date of birth of the guest. This has to be in the format yyyy-MM-dd."},{"id":"c1dff3f7-2300-4605-bf3c-72852564e760","key":"description.leadguest.nationality","value":"This is an optional parameter which sets the nationality of the guest. Accepted values are any ISO-3166-1 Alpha 2 notations (ex. JP, etc.)"},{"id":"46cfb240-bb01-4526-b04c-e5d6b716c9f9","key":"description.leadguest.idDetails","value":"An optional object that contains the identification details of the lead guest."},{"id":"493b05e5-7622-424b-9acc-1588d615a26a","key":"description.leadguest.specialRequests","value":"An optional field that contains the specialRequests of the lead guest."},{"id":"7c047187-2ce8-47b8-9532-fb355b62075f","key":"description.leadguest.notes","value":"An optional field that contains additional comments or notes from the system for the lead guest."},{"id":"f822b5fc-1113-4565-b6f5-b9bd02390a3e","key":"description.leadguest.creditCardDetails","value":"An optional object that contains the credit card token details of the lead guest. "},{"id":"d0f010e6-b789-4591-a61c-ea87e95648c6","key":"description.request.online-registration.pre_registered","value":"This is a required boolean field that indicates whether the booking should be marked as pre-registered or not."},{"id":"2e8a6e14-2338-4e99-b661-875f2a76f607","key":"description.response.list.hotels","value":"List of hotels and their details."},{"id":"69976a47-c577-4d99-a252-dd75e9bb365c","key":"description.response.list.hotels.hotelId","value":"The ID of the hotel."},{"id":"775560ca-8dd2-4af9-96c2-660a90a35e6f","key":"description.response.list.hotels.hotelName","value":"The name of the hotel."},{"id":"6f7b90e7-6ad0-460a-8808-bbc3254c322e","key":"description.response.list.hotels.countryCode","value":"The country code of the hotel."},{"id":"6a681ce7-7bdd-40c3-a08d-135c3b9c1e42","key":"description.response.list.hotels.locationCode","value":"The location code of the hotel."},{"id":"ae2857aa-3d84-4808-af1a-3ecff2ba1508","key":"description.response.list.hotels.latitude","value":"The latitude coordinate of the hotel. Used in conjunction with the \"longitude\" value to indicate the location on a map."},{"id":"8621aeb1-9632-4884-9b63-6b6fa0a7aa42","key":"description.response.list.hotels.longitude","value":"The longitude coordinate of the hotel. Used in conjunction with the \"latitude\" value to indicate the location on a map."},{"id":"64727985-eee7-464e-aa4b-850cdc788c75","key":"description.response.list.hotels.currencyCode","value":"The currency used by the hotel. Format: ISO 4217 currency code, e.g. \"JPY\"."},{"id":"b33dbfac-697a-411f-be23-9fd6592c7123","key":"description.response.list.hotels.url","value":"Hotel URL. The website or landing page of the hotel."},{"id":"ac1e90dc-db38-4694-9d3b-b7408c369ea8","key":"description.response.list.hotels.internalInventory","value":"Determines whether the inventory of a hotel is maintained in RoomBoss or retrieved from a 3rd-party API."},{"id":"e44fff91-513b-4c49-82f5-a0382934527c","key":"description.response.list.hotels.recordGuestType","value":"Indicates whether the numberAdults, numberChildren, and numberInfants should be explicitly defined in the createBooking request."},{"id":"7b4d6c46-5601-4762-9c30-073ca1d32b0e","key":"description.response.list.hotels.maxAgeChildren","value":"Specifies the maximum age at which a person is considered a child. Anyone older than this age is classified as an adult."},{"id":"f8428eab-063a-451a-82ae-0cb0290be916","key":"description.response.list.hotels.maxAgeInfants","value":"Specifies the maximum age at which a person is classified as an infant."},{"id":"7a18cd68-6f74-455a-aeb3-a9d66ea5a1b6","key":"rates.intro.title","value":"OTA Rates & Availability API"},{"id":"1b397a85-b0ac-4b29-86d6-f49e26bff0a8","key":"rates.intro.description","value":"Rates & Availability API is an interface that allows RoomBoss to push rates, restrictions & availability data directly to your system."},{"id":"edcc8b28-b4a8-4e62-b82c-831ada280897","key":"rates.intro.head.1","value":"Message Types"},{"id":"9dfbbf4c-fc5e-4461-92c2-6d43b4270f1f","key":"rates.intro.head.2","value":"Implementation Requirements"},{"id":"f5e94097-9f9f-47a0-950b-de9f342deace","key":"rates.intro.head.3","value":"Scope"},{"id":"6a93d5dc-ad1c-4d71-ab52-5db679f67fbc","key":"rates.intro.head.4","value":"Connection"},{"id":"b276b939-6f91-4d0b-9779-64b1e2247668","key":"rates.intro.head.5","value":"Authentication"},{"id":"a6359bd1-0f8f-4b19-916f-1aa0e7be137e","key":"rates.intro.head.6","value":"Push Frequency"},{"id":"8f22cee0-c2fe-483f-95d4-792a479f1cba","key":"rates.intro.head.7","value":"API Errors"},{"id":"b20984ac-e6a5-48f1-9a72-1191f2878456","key":"rates.intro.footer","value":"Private and Confidential. © RoomBoss Co. Ltd. 2025, All Rights Reserved."},{"id":"df9339be-1de2-4cb1-982b-f592ba1abccb","key":"rates.system.push","value":"RoomBoss sends the following OTA messages to keep your system up to date:"},{"id":"a13a431c-52a5-4edd-99d1-290596d90bfc","key":"rates.system.push.1","value":"Used to send rate updates at the room type/rate plan level."},{"id":"191c847c-3ebc-41f9-a022-67a9ee117b95","key":"rates.system.push.2","value":"Used to send:"},{"id":"01b3b629-2e43-4de8-b1c6-2458d921c561","key":"rates.system.push.2.1","value":"Restrictions at the room type/rate plan level."},{"id":"28d72df3-4e59-4b80-8183-73597b93ec44","key":"rates.system.push.2.2","value":"Availability at the room type level."},{"id":"98aab5fc-0841-484c-bb68-66cc15213d51","key":"rates.intro.scope","value":"This API is intended for holders of a ROOMBOSS account. This document should be used as guide for implementing APIs that would be consumed by RoomBoss to push rates, restrictions and availability."},{"id":"239b9f53-2ab1-4ce8-848c-e46f68346b3e","key":"rates.intro.req.1","value":"This API works in conjunction with the Hotel API, which your system uses to manage bookings and retrieve hotel details such as room types and rate plans."},{"id":"d8c9ab44-14ae-457e-869f-a22612f81a35","key":"rates.intro.req.2","value":"To start receiving updates, please implement listed APIs and share your API URL along with API credentials."},{"id":"ff6a2bd7-a98f-498d-9d00-d376fd89c832","key":"rates.intro.connection","value":"All calls are to be made via secure HTTP (HTTPS)."},{"id":"4aedb037-5efc-49a7-a822-a2cd45cc8978","key":"rates.intro.authentication","value":"API requests should be authorized using Basic Authentication. Please share your API username and password to start receiving updates."},{"id":"e6eaee2c-bd6c-44c2-9315-3894f55e44d1","key":"rates.push","value":"RoomBoss has two types of data pushes:"},{"id":"07114a96-4fc5-45e7-8c9c-7e536032ad72","key":"rates.push.type.1","value":"Delta Push – Incremental updates triggered by changes in rates, restrictions and availability inside RoomBoss."},{"id":"0ec482c2-cad1-46fe-a9b1-3a419aeacbc2","key":"rates.push.type.2","value":"Full Sync – A full data push for next 1 year, which occurs daily at 7 AM JST (Only availability)."},{"id":"a9c78d0f-4421-478a-bbd1-d1e39ce98ff3","key":"rates.api.error.400","value":"Bad Request – Request processing failure because of validation checks in your system."},{"id":"4b751734-27ee-4f98-823d-305d5ef6244e","key":"rates.api.error.400.status","value":"Response Status code: 400"},{"id":"41e41dae-604a-47e4-9a11-776853ce0e0d","key":"rates.api.error.400.body","value":"Response Body: Please check error case for each request."},{"id":"2db53fe8-3227-403d-8e14-1f7a058114d3","key":"rates.api.error.401","value":"Unauthorized – Authentication failed due to incorrect credentials."},{"id":"e7351c8c-6a7a-4dec-8edc-6ec12e3c7907","key":"rates.api.error.401.status","value":"Response Status code: 401"},{"id":"70f5475e-8277-4b6f-991c-dbad49d0dd44","key":"rates.api.error.401.body","value":"Response Body: Free text"},{"id":"6de1464c-86ce-4866-8982-0242243db2b8","key":"rates.rates.description","value":"This API is used by RoomBoss to push rates to your system.\n\nRoomBoss supports occupancy-based pricing, rates are sent for each applicable room type/ rate plan/ stay date combination.\n\nPlease note that BaseByGuestAmt/@NumberOfGuests will always start from 1, and iterate through each occupancy until it reaches the maximum occupancy per room set by property users in RoomBoss\n"},{"id":"8c9f649f-2f83-4039-a67d-cf10e30f970c","key":"rates.field","value":"Field"},{"id":"45b942ec-4518-4ca5-a83a-298f55359c2e","key":"rates.type","value":"Type"},{"id":"29029a15-b336-4d19-8f3a-2be593a84af8","key":"rates.information","value":"Information"},{"id":"30726363-0b6d-417d-8ee6-f48dc9dc1c98","key":"rates.hotel.identifier","value":"RoomBoss hotel identifier."},{"id":"eb9a1017-6eba-4e89-bdbf-7eb61bb95bf0","key":"rates.roomtype.identifier","value":"RoomBoss roomtype identifier."},{"id":"12fb7d1c-bb51-4529-be3a-87ad9180c816","key":"rates.rateplan.identifier","value":"RoomBoss rate plan identifier."},{"id":"513d2b10-616b-4df2-b5f0-82cc8ad7d86f","key":"rates.amount.message","value":"Holds rate details for a specific date range, room/rate combination."},{"id":"dc606320-482a-47d1-bb35-84325aac11c4","key":"rates.sac","value":"Defines applicable date range, room type and rate plan."},{"id":"f4a0b6ac-bc88-4f08-b0c0-23a66b969bac","key":"rates.start.date","value":"Start date for the update."},{"id":"c9fa6059-0964-4394-bfe9-21e34d82a168","key":"rates.end.date","value":"End date for the update(Inclusive)."},{"id":"a2c4685e-cd2d-40a6-82cc-9e912ab20341","key":"rates.rates","value":"Holds one or more rate elements."},{"id":"ae2c2a75-adbf-42ce-8f6b-0f8ecb3ed611","key":"rates.rates.rate","value":"Defines pricing details."},{"id":"eb722a73-ec84-4af1-b5c6-fc399d2ea240","key":"rates.rate.guest.amts","value":"Holds rates per guest count."},{"id":"ead2b57d-9a33-4c7a-ac7a-4d5fa9ebb03e","key":"rates.rate.guest.amt","value":"Rate for a specific number of guests."},{"id":"b15d4d21-c12d-4e5b-b4c9-6dbeda289d3a","key":"rates.guest.age.category","value":"Guest age category (always 10)."},{"id":"02eeed5d-36a5-4698-b7a2-b2eb5a4446c4","key":"rates.rates.guest.amt.after.taxes","value":"Rate amount after taxes."},{"id":"6757de22-80cc-4d2c-94dd-f61a967c15a3","key":"rates.rates.guest.amt.count","value":"Number of guests the rate applies to."},{"id":"f4aa09e3-03f0-43d7-a2c4-4bed13099ce1","key":"rates.restriction.description","value":"This API is used by RoomBoss to push restrictions to your system."},{"id":"5a9d58d4-59b9-4506-949d-92e801998e66","key":"rates.restriction.status","value":"Availability status (Open/Close)."},{"id":"5b48f8b0-e47e-4a43-bc3d-c0a737a80545","key":"rates.restriction.type","value":"Type of restriction (Arrival/Departure/Empty)."},{"id":"24637a02-3504-4c77-99b9-5b11b2b5631b","key":"rates.restriction.min.adv","value":"Minimum number of night before the checkin date guests will be allowed to make a booking"},{"id":"f761dfe4-1599-4ed3-91f1-c3985a3af11d","key":"rates.restriction.max.adv","value":"Maxmimum number of night before the checkin date guests will be allowed to make a booking."},{"id":"f570efa5-4a10-4cf6-9264-01661c989b3f","key":"rates.restriction.los.time","value":"Number of nights for length-of-stay restriction."},{"id":"fe8f2836-a698-451e-b791-3ec90c412149","key":"rates.restriction.los.type","value":"Specifies whether it is a minimum or maximum length of stay (SetMinLOS/SetMaxLOS)."},{"id":"525e9d6b-c92b-44d2-ab12-b0e9d4b74b64","key":"rates.availability.description","value":"This API is used by RoomBoss to push availability to your system."},{"id":"ed6c0274-6ad3-478d-9e4a-ee5a1d8c361f","key":"rates.availability.message","value":"Represents an availability status message."},{"id":"79e07161-92f8-460c-b9c6-8031bdf3d510","key":"rates.availability.sac","value":"Contains room type and date range details."},{"id":"46d6d15d-2d87-4d26-834d-c3cad9914e24","key":"rates.availability.booking.limit","value":"Number of rooms available to book."},{"id":"97cf0e21-1e58-406d-87d8-8c6e594ec906","key":"description.response.list.hotels.roomTypes.id","value":"The ID of the room type."},{"id":"2bdadd25-3b6b-4f19-9f27-df441a8a1470","key":"description.response.list.hotels.roomTypes.name","value":"The name of the room type."},{"id":"fe746082-84bd-4074-b2c1-a53f0b5b8249","key":"description.response.list.hotels.roomTypes.maxNumberGuests","value":"Specifies the maximum number of guests (including adults, children, and infants) that a particular room type can accommodate."},{"id":"54b236db-e97e-44ec-a779-d6f471db7a9e","key":"description.response.list.hotels.roomTypes.numberBedrooms","value":"Indicates the total number of bedrooms in the specified room type."},{"id":"bed8c11b-d77b-43ad-aa63-1034d374f312","key":"description.response.list.hotels.roomTypes.numberBathrooms","value":"Indicates the total number of bathrooms availabie within the specified room type."},{"id":"43e1968b-15d6-4435-b035-adf04bf44ad0","key":"description.response.list.hotels.roomTypes.maxNumberAdults","value":"Defines the maximum number of adults that the specified room type can accommodate."},{"id":"4f27d8c8-823e-4109-82d0-dff46a2b29a5","key":"description.response.list.hotels.roomTypes.maxNumberChildren","value":"Defines the maximum number of children that the specified room type can accommodate."},{"id":"41db09ce-5e7a-4941-a57a-cc6d38abead1","key":"description.response.list.hotels.roomTypes.maxNumberInfants","value":"Defines the maximum number of infants that the specified room type can accommodate."},{"id":"ef380b72-dca1-4fb7-a871-13f932b97770","key":"description.response.list.hotels.roomTypes","value":"List of room types within a hotel and their details."},{"id":"bf45928c-5580-44db-acb1-2c1b0a4dad85","key":"description.response.listImages.hotels","value":"List of hotels with their images."},{"id":"a86b1569-f89c-4491-bdc1-8210a0ad845a","key":"description.response.listImages.hotels.hotelImages","value":"A map where each key is a simple label (e.g., hero01, main01, main02, etc.), and the value is the URL link to an image of the hotel."},{"id":"08cc8dd3-05d5-4a07-8402-02eb81588019","key":"description.response.listImages.roomTypes","value":"List of room types within a hotel and their images."},{"id":"c1ba8e08-bf50-4b8c-84eb-83507ee3f34f","key":"description.response.listImages.roomTypes.roomTypeImages","value":"A map where each key is a simple label (e.g., hero01, main01, main02, etc.), and the value is the URL link to an image of the room type."},{"id":"0bee7677-02dd-40c0-8d0a-ac43e396d36d","key":"description.response.listText.hotels.hotelName","value":"The name of the hotel. This is provided in only one language. Therefore, changing the language parameter will not affect the hotel name."},{"id":"f04b9765-e0ab-4adf-9653-92ae8e1d04fb","key":"description.response.listText.hotels.hotelDescription","value":"Hotel description. Text providing a brief overview or introduction. *"},{"id":"fa8dcf1f-5312-4efd-9520-484b1e2bd322","key":"description.response.listText.roomTypes","value":"List of room types within a hotel and their localized name and description."},{"id":"931fce7a-e115-4b62-ad91-e880d9c9389b","key":"description.response.listText.roomTypes.roomTypeName","value":"Room type name. *"},{"id":"8635a529-6f7b-4bf7-b1f4-4006c77cb105","key":"description.response.listText.roomTypes.roomTypeDescription","value":"Room type description. Text providing a brief overview or introduction. *"},{"id":"a4cb924d-d1ef-4419-bf8d-c06b0ce7d58d","key":"page.listHotel.text.countryLocationCodes","value":"When listing hotels, query by area location to include results from all sublocations associated with it. To limit hotels to a specific zone, instead query by sublocation."},{"id":"5cbcaa2a-e453-4f88-b855-959c988096bd","key":"description.response.booking.hotel","value":"Details of the hotel associated with the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead."},{"id":"87a674f8-bd17-4022-b084-ca79a2df7b08","key":"description.response.booking.roomType","value":"Details of the room type associated with the booking."},{"id":"10e26c7b-850d-4132-918e-bf439c4a6ed9","key":"description.booking.lastModifiedByUser","value":"The name of the user who made the most recent modification to the booking."},{"id":"2c7790df-e422-40e3-b40a-682c8323efdd","key":"description.booking.createdByUser","value":"The name of the user who created the booking."},{"id":"3f7c896d-3147-4980-bd93-800476b5e5bc","key":"description.items.checkIn","value":"The check-in date for the booking item."},{"id":"ac632783-8d61-4a72-9209-f09ee438895a","key":"description.items.checkOut","value":"The check-out date for the booking item."},{"id":"3e57e0e1-040d-480a-9208-f5f9b6ae4ac9","key":"description.items.numberGuests","value":"The number of guests of a room in a booking."},{"id":"3511e2c0-06cf-44d2-b23e-7f009d2f3c98","key":"description.items.priceRetail","value":"The gross price of the room type."},{"id":"15f3be13-b514-42e5-b80a-dccee12928eb","key":"description.conditional","value":"Conditional:"},{"id":"96fe74ad-32b9-401f-878f-b13b3825f397","key":"description.request.createPayment.invoiceId","value":"Specify the alphanumeric ID of the invoice that is being paid."},{"id":"47ceebb6-6c57-4cb3-ba24-f9a5a445287f","key":"description.response.booking.serviceProvider","value":"Details of the vendor providing the booking. If the booking type is for accommodation, the hotel details are shown. For non-accommodation bookings, the serviceProvider details are displayed instead."},{"id":"828c5d12-4827-474d-933d-8cdd969603c9","key":"description.ratePlanDescriptionList","value":"List of the hotel's rate plans with their localized descriptions."},{"id":"9d0cca97-4f12-4fd8-b5e6-bece24423410","key":"description.ratePlanDescriptionList.ratePlanId","value":"The ID of the rate plan."},{"id":"bc0a6e0d-b538-46c9-b894-bbf0232d7151","key":"description.ratePlanDescriptionList.names","value":"A mapping of locale codes to their corresponding localized rate plan names."},{"id":"0f2d5e5e-5313-4555-ac7e-09519b9786df","key":"description.ratePlanDescriptionList.description","value":"A mapping of locale codes to their corresponding localized rate plan descriptions."},{"id":"a9261dbb-245a-4304-9854-59c7b7d58ca8","key":"description.ratePlanDescriptionList.longDescription","value":"A mapping of locale codes to their corresponding localized rate plan long descriptions."},{"id":"f03ffaf4-85d8-46f8-a897-302499a67150","key":"description.error.createBooking.invalidHotelId","value":"The request is missing a valid hotelId. A valid hotel identifier must be provided."},{"id":"e9fcdb0d-f887-4280-a99b-6c163da87b13","key":"description.error.createBooking.missingRoomType","value":"The booking request must include at least one roomType."},{"id":"42f03fff-548a-4920-88f3-b82eee39b33a","key":"description.error.createBooking.invalidRoomTypes","value":"All selected roomTypes must be from the same hotel to proceed with the booking."},{"id":"80941fc3-0603-4bbc-a05a-122e197872bd","key":"description.error.createBooking.invalidRequestInternalBooking","value":"For vendor or portal bookings, REQUEST_INTERNAL booking extent is not allowed."},{"id":"1530da10-59c8-4634-a680-1941d62aa93c","key":"description.error.createBooking.invalidReservationBooking","value":"Portal bookings do not support the RESERVATION extent type for this hotel."},{"id":"aa27ccdd-6924-41e1-bbdf-61692582aeeb","key":"description.error.createBooking.invalidBookingExtent","value":"The provided bookingExtent value is invalid. It must be one of: REQUEST, REQUEST_INTERNAL, or RESERVATION."},{"id":"f46ea304-9bc3-4791-a3ea-8428ea0fea1b","key":"description.error.createBooking.inactiveRoomType","value":"At least one of the chosen roomTypes is inactive and cannot be booked."},{"id":"6b61b57d-6b17-4ebc-bd5a-8d33600e3961","key":"description.error.createBooking.agentNoPermission","value":"The agent does not have the required permissions to book one or more of the selected roomTypes."},{"id":"aabe5751-20ce-44f5-b5aa-d0b9e7f84eeb","key":"description.error.createBooking.invalidCheckinDateSize","value":"The number of checkInDates should align with the number of roomTypes in the request."},{"id":"13247fb5-2610-4666-8c72-94e23beedf55","key":"description.error.createBooking.invalidCheckoutDateSize","value":"The number of checkOutDatesshould align with the number of roomTypes."},{"id":"92b7b9ba-079d-4e6d-94d1-05840ff476a8","key":"description.error.createBooking.invalidNumberOfGuestsSize","value":"The total guest count (numberGuests) should align with the number of roomTypes in the booking."},{"id":"a261105a-0311-4e7c-98f1-1d3038d6b4b3","key":"description.error.createBooking.invalidPriceRetalMaxSize","value":"The number of priceRetailMax values should align with the number of roomTypes."},{"id":"9cd5a33a-6417-47da-8393-f7a87ac9a397","key":"description.error.createBooking.missingGuestFirstName","value":"The booking request must include guestGivenName."},{"id":"3ba192db-84e0-4364-b01e-1fbba8b7556a","key":"description.error.createBooking.missingGuestLastName","value":"The booking request must include guestFamilyName."},{"id":"4d231490-fc31-41c2-b4f8-e654ce541dae","key":"description.error.createBooking.invalidCheckInDate","value":"The checkInDate must be set at least X days in advance."},{"id":"769fec44-bac8-479a-87a2-4a219e598b36","key":"description.error.createBooking.invalidCheckInDateFormat","value":"A checkInDate is incorrectly formatted. It should follow the yyyyMMdd format."},{"id":"c0294f10-2e64-4343-9d89-731393e6fb63","key":"description.error.createBooking.invalidCheckoutDateFormat","value":"A checkOutDate is incorrectly formatted. It should follow the yyyyMMdd format."},{"id":"155c2096-595d-409e-9713-072d2370bf47","key":"description.error.createBooking.invalidBookingDuration","value":"The stay duration cannot exceed 180 nights."},{"id":"1cfb8c02-313e-4660-a9d6-b28c555f2dac","key":"description.error.createBooking.missingNumberOfAdults","value":"If hotel.recordGuestType is enabled, the request must specify numberAdults for each roomType."},{"id":"254e946b-1be1-472d-914b-10f04ad8aab5","key":"description.error.createBooking.missingNumberOfChildren","value":"If hotel.recordGuestType is enabled, the request must specify numberChildren for each roomType."},{"id":"2d5c337b-9c9b-40a2-89cf-7c54ec0013d1","key":"description.error.createBooking.missingNumberOfInfants","value":"If hotel.recordGuestType is enabled, the request must specify numberInfants for each roomType."},{"id":"fdfbcfa1-c146-421f-a5be-cef51637d51d","key":"description.error.createBooking.maxNumberOfGuestsExceeded","value":"The total numberGuests exceeds the maximum allowed capacity (maxNumberGuests) for the roomType."},{"id":"7d47e30c-059b-4e3b-a193-5fd4c54b621d","key":"description.error.createBooking.numberOfGuestsMismatch","value":"If hotel.recordGuestType is enabled, the sum of numberAdults and numberChildren must equal numberGuests."},{"id":"6634ff92-8a06-4768-a833-b4639b4e4ff5","key":"description.error.createBooking.invalidGuestGender","value":"The provided guest gender value is invalid and must be MALE, FEMALE, or OTHER."},{"id":"cbccc4cd-5e2d-478a-b0d6-bb92985746b2","key":"description.error.createBooking.invalidGuestNationality","value":"The guest nationality (country) value must follow the ISO 3166 country code format."},{"id":"9a684920-09c2-42c3-b5f4-96ccdad4189c","key":"description.error.createBooking.invalidGuestDateOfBirthFormat","value":"The guest date of birth (dob) must be in the yyyyMMdd format."},{"id":"350829ed-799c-41bc-b07f-040b9a61fcf2","key":"misc.errorMessage","value":"Error Message"},{"id":"239b706a-340d-4faf-8b6b-37a67f807f82","key":"description.response.listAvailable.availableHotels","value":"List of available hotels and their details."},{"id":"df9a7f96-6a95-497b-8b99-8ab49b6dd3a6","key":"misc.hotelRoomTypes","value":"Hotel Room Types"},{"id":"67629840-c71a-4dfb-97f1-5d60759046a8","key":"misc.hotelAvailableRoomTypes","value":"Hotel Available Room Types"},{"id":"13963525-c410-4cb7-bfd0-718eee646153","key":"description.response.listAvailable.availableRoomTypes.quantityAvailable","value":"The number of available units for a particular roomType that can be booked."},{"id":"6d0c1f9b-b726-4630-bf11-c8059f515049","key":"description.availableRoomTypes.priceNumberGuests","value":"Indicates the number of guests that the specified price applies to for a given room type."},{"id":"6043af72-4691-49c9-a020-bacb9ad50de3","key":"description.availableRoomTypes.ratePlan","value":"Returned when the rate parameter is used in a request. Includes details of the available rate plan for the room type"},{"id":"450d1b56-3e9c-4053-be09-0e5ada9dd757","key":"description.availableRoomTypes.rateplanId","value":"The ID of the rate plan."},{"id":"de0469c2-8f1f-473a-81ed-3a061b623e27","key":"description.availableRoomTypes.rateplan.mealsIncluded","value":"Indicates whether meals are included as part of the rate plan."},{"id":"5edd9b29-4844-4d7e-9449-9f4d53c2a977","key":"description.availableRoomTypes.rateplan.breakfast","value":"Indicates whether breakfast is included as part of the rate plan."},{"id":"438b1376-9a54-4648-bc82-9877247d76e2","key":"description.availableRoomTypes.rateplan.lunch","value":"Indicates whether lunch is included as part of the rate plan."},{"id":"2edcec9d-d0b1-4c6b-8c4a-c3801253cddb","key":"description.availableRoomTypes.rateplan.dinner","value":"Indicates whether dinner is included as part of the rate plan."},{"id":"54750577-7f99-4803-9d03-9006f72e7058","key":"description.availableRoomTypes.rateplan.currencyCode","value":"The currency code corresponding to the retail price of the rate plan."},{"id":"65ab4cf5-3845-45b1-b47b-7236ced7faf1","key":"description.request.listAvailable.vs","value":"When a valid vendor set code is provided, only hotels belonging to the specified vendor set will be returned."},{"id":"1b87a1c7-8a62-4452-b3b1-9afda1b573d3","key":"description.request.listAvailable.altCurrencyCode","value":"Specify an alternative currency in which the prices should be returned."},{"id":"87f0d255-0209-4c0b-8665-311a4891894e","key":"description.request.listAvailable.all","value":"Determines whether the request should return all valid hotels. If no specific hotel IDs are provided, this field must be set to true."},{"id":"e439eeda-31b2-45f5-9663-5ae9a4d0a971","key":"description.availableRoomTypes.rateplan.altCurrencyCode","value":"Represents the alternative currency code used for the altPriceRetail value. If the request included an altCurrencyString, the prices will be returned in both the default currency and this alternative currency."},{"id":"3b5bd30a-15c4-4952-8759-fce462c9086d","key":"description.availableRoomTypes.rateplan.altPriceRetail","value":"Represents the converted retail price in the alternative currency specified by altCurrencyString. If an altCurrencyCode was provided in the request, this field returns the equivalent of priceRetail in that currency."},{"id":"f3fb53e9-2eec-4b03-b2a4-858f1d211b72","key":"description.response.booking.segment","value":"The segment of the booking (e.g. agent, OTA, etc.), as determined by the system."},{"id":"2800ea84-4134-4812-ab65-d0788b9dfe12","key":"description.response.booking.packageId","value":"Identifier of the package this booking belongs to (ID of the lead booking)."},{"id":"707dc642-e059-40db-b6be-8fb95b574453","key":"description.leadGuest.additionalEmail","value":"Secondary email address for the lead guest on this booking."},{"id":"912bae73-8f5e-40b7-a92e-0ae2508494af","key":"description.items.arrivalTime","value":"Scheduled arrival time for the booking item (HH:mm)."},{"id":"875240f1-f71d-401e-9ce9-e3f65e207462","key":"description.items.departureTime","value":"Scheduled departure time for the booking item (HH:mm)."},{"id":"bd5c8d5d-b723-4c7a-b4c8-c3940ef046f5","key":"description.items.priceSell","value":"The sell price applied to non-managed/bought products for this item after commission and adjustments."},{"id":"ecee0634-6aa1-4fc1-ac16-76e6a375ef72","key":"description.booking.discountCode","value":"The promo code applied to this booking."},{"id":"8740943e-a091-4671-8ebe-eb8793e7b50a","key":"description.items.endDate","value":"The end date of the booking item as a Unix timestamp in milliseconds."},{"id":"2d617c88-bf69-44e6-a338-c57d1ab99862","key":"description.items.parentCategory","value":"Parent classification for the item."},{"id":"e250f9c5-4651-4703-bd16-f132c2ae4836","key":"description.items.category","value":"Specific item category."},{"id":"53944747-d4a5-43f2-bbfe-5c0da7b4ec78","key":"description.items.itemId","value":"Internal identifier of the booking item."},{"id":"b9dc5d03-be8a-4196-bc64-0d2236a252d6","key":"description.items.roomNumber","value":"Assigned room number for this item, if applicable."},{"id":"82e902d6-e16f-478b-9ec3-ccdb0b391bc3","key":"description.items.resourceId","value":"Linked resource ID (e.g., the specific room/inventory resource)."},{"id":"157eb7a9-9bf2-4ec7-93cb-db4abfa6da16","key":"description.items.checkedIn","value":"Indicates whether the guest has checked in."},{"id":"fe93e5e1-2ad9-4be6-8ff1-f4ab91e70b8f","key":"description.items.checkedOut","value":"Indicates whether the guest has checked out."},{"id":"e4cb6bd2-e3f1-4ff1-acf6-779a97214890","key":"description.items.roomNote","value":"Free-text notes related to the room for this item."},{"id":"7d4948da-d7d8-445e-b447-c9f9a4615706","key":"description.items.ratePlan","value":"Rate plan name associated with this item."},{"id":"3a2a8323-fd34-48a9-bff3-a6c612aeafcf","key":"description.items.productOptions","value":"Array of option selections for this item."},{"id":"35094c71-20e5-4f1d-80b4-ea1de5bbf571","key":"description.items.productOptions.id","value":"Internal identifier of the item option."},{"id":"c274144d-3332-42a8-8140-77158235865e","key":"description.items.productOptions.label","value":"Display name of the item option."},{"id":"1cd2d9a1-70d0-4b06-a7ac-0a7390c2895c","key":"description.items.productOptions.value","value":"Selected value for the option."},{"id":"08f2aa6f-86c2-4e50-9668-9ddd5a5bef40","key":"description.request.listBookings.vendorIds","value":"List of vendor IDs to filter bookings. Repeat this parameter for multiple values (e.g., vendorIds=1234&vendorIds=5678). Omit to return all vendors."},{"id":"45fd17e4-4f37-4a05-8c28-d534524c02ae","key":"description.request.listBookings.from","value":"Start date for booking-change search in compact format yyyyMMdd (e.g., 20250101). Used together with 'to'. If both 'from' and 'to' are set, 'date' is ignored (but still required)."},{"id":"1d76b07e-9b47-4d12-832a-2bdd5fe3bf29","key":"description.request.listBookings.to","value":"End date (inclusive) for booking-change search in compact format yyyyMMdd (e.g., 20250131). Used together with 'from'. If both 'from' and 'to' are set, 'date' is ignored (but still required)."},{"id":"371037cd-43f3-46c5-9d0a-33a1fba36c5a","key":"description.housekeeping.roomStatus","value":"Current room state: DIRTY, CLEAN, INSPECTED"},{"id":"8fe0aa24-94a0-4df4-978b-4521c4dab4b1","key":"description.booking.tasks","value":"List of housekeeping tasks"},{"id":"38bd664a-4362-41be-bde5-41c25b873d69","key":"description.booking.tasks.date","value":"Task date Format: \"YYYY-MM-DD\"."},{"id":"dd110e28-6dbf-41af-916e-46264d89ca3e","key":"description.booking.tasks.status","value":"The task status: NOT_COMPLETED, COMPLETED, WONT_COMPLETE"},{"id":"c6190ac0-7c96-498b-becf-35f25a845806","key":"description.booking.tasks.type","value":"The task type: HOUSEKEEPING_ARRIVAL, HOUSEKEEPING_DEPARTURE, HOUSEKEEPING_INSPECTION, HOUSEKEEPING_STAY1–10"},{"id":"c4ebe5b2-d0fe-4278-a06c-475d1ac81ddd","key":"description.booking.tasks.note","value":"Optional note or description"},{"id":"7ff613df-ff45-4626-878c-4322803b06ed","key":"description.housekeeping.mode","value":"The mode for updating housekeeping tasks: replace (default) or add."},{"id":"547403c9-1c30-4da6-a6f4-c56c660663c4","key":"description.booking.roomStatus","value":"The room status of a booking. Indicates whether the booking is a standard reservation or a blocked date. Possible values: STD (standard), OOS (blocked date), OOO (blocked date)"},{"id":"52a181de-19c1-4210-b4d2-b47f4b145244","key":"description.createBooking.emailSendOverride","value":"Control sending of the \"new booking created\" auto email: Null / not provided - send based on account settings; True - send (overriding account settings); False - don't send (overriding account settings)"}]}