Buyer API (Pull)
...
Occupancy Base Rates
Search by ID
1 min
{ "name" "search by id", "method" "post", "url" "https //wspull bakuun com/{version}/spsoccupancy/{partnercode}/xxxxxx", "description" "search availability and rates for one property using their property ids \nsupports multi room (occupancy based) queries and returns single property result ", "tab" "examples", "examples" { "languages" \[ { "id" "qllozck9say11bc e7lqo", "language" "json", "code" "{\n \\"username\\" \\"xxxxxxx\\",\n \\"password\\" \\"xxxxxxx\\",\n \\"partnerid\\" \\"mpbxx\\",\n \\"multisearchbyids\\" {\n \\"propertyid\\" \[\n \\"htlxx x\\"\n ]\n },\n \\"checkindate\\" \\"yyyy mm dd\\",\n \\"checkoutdate\\" \\"yyyy mm dd\\",\n \\"ratesbyoccupancy\\" {\n \\"occupancies\\" \[\n {\n \\"occupancyrefid\\" 1,\n \\"numberofadults\\" 1,\n \\"numberofchildren\\" 1,\n \\"childrenblocks\\" \[\n {\n \\"childblock\\" 1,\n \\"numberofchildren\\" 1,\n \\"childrenages\\" \\"8\\"\n }\n ]\n }\n ]\n }\n}", "customlabel" "" } ], "selectedlanguageid" "qllozck9say11bc e7lqo" }, "results" { "languages" \[ { "id" "j3bk 3qtul8wzeemnns7g", "language" "200", "code" "{\n \\"success\\" true,\n \\"tokenid\\" \\"82f3797770137851975777f0b799aace\\",\n \\"errors\\" \[]\n}", "customlabel" "" }, { "id" "umzmkdiwnlnqzifldf5 5", "language" "401", "code" "{\n \\"success\\" false,\n \\"tokenid\\" \\"020c092935b42e9dde4b37bba95d9080\\",\n \\"errors\\" \[\n {\n \\"code\\" 410,\n \\"message\\" \\"unauthorized user\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "umzmkdiwnlnqzifldf5 5" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "username", "kind" "required", "type" "string", "description" "system generated, api access secret key (unique per account) ", "" "system generated, api access secret key (unique per account) " }, { "name" "password", "kind" "required", "type" "string", "description" "system generated, api access secret key (unique per account) ", "" "system generated, api access secret key (unique per account) " }, { "name" "partnerid", "kind" "required", "type" "string", "description" "partner (buyer) identifier (e g rdkxx mpbxxx) ", "" "partner (buyer) identifier (e g rdkxx mpbxxx) " }, { "name" "singlesearchbyid", "kind" "required", "type" "object", "description" "", "" "singlesearchbyid", "children" \[ { "name" "propertyid", "kind" "optional", "type" "array", "description" "accepted format htlxxx y (example htl123 1) or htlxxxx (example htl1231)\nuser can one only id in this case ", "children" \[] } ], "schema" \[ { "name" "propertyid", "kind" "optional", "type" "array", "description" "accepted format htlxxx y (example htl123 1) or htlxxxx (example htl1231)\nuser can one only id in this case ", "children" \[] } ] }, { "name" "checkindate", "kind" "required", "type" "string", "description" "iso check in date (e g , 2025 10 05) ", "" "iso check in date (e g , 2025 10 05) " }, { "name" "checkoutdate", "kind" "required", "type" "string", "description" "iso check out date (e g , 2025 10 05) ", "" "iso check out date (e g , 2025 10 05) " }, { "name" "ratesbyoccupancy", "kind" "required", "type" "object", "description" "", "" "required", "children" \[ { "name" "occupancies", "kind" "required", "type" "object", "description" "", "children" \[ { "name" "occupancyrefid", "kind" "required", "type" "integer", "description" "progressive room number starts at 1 (room 1 → 1, room 2 → 2…)\nidentifies which room the configuration refers to \n\nif user searches 3 rooms →\noccupancyrefid 1, occupancyrefid 2, occupancyrefid 3 " }, { "name" "numberofadults", "kind" "required", "type" "integer", "description" "range 1–20" }, { "name" "numberofchildren", "kind" "required", "type" "integer", "description" "if 0, childrenblocks must not be sent\n\ntotal children per room cannot exceed 20" }, { "name" "childrenblocks", "kind" "required", "type" "object", "description" "progressive block identifier ", "children" \[ { "name" "childblock", "kind" "required", "type" "integer", "description" "returned only if numberofchildren > 0\n\neach block represents children grouped by the same age for the same occupancyrefid" }, { "name" "numberofchildren", "kind" "required", "type" "integer", "description" "number of children for this age group " }, { "name" "childrenages", "kind" "required", "type" "integer", "description" "children age range 0–17" } ] } ] } ], "schema" \[ { "name" "occupancies", "kind" "required", "type" "object", "description" "", "children" \[ { "name" "occupancyrefid", "kind" "required", "type" "integer", "description" "progressive room number starts at 1 (room 1 → 1, room 2 → 2…)\nidentifies which room the configuration refers to \n\nif user searches 3 rooms →\noccupancyrefid 1, occupancyrefid 2, occupancyrefid 3 " }, { "name" "numberofadults", "kind" "required", "type" "integer", "description" "range 1–20" }, { "name" "numberofchildren", "kind" "required", "type" "integer", "description" "if 0, childrenblocks must not be sent\n\ntotal children per room cannot exceed 20" }, { "name" "childrenblocks", "kind" "required", "type" "object", "description" "progressive block identifier ", "children" \[ { "name" "childblock", "kind" "required", "type" "integer", "description" "returned only if numberofchildren > 0\n\neach block represents children grouped by the same age for the same occupancyrefid" }, { "name" "numberofchildren", "kind" "required", "type" "integer", "description" "number of children for this age group " }, { "name" "childrenages", "kind" "required", "type" "integer", "description" "children age range 0–17" } ] } ] } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "success", "kind" "optional", "type" "boolean", "description" "" }, { "name" "tokenid", "kind" "optional", "type" "string", "description" "", "children" \[] }, { "name" "errors", "kind" "optional", "type" "array", "description" "", "children" \[] } ], "autogeneratedanchorslug" "search by id", "legacyhash" "7fndleipgkhgztcdads2q" }

