--- title: Read Property slug: read-property docTags: createdAt: 2025-09-11T10:47:14.175Z --- :::ApiMethodV2 ```json { "name": "Read Property", "method": "POST", "url": "https://wsb.bakuun.com/v2/api/read-property-info", "description": "Returns detailed information about the property associated with the given propertyId. This action allows Bakuun to retrieve the static room and rate plan configuration as defined in the TPS's system.", "tab": "examples", "examples": { "languages": [ { "id": "rJxEFDXZtK-ii0Nh24633", "language": "json", "code": "{\n \"authentication\": {\n \"username\": \"xxxxxxxxxxxx\",\n \"password\": \"xxxxxxxxxxxx\",\n \"propertyId\": \"HTLXX.X\",\n \"sourceId\": \"TPSXXX\"\n },\n \"action\": \"readPropertyInfo\"\n}", "customLabel": "" } ], "selectedLanguageId": "rJxEFDXZtK-ii0Nh24633" }, "results": { "languages": [ { "id": "CUwUQnM2-ToHwU-bXfbdm", "language": "200", "code": "{\n \"status\": \"success\",\n \"trackingId\": \"689b2156a77bdcd61a0a0ba0\",\n \"propertyData\": {\n \"propertyName\": \"My Test Property\",\n \"country\": \"Test\",\n \"region\": \"Test\",\n \"city\": \"Test\",\n \"area\": \"Test\",\n \"zipCode\": \"411014\",\n \"address\": \"Viman nagar\",\n \"latitude\": \"18.565002\",\n \"longitude\": \"73.920876\",\n \"prefixPhone\": \"+91\",\n \"phoneNum\": \"123456987\",\n \"currency\": \"INR\",\n \"roomTypes\": [\n {\n \"roomId\": \"RXX.X\",\n \"roomName\": \"Double Room with Shared Toilet\",\n \"type\": \"DailyRoom\",\n \"rateTypes\": [\n {\n \"rateId\": \"RXX.X.X\",\n \"authPerson\": \"3\",\n \"cancelType\": \"1\",\n \"defaultMeal\": \"RO\",\n \"rateCategory\": \"B2B\",\n \"restrictedCountry\": \"AF,AL,DZ,AS\"\n },\n {\n \"ratePlanId\": \"RXX.X.X\",\n \"authPerson\": \"2\",\n \"cancelType\": \"1\",\n \"defaultMeal\": \"HB\",\n \"rateCategory\": \"B2C\",\n \"restrictedCountry\": \"AF,AL,DZ,AS\"\n }\n ]\n },\n ]\n }\n}", "customLabel": "" }, { "id": "gclSFeG7TcL3xcGR1oOZh", "language": "415", "code": "{\n \"success\": false,\n \"trackingId\": \"689b2156a77bdcd61a0a0ba0\",\n \"errors\": [\n {\n \"code\": 415,\n \"message\": \"Invalid authentication key.\"\n }\n ]\n}", "customLabel": "" }, { "id": "vVHipUgMYGg65zy_yKtQY", "language": "422", "code": "{\n \"success\": false,\n \"trackingId\": \"68c2abfc04829387650a4dbd\",\n \"errors\": [\n {\n \"code\": 422,\n \"message\": \"Validation failed\"\n }\n ]\n}", "customLabel": "" }, { "id": "WQk_iSE_mL6p69i9hYUJs", "language": "431", "code": "{\n \"success\": false,\n \"trackingId\": \"68c2abfc04829387650a4dbd\",\n \"errors\": [\n {\n \"code\": 431,\n \"message\": \"Endpoint is not active\"\n }\n ]\n}", "customLabel": "" }, { "id": "Em0_O6MUFotrdSgFlmKS_", "language": "451", "code": "{\n \"success\": false,\n \"trackingId\": \"68c2abfc04829387650a4dbd\",\n \"errors\": [\n {\n \"code\": 451,\n \"message\": \"Mapping is not active\"\n }\n ]\n}", "customLabel": "" }, { "id": "CpbdwNfOXUccKPwEmFOLa", "language": "428", "code": "{\n \"success\": false,\n \"trackingId\": \"68c2abfc04829387650a4dbd\",\n \"errors\": [\n {\n \"code\": 415,\n \"message\": \"No room mappings found for this property\"\n }\n ]\n}", "customLabel": "" }, { "id": "X8oarA7dktkyutXjA77Lg", "language": "500", "code": "{\n \"success\": false,\n \"trackingId\": \"68c2abfc04829387650a4dbd\",\n \"errors\": [\n {\n \"code\": 415,\n \"message\": \"Internal server error\"\n }\n ]\n}", "customLabel": "" } ], "selectedLanguageId": "CUwUQnM2-ToHwU-bXfbdm" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "authentication", "kind": "required", "type": "object", "description": "", "": "", "children": [ { "name": "username", "kind": "required", "type": "string", "description": "API username provided by the TPS Partner to authenticate incoming requests from Bakuun." }, { "name": "password", "kind": "required", "type": "string", "description": "API password provided by the TPSPartner to authenticate incoming requests from Bakuun." }, { "name": "propertyId", "kind": "required", "type": "string", "description": "Unique property identifier (shared mapping between Bakuun and the Connectivity partner)." }, { "name": "sourceId", "kind": "required", "type": "string", "description": "TPS Partner identifier assigned by Bakuun (e.g. TPSXX)" } ], "schema": [ { "name": "username", "kind": "required", "type": "string", "description": "API username provided by the TPS Partner to authenticate incoming requests from Bakuun." }, { "name": "password", "kind": "required", "type": "string", "description": "API password provided by the TPSPartner to authenticate incoming requests from Bakuun." }, { "name": "propertyId", "kind": "required", "type": "string", "description": "Unique property identifier (shared mapping between Bakuun and the Connectivity partner)." }, { "name": "sourceId", "kind": "required", "type": "string", "description": "TPS Partner identifier assigned by Bakuun (e.g. TPSXX)" } ] }, { "name": "action", "kind": "required", "type": "string", "description": "Always set as readPropertyInfo", "": "Always set as readPropertyInfo" } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "response": [ { "name": "status", "kind": "optional", "type": "string", "description": "true", "children": [] }, { "name": "trackingId", "kind": "optional", "type": "string", "description": "", "children": [] }, { "name": "propertyData", "kind": "optional", "type": "object", "description": "Container for all static property, room, and rate plan data.", "children": [ { "name": "propertyName", "kind": "optional", "type": "string", "description": "Name of the property as shown to users." }, { "name": "roomTypes", "kind": "optional", "type": "object", "description": "", "children": [ { "name": "roomId", "kind": "optional", "type": "string", "description": "Unique identifier for the room type" }, { "name": "roomName", "kind": "optional", "type": "string", "description": "Descriptive name of the room type (e.g. Deluxe Queen Room With Two Queen Beds)." }, { "name": "type", "kind": "optional", "type": "string", "description": "DailyRoom would be the used default category " }, { "name": "rateTypes", "kind": "optional", "type": "object", "description": "", "children": [ { "name": "rateId", "kind": "optional", "type": "string", "description": "Unique identifier for the rate plan (e.g. RXX.1.2.1)." }, { "name": "authPerson", "kind": "optional", "type": "string", "description": "Maximum authorized occupancy (number of persons) for this rate plan." }, { "name": "cancelType", "kind": "optional", "type": "string", "description": "Cancellation rule type code (mapping provided by Bakuun; e.g. 0 = non-refundable, 1 = refundable)." }, { "name": "defaultMeal", "kind": "optional", "type": "string", "description": "Default meal plan code (e.g. 0 = Room Only, 1 = Breakfast, 2 = Half Board, 3 = Full Board — actual mapping defined in your integration)." }, { "name": "rateCategory", "kind": "optional", "type": "string", "description": "Assigned rate category (e.g. corporate, package, promotion)" }, { "name": "restrictedCountry", "kind": "optional", "type": "string", "description": "Optional country restrictions for selling this rate. Can be empty or contain a list of countries." } ] } ] } ] } ], "autoGeneratedAnchorSlug": "read-property", "legacyHash": "y84A3KTR0Zv2rgzfNkuWR" } ``` :::