Search Results - SPS Single Property Shopping - Occupancy Base

{ "name" "search results sps single property shopping", "method" "get", "url" "https //wspull bakuun com/{version}/{partnercode}/spsoccupancy/{token}/results", "description" "when the request payload is valid and the search is successfully initialized, the api returns a unique tokenid that must be used to retrieve the search results ", "tab" "examples", "examples" { "languages" \[ { "id" "qllozck9say11bc e7lqo", "language" "json", "code" "{\n \\"success\\" true,\n \\"tokenid\\" \\"ab9bf22f9648f63ec069ca1c3b55c9ce\\"\n}", "customlabel" "" } ], "selectedlanguageid" "qllozck9say11bc e7lqo" }, "results" { "languages" \[ { "id" "j3bk 3qtul8wzeemnns7g", "language" "200", "code" "{\n \\"success\\" true,\n \\"tokenid\\" \\"8c264eebb922f568cdf63d14a0675bf0\\",\n \\"errors\\" \[],\n \\"data\\" {\n \\"propertyid\\" \\"htl12\\",\n \\"propertyname\\" \\"dashboard area property\\",\n \\"occupancies\\" \[\n {\n \\"occupancyrefid\\" 1,\n \\"numberofadults\\" 1,\n \\"numberofchildren\\" 0,\n \\"childrenblocks\\" \[\n {\n \\"childblock\\" 1,\n \\"numberofchildren\\" 1,\n \\"childrenages\\" \\"8\\"\n }\n ],\n \\"checkindate\\" \\"2026 02 15\\",\n \\"checkoutdate\\" \\"2026 02 16\\"\n }\n ],\n \\"rooms\\" \[\n {\n \\"occupancyrefid\\" 1,\n \\"roomid\\" \\"r12 1\\",\n \\"roomnameeng\\" \\"triple room with garden view\\",\n \\"rateid\\" \\"r12 1 1\\",\n \\"includedmeals\\" \\"breakfast\\",\n \\"includedmealsdetail\\" {\n \\"amenitybreakfast\\" true,\n \\"breakfasttype\\" \\"continental, vegan\\",\n \\"breakfastconfirm\\" \\"direct\\"\n },\n \\"getextrameals\\" true,\n \\"excludedmeals\\" \\"fullboard\\",\n \\"excludedmealsdetail\\" {\n \\"amenitybreakfast\\" true,\n \\"breakfasttype\\" \\"continental, vegan\\",\n \\"breakfastconfirm\\" \\"direct\\",\n \\"breakfastchargeinfo\\" \[\n {\n \\"agefrom\\" null,\n \\"agequalifying\\" \\"adult\\",\n \\"ageto\\" null,\n \\"currencycode\\" \\"inr\\",\n \\"mealcharge\\" false,\n \\"mealrate\\" \\"0 00\\"\n },\n {\n \\"agefrom\\" 2,\n \\"agequalifying\\" \\"child\\",\n \\"ageto\\" 3,\n \\"currencycode\\" \\"inr\\",\n \\"mealcharge\\" true,\n \\"mealrate\\" \\"88888\\"\n }\n ],\n \\"amenitylunch\\" true,\n \\"lunchmenu\\" \\"buffet\\",\n \\"lunchtype\\" \\"french, seafood\\",\n \\"lunchconfirm\\" \\"on request\\",\n \\"lunchexchange\\" false,\n \\"lunchchargeinfo\\" \[\n {\n \\"agefrom\\" null,\n \\"agequalifying\\" \\"adult\\",\n \\"ageto\\" null,\n \\"currencycode\\" \\"inr\\",\n \\"mealcharge\\" false,\n \\"mealrate\\" \\"0 00\\"\n },\n {\n \\"agefrom\\" 0,\n \\"agequalifying\\" \\"child\\",\n \\"ageto\\" 1,\n \\"currencycode\\" \\"inr\\",\n \\"mealcharge\\" true,\n \\"mealrate\\" \\"999\\"\n }\n ],\n \\"amenitydinner\\" true,\n \\"dinnermenu\\" \\"buffet\\",\n \\"dinnertype\\" \\"american, french, italian, seafood\\",\n \\"dinnerconfirm\\" \\"direct\\",\n \\"dinnerexchange\\" false,\n \\"dinnerchargeinfo\\" \[\n {\n \\"agefrom\\" null,\n \\"agequalifying\\" \\"adult\\",\n \\"ageto\\" null,\n \\"currencycode\\" \\"inr\\",\n \\"mealcharge\\" false,\n \\"mealrate\\" \\"0 00\\"\n },\n {\n \\"agefrom\\" 1,\n \\"agequalifying\\" \\"child\\",\n \\"ageto\\" 2,\n \\"currencycode\\" \\"inr\\",\n \\"mealcharge\\" false,\n \\"mealrate\\" \\"0 00\\"\n }\n ]\n },\n \\"getinclusion\\" false,\n \\"inclusion\\" false,\n \\"amenityinclusion\\" \[],\n \\"getextra\\" false,\n \\"extra\\" false,\n \\"amenityextra\\" \[],\n \\"rateinfo\\" \[\n {\n \\"ratebar\\" true,\n \\"ratediscount\\" 0,\n \\"ratedetails\\" {\n \\"currencycode\\" \\"inr\\",\n \\"amountbeforetax\\" \\"50000 00\\",\n \\"amountaftertax\\" \\"50000 00\\",\n \\"dailypricebeforetax\\" \[\n \\"50000\\"\n ],\n \\"dailypriceaftertax\\" \[\n \\"50000\\"\n ],\n \\"beforetax\\" {\n \\"taxfeedetails\\" \[\n {\n \\"taxtype\\" \\"tax\\",\n \\"taxcalculator\\" \\"percentage\\",\n \\"taxmultiplicator\\" \\"stay\\",\n \\"taxapplicability\\" \\"night\\",\n \\"taxincluded\\" false,\n \\"taxdescription\\" \\"tax 50 00% not included\\",\n \\"taxcurrency\\" null,\n \\"taxvalue\\" \\"50 00\\"\n },\n {\n \\"taxtype\\" \\"fee\\",\n \\"taxmultiplicator\\" \\"per night\\",\n \\"taxapplicability\\" \\"night\\",\n \\"taxincluded\\" false,\n \\"taxcalculator\\" \\"currency\\",\n \\"taxdescription\\" \\"fee 6666 00 inr x night not included\\",\n \\"taxcurrency\\" \\"inr\\",\n \\"taxvalue\\" \\"6666 00\\"\n }\n ]\n },\n \\"aftertax\\" {\n \\"taxfeedetails\\" \[\n {\n \\"taxtype\\" \\"tax\\",\n \\"taxcalculator\\" \\"percentage\\",\n \\"taxmultiplicator\\" \\"stay\\",\n \\"taxapplicability\\" \\"night\\",\n \\"taxincluded\\" false,\n \\"taxdescription\\" \\"tax 50 00% not included\\",\n \\"taxcurrency\\" null,\n \\"taxvalue\\" \\"50 00\\"\n },\n {\n \\"taxtype\\" \\"fee\\",\n \\"taxmultiplicator\\" \\"per night\\",\n \\"taxapplicability\\" \\"night\\",\n \\"taxincluded\\" false,\n \\"taxcalculator\\" \\"currency\\",\n \\"taxdescription\\" \\"fee 6666 00 inr x night not included\\",\n \\"taxcurrency\\" \\"inr\\",\n \\"taxvalue\\" \\"6666 00\\"\n }\n ]\n }\n }\n },\n {\n \\"ratenet\\" null,\n \\"ratediscount\\" 0\n }\n ],\n \\"getdeposit\\" true,\n \\"deposit\\" {\n \\"depositpolicy\\" true,\n \\"deposittype\\" \\"percentage\\",\n \\"depositamount\\" \\"13\\",\n \\"depositapplied\\" \\"first night\\",\n \\"depositintervalunits\\" 1,\n \\"deposittimeinterval\\" \\"45\\",\n \\"depositdescription\\" \\"13% of the first night is charged 45 days prior arrival\\",\n \\"timezone\\" \\"(gmt+05 30) india standard (colombo)\\"\n },\n \\"getcancellation\\" true,\n \\"refundable\\" true,\n \\"cancellationpolicies\\" \[\n {\n \\"policylevel\\" 1,\n \\"policyid\\" 1,\n \\"dayspriorcheckin\\" 2,\n \\"penaltytype\\" \\"percentage\\",\n \\"penaltyapplied\\" \\"2 nights\\",\n \\"penaltyamount\\" \\"87\\",\n \\"policydescription\\" \\"2 days or charged 87% of the 2 nights\\",\n \\"timezone\\" \\"(gmt+05 30) india standard (colombo)\\"\n },\n {\n \\"policylevel\\" 2,\n \\"policyid\\" 1,\n \\"dayspriorcheckin\\" 0,\n \\"penaltytype\\" \\"percentage\\",\n \\"penaltyapplied\\" \\"first night\\",\n \\"penaltyamount\\" \\"100\\",\n \\"policydescription\\" \\"day of arrival 18 00 or charged 100% of the first night\\",\n \\"timezone\\" \\"(gmt+05 30) india standard (colombo)\\"\n }\n ]\n }\n ],\n \\"getadditionaltax\\" true,\n \\"payatbooking\\" true,\n \\"payatproperty\\" true,\n \\"payatbookingdata\\" \[\n {\n \\"taxtype\\" \\"tax\\",\n \\"taxapplicability\\" \\"night\\",\n \\"taxmultiplicator\\" \\"guest\\",\n \\"taxincluded\\" false,\n \\"guest\\" \[\n {\n \\"taxcalculator\\" \\"percentage\\",\n \\"taxcurrency\\" null,\n \\"agequalifying\\" \\"adult\\",\n \\"agefrom\\" null,\n \\"ageto\\" null,\n \\"taxdescription\\" \\"10% amenity fee per night excluded\\",\n \\"taxvalue\\" \\"10\\",\n \\"taxcharge\\" true\n }\n ]\n }\n ],\n \\"payatpropertydata\\" \[\n {\n \\"taxtype\\" \\"tax\\",\n \\"taxapplicability\\" \\"night\\",\n \\"taxmultiplicator\\" \\"guest\\",\n \\"taxincluded\\" false,\n \\"guest\\" \[\n {\n \\"taxcalculator\\" \\"percentage\\",\n \\"taxcurrency\\" null,\n \\"agequalifying\\" \\"adult\\",\n \\"agefrom\\" null,\n \\"ageto\\" null,\n \\"taxvalue\\" \\"10\\",\n \\"taxdescription\\" \\"10% facility fee per night excluded\\",\n \\"taxcharge\\" true\n }\n ]\n }\n ]\n }\n}", "customlabel" "" }, { "id" "umzmkdiwnlnqzifldf5 5", "language" "410", "code" "{\n \\"success\\" false,\n \\"tokenid\\" \\"020c092935b42e9dde4b37bba95d9080\\",\n \\"errors\\" \[\n {\n \\"code\\" 410,\n \\"message\\" \\"unauthorized user\\"\n }\n ]\n}", "customlabel" "" } ], "selectedlanguageid" "j3bk 3qtul8wzeemnns7g" }, "request" { "pathparameters" \[ { "name" "partnercode", "kind" "required", "type" "string", "description" "partner (buyer) identifier (e g rdkxx mpbxxx) ", "" "partner (buyer) identifier (e g rdkxx mpbxxx) " }, { "name" "token", "kind" "required", "type" "string", "description" "unique identifier generated for this search session this token must be used to retrieve the actual search results ", "" "unique identifier generated for this search session this token must be used to retrieve the actual search results " } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "response" \[ { "name" "success", "kind" "optional", "type" "boolean", "description" "indicates that the search results were successfully generated " }, { "name" "tokenid", "kind" "optional", "type" "string", "description" "the same token used to retrieve the results returned again for tracking and debugging ", "children" \[] }, { "name" "errors", "kind" "optional", "type" "array", "description" "", "children" \[] }, { "name" "data", "kind" "optional", "type" "object", "description" "container for the searched property", "children" \[ { "name" "propertyid", "kind" "optional", "type" "string", "description" "property id requested " }, { "name" "propertyname", "kind" "optional", "type" "string", "description" "display name of the property " }, { "name" "occupancies", "kind" "optional", "type" "object", "description" "list of room occupancies requested (rooms per search) ", "children" \[ { "name" "occupancyrefid", "kind" "optional", "type" "integer", "description" "links room result to the requested occupancy " }, { "name" "checkindate", "kind" "optional", "type" "string", "description" "iso check in date (e g , 2025 10 05) " }, { "name" "checkoutdate", "kind" "optional", "type" "string", "description" "iso check out date (e g , 2025 10 05) " }, { "name" "numberofadults", "kind" "optional", "type" "integer", "description" "number of adults for this occupancy " }, { "name" "numberofchildren", "kind" "optional", "type" "integer", "description" "number of children for this occupancy " }, { "name" "childrenblocks", "kind" "optional", "type" "object", "description" "progressive block identifier ", "children" \[ { "name" "childblock", "kind" "optional", "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" "optional", "type" "integer", "description" "number of children for this age group " }, { "name" "childrenages", "kind" "optional", "type" "string", "description" "children age range for this group " } ] } ] }, { "name" "rooms", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "occupancyrefid", "kind" "optional", "type" "string", "description" "links room result to the requested occupancy \n" }, { "name" "roomid", "kind" "optional", "type" "string", "description" "room identifier " }, { "name" "roomnameeng", "kind" "optional", "type" "string", "description" "room name in english \nthe suffix “eng” identifies the language using the iso 639 2/3 code (en for english) " }, { "name" "rateid", "kind" "optional", "type" "string", "description" "identifier for this rate plan" }, { "name" "includedmeals", "kind" "optional", "type" "string", "description" "meal plan included in the rate " }, { "name" "includedmealsdetail", "kind" "optional", "type" "object", "description" "included meal information (flags + metadata) ", "children" \[ { "name" "amenitybreakfast", "kind" "optional", "type" "boolean", "description" "true = included \nfalse = not included" }, { "name" "breakfasttype", "kind" "optional", "type" "boolean", "description" "true = included \nfalse = not included" }, { "name" "breakfastconfirm", "kind" "optional", "type" "string", "description" "true = included \nfalse = not included" }, { "name" "amenitydinner", "kind" "optional", "type" "boolean", "description" "true = included \nfalse = not included" }, { "name" "dinnerconfirm", "kind" "optional", "type" "string", "description" "available options are \ndirect = the meal is confirmed immediately at the time of booking\non request = the meal is not confirmed instantly " }, { "name" "dinnerexchange", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = guest can swap dinner with lunch \nfalse = guest cannot swap dinner with lunch " }, { "name" "dinnermenu", "kind" "optional", "type" "string", "description" "available options are \na la carte \nfixed menu\nbuffet" }, { "name" "dinnertype", "kind" "optional", "type" "string", "description" "dinner cusine type such as \nainu,albanian,argentine,andhra,anglo indian,arab,armenian,assyrian,awadhi,azerbaijani,balochi,belarusian,bangladeshi,bengali,berber,brazilian,buddhist,bulgarian,cajun,cantonese,caribbean,chechen,chinese cuisine,chinese islamic,circassian,crimean tatar,cypriot,danish,english,estonian,french,filipino,georgian,german,goan,goan catholic,greek,gujarati,hyderabad,hong kong western,indian cuisine,indian chinese,indian singaporean cuisine,indonesian,inuit,irish,italian american,italian cuisine,jamaican" }, { "name" "lunchconfirm", "kind" "optional", "type" "string", "description" "available options are \ndirect = the meal is confirmed immediately at the time of booking\non request = the meal is not confirmed instantly " }, { "name" "lunchexchange", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = guest can swap lunch with dinner \nfalse = guest cannot swap lunch with dinner " }, { "name" "lunchmenu", "kind" "optional", "type" "string", "description" "available options are \na la carte \nfixed menu\nbuffet" }, { "name" "lunchtype", "kind" "optional", "type" "string", "description" "lunch cuisine type such as \nainu,albanian,argentine,andhra,anglo indian,arab,armenian,assyrian,awadhi,azerbaijani,balochi,belarusian,bangladeshi,bengali,berber,brazilian,buddhist,bulgarian,cajun,cantonese,caribbean,chechen,chinese cuisine,chinese islamic,circassian,crimean tatar,cypriot,danish,english,estonian,french,filipino,georgian,german,goan,goan catholic,greek,gujarati,hyderabad,hong kong western,indian cuisine,indian chinese,indian singaporean cuisine,indonesian,inuit,irish,italian american,italian cuisine,jamaican" } ] }, { "name" "getextrameals", "kind" "optional", "type" "boolean", "description" "indicates whether extra meals are enabled to be pulled based on the system configuration \navailable options \ntrue —> extra meals are enabled and will be pulled\nfalse —> extra mealsare not enabled and will not be pulled" }, { "name" "excludedmeals", "kind" "optional", "type" "string", "description" "meal plan(s) not included \navailable options are \nbreakfast \nhalfboard\nfullboard \nall inclusive" }, { "name" "excludedmealsdetail", "kind" "optional", "type" "object", "description" "pricing and conditions for excluded meals ", "children" \[ { "name" "amenitybreakfast", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = breakfast is available for purchase\nfalse = breakfast is not available for purchase" }, { "name" "breakfasttype", "kind" "optional", "type" "string", "description" "type of breakfast such as continental,italian,american,vegetarian,vegan,full english / irish,halal,gluten free,intercontinental,kosher,asian" }, { "name" "breakfastconfirm", "kind" "optional", "type" "string", "description" "available options are \ndirect = the meal is confirmed immediately at the time of booking\non request = the meal is not confirmed instantly " }, { "name" "breakfastchargeinfo", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "agefrom", "kind" "optional", "type" "number", "description" "if agequalifying = \\"adult\\", then agefrom = null\nif agequalifying = \\"child\\" or \\"infant\\", then agefrom must be between 0 and 17 (inclusive)" }, { "name" "agequalifying", "kind" "optional", "type" "string", "description" "available options are \nadult\nchild\ninfant" }, { "name" "ageto", "kind" "optional", "type" "number", "description" "if agequalifying = \\"adult\\", then ageto = null\nif agequalifying = \\"child\\" or \\"infant\\", then ageto must be same or higher than agefrom between 0 and 17 (inclusive)" }, { "name" "currencycode", "kind" "optional", "type" "string", "description" "3 letter iso currency code (e g eur, usd, sgd) " }, { "name" "mealcharge", "kind" "optional", "type" "string", "description" "indicates whether the meal is chargeable \ntrue → meal is chargeable\nfalse → meal is not chargeable" }, { "name" "mealrate", "kind" "optional", "type" "string", "description" "when mealcharge = false, mealrate must be 0 00\nwhen mealcharge = true, mealrate must be greater than 0 00" } ] }, { "name" "amenitylunch", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = lunch is available for purchase\nfalse = lunch is not available for purchase" }, { "name" "lunchmenu", "kind" "optional", "type" "string", "description" "available options are \na la carte \nfixed menu\nbuffet" }, { "name" "lunchtype", "kind" "optional", "type" "string", "description" "lunch cuisine type such as \nainu,albanian,argentine,andhra,anglo indian,arab,armenian,assyrian,awadhi,azerbaijani,balochi,belarusian,bangladeshi,bengali,berber,brazilian,buddhist,bulgarian,cajun,cantonese,caribbean,chechen,chinese cuisine,chinese islamic,circassian,crimean tatar,cypriot,danish,english,estonian,french,filipino,georgian,german,goan,goan catholic,greek,gujarati,hyderabad,hong kong western,indian cuisine,indian chinese,indian singaporean cuisine,indonesian,inuit,irish,italian american,italian cuisine,jamaican" }, { "name" "lunchconfirm", "kind" "optional", "type" "string", "description" "available options are \ndirect = the meal is confirmed immediately at the time of booking\non request = the meal is not confirmed instantly " }, { "name" "lunchexchange", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = guest can swap lunch with dinner \nfalse = guest cannot swap lunch with dinner " }, { "name" "lunchchargeinfo", "kind" "optional", "type" "object", "description" "indicates lunch charge breakdown", "children" \[ { "name" "agefrom", "kind" "optional", "type" "number", "description" "f agequalifying = \\"adult\\", then agefrom = null\nif agequalifying = \\"child\\" or \\"infant\\", then agefrom must be between 0 and 17 (inclusive)" }, { "name" "agequalifying", "kind" "optional", "type" "string", "description" "available options are \nadult\nchild\ninfant" }, { "name" "ageto", "kind" "optional", "type" "number", "description" "if agequalifying = \\"adult\\", then agefrom = null\nif agequalifying = \\"child\\" or \\"infant\\", then agefrom must be between 0 and 17 (inclusive)" }, { "name" "currencycode", "kind" "optional", "type" "string", "description" "3 letter iso currency code (e g eur, usd, sgd) " }, { "name" "mealcharge", "kind" "optional", "type" "boolean", "description" "indicates whether the meal is chargeable \ntrue → meal is chargeable\nfalse → meal is not chargeable" }, { "name" "mealrate", "kind" "optional", "type" "string", "description" "when mealcharge = false, mealrate must be 0 00\nwhen mealcharge = true, mealrate must be greater than 0 00" } ] }, { "name" "amenitydinner", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = dinner is available for purchase\nfalse = dinner is not available for purchase" }, { "name" "dinnermenu", "kind" "optional", "type" "string", "description" "available options are \na la carte \nfixed menu\nbuffet" }, { "name" "dinnertype", "kind" "optional", "type" "string", "description" "dinner cusine type such as \nainu,albanian,argentine,andhra,anglo indian,arab,armenian,assyrian,awadhi,azerbaijani,balochi,belarusian,bangladeshi,bengali,berber,brazilian,buddhist,bulgarian,cajun,cantonese,caribbean,chechen,chinese cuisine,chinese islamic,circassian,crimean tatar,cypriot,danish,english,estonian,french,filipino,georgian,german,goan,goan catholic,greek,gujarati,hyderabad,hong kong western,indian cuisine,indian chinese,indian singaporean cuisine,indonesian,inuit,irish,italian american,italian cuisine,jamaican" }, { "name" "dinnerconfirm", "kind" "optional", "type" "string", "description" "available options are \ndirect = the meal is confirmed immediately at the time of booking\non request = the meal is not confirmed instantly " }, { "name" "dinnerexchange", "kind" "optional", "type" "boolean", "description" "available options are \ntrue = guest can swap dinner with lunch\nfalse = guest cannot swap dinner with lunch" }, { "name" "dinnerchargeinfo", "kind" "optional", "type" "object", "description" "indicates dinner charge breakdown", "children" \[ { "name" "agefrom", "kind" "optional", "type" "number", "description" "if agequalifying = \\"adult\\", then agefrom = null\nif agequalifying = \\"child\\" or \\"infant\\", then agefrom must be between 0 and 17 (inclusive)" }, { "name" "agequalifying", "kind" "optional", "type" "string", "description" "available options are \nadult\nchild\ninfant" }, { "name" "ageto", "kind" "optional", "type" "string", "description" "if agequalifying = \\"adult\\", then agefrom = null\nif agequalifying = \\"child\\" or \\"infant\\", then agefrom must be between 0 and 17 (inclusive)" }, { "name" "currencycode", "kind" "optional", "type" "string", "description" "3 letter iso currency code (e g eur, usd, sgd) " }, { "name" "mealcharge", "kind" "optional", "type" "boolean", "description" "indicates whether the meal is chargeable \ntrue → meal is chargeable\nfalse → meal is not chargeable" }, { "name" "mealrate", "kind" "optional", "type" "string", "description" "when mealcharge = false, mealrate must be 0 00\nwhen mealcharge = true, mealrate must be greater than 0 00" } ] } ] }, { "name" "getinclusion", "kind" "optional", "type" "boolean", "description" "indicates whether inclusions are enabled to be pulled based on the system configuration \n\navailable options \ntrue —> inclusions are enabled and will be pulled\nfalse —> inclusions are not enabled and will not be pulled" }, { "name" "inclusion", "kind" "optional", "type" "boolean", "description" "indicates whether extras are enabled to be pulled based on the system configuration \n\navailable options \ntrue —> extras are enabled and will be pulled\nfalse —> extras are not enabled and will not be pulled" }, { "name" "amenityinclusion", "kind" "optional", "type" "object", "description" "" }, { "name" "getextra", "kind" "optional", "type" "boolean", "description" "available options \ntrue —> extras are available for this room configuration\nfalse —> extras are not available for tis room configuration" }, { "name" "extra", "kind" "optional", "type" "boolean", "description" "indicates whether extras are enabled to be pulled based on the system configuration \navailable options \ntrue —> extras are enabled and will be pulled\nfalse —> extras are not enabled and will not be pulled" }, { "name" "amenityextra", "kind" "optional", "type" "object", "description" "" }, { "name" "rateinfo", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "ratebar", "kind" "optional", "type" "boolean", "description" "indicates whether the bar rate is enabled to be pulled based on the system configuration \n\navailable options \ntrue —> bar rate is enabled and will be pulled\nfalse —> bar rate is not enabled and will not be pulled" }, { "name" "ratediscount", "kind" "optional", "type" "integer", "description" "discount applied vs base rate (percentage) " }, { "name" "ratedetails", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "currencycode", "kind" "optional", "type" "string", "description" "3 letter iso currency code (e g eur, usd, sgd) " }, { "name" "amountbeforetax", "kind" "optional", "type" "string", "description" "room amount before taxes/fees decimal as string, e g \\"100 00\\"" }, { "name" "amountaftertax", "kind" "optional", "type" "string", "description" "room amount after taxes/fees (total sell price) decimal as string " }, { "name" "dailypricebeforetax", "kind" "optional", "type" "array", "description" "room amount day wise before taxes/fees (day wise sell price) decimal as string " }, { "name" "dailypriceaftertax", "kind" "optional", "type" "array", "description" "room amount day wise after taxes/fees (day wise sell price) decimal as string " }, { "name" "beforetax", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "taxfeedetails", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "taxtype", "kind" "optional", "type" "string", "description" "used to identify the tax label , the available options are vat , tax and fees" }, { "name" "taxcalculator", "kind" "optional", "type" "string", "description" "used to identify the tax calculator , the available options are \n percentage \n currency" }, { "name" "taxmultiplicator", "kind" "optional", "type" "string", "description" "defines how the tax/fee is multiplied \n\nallowed values \n night\n stay\n first night\n\nrules \nwhen taxapplicability is night , taxmultiplicator could be night or first night \n\nwhen taxapplicability is stay , taxmultiplicator would be stay as well " }, { "name" "taxapplicability", "kind" "optional", "type" "string", "description" "allowed values \n night\n stay\n\nrules \nif taxtype = tax or vat\n→ taxapplicability = night\n\nif taxtype = fee\n→ value depends on fee configuration (see taxmultiplicator)" }, { "name" "taxincluded", "kind" "optional", "type" "boolean", "description" "0 = included in amountbeforetax \n1= not included (to be added on top) " }, { "name" "taxdescription", "kind" "optional", "type" "string", "description" "human readable description of the tax " }, { "name" "taxcurrency", "kind" "optional", "type" "string", "description" "3 letter iso currency code (e g eur, usd, sgd)" }, { "name" "taxvalue", "kind" "optional", "type" "string", "description" "tax value as a percentage " } ] } ] }, { "name" "aftertax", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "taxfeedetails", "kind" "optional", "type" "object", "description" "", "children" \[ { "name" "taxtype", "kind" "optional", "type" "string", "description" "used to identify the tax label , the available options are vat and fees" }, { "name" "taxcalculator", "kind" "optional", "type" "string", "description" "used to identify the tax calculator , the available options are \n percentage \n currency" }, { "name" "taxmultiplicator", "kind" "optional", "type" "string", "description" "defines how the tax/fee is multiplied \nallowed values \n night\n stay\n first night\n\nrules \nwhen taxapplicability is night , taxmultiplicator could be night or first night \n\nwhen taxapplicability is stay , taxmultiplicator would be stay as well " }, { "name" "taxapplicability", "kind" "optional", "type" "string", "description" "allowed values \n night\n stay\n\nrules \nif taxtype = tax or vat\n→ taxapplicability = night\n\nif taxtype = fee\n→ value depends on fee configuration (see taxmultiplicator)" }, { "name" "taxincluded", "kind" "optional", "type" "boolean", "description" "0 = included in amountbeforetax \n1= not included (to be added on top) " }, { "name" "taxdescription", "kind" "optional", "type" "string", "description" "human readable description of the tax " }, { "name" "taxcurrency", "kind" "optional", "type" "string", "description" "3 letter iso currency code (e g eur, usd, sgd) " }, { "name" "taxvalue", "kind" "optional", "type" "string", "description" "tax value as a percentage " } ] } ] } ] } ] }, { "name" "getdeposit", "kind" "optional", "type" "boolean", "description" "indicates whether the deposit is enabled to be pulled based on the system configuration \navailable options \ntrue —> deposit is enabled and will be pulled\nfalse —> deposit is not enabled and will not be pulled" }, { "name" "deposit", "kind" "optional", "type" "object", "description" "represents the deposit policy for the rate plan ", "children" \[ { "name" "depositpolicy", "kind" "optional", "type" "boolean", "description" "whether a deposit is required \n\\"required\\" = true, \n\\"not required\\" = false when refundable is false, deposit will always be \\"required\\"" }, { "name" "deposittype", "kind" "optional", "type" "string", "description" "deposit cost parameter available > percentage" }, { "name" "depositamount", "kind" "optional", "type" "string", "description" "percentage value from 1 to 100 " }, { "name" "depositapplied", "kind" "optional", "type" "string", "description" "whether a deposit is applied \n first night\n full stay" }, { "name" "depositintervalunits", "kind" "optional", "type" "integer", "description" "whether a deposit is applied \n first night\n full stay" }, { "name" "deposittimeinterval", "kind" "optional", "type" "string", "description" "interval value applied only if depositintervalunits = 1 allowed values 1–10 or 10, 30, 45, 60 represents number of days before arrival when deposit is charged" }, { "name" "depositdescription", "kind" "optional", "type" "string", "description" "human readable description of the deposit rule " }, { "name" "timezone", "kind" "optional", "type" "string", "description" "time zone used to calculate the deposit charge timing " } ] }, { "name" "getcancellation", "kind" "optional", "type" "boolean", "description" "indicates whether the cancellation is enabled to be pulled based on the system configuration \navailable options \ntrue —> cancellation is enabled and will be pulled\nfalse —> cancellation is not enabled and will not be pulled" }, { "name" "refundable", "kind" "optional", "type" "boolean", "description" "\\"true\\" if the rate is refundable, \\"false\\" if non refundable " }, { "name" "cancellationpolicies", "kind" "optional", "type" "object", "description" "each entry represents one cancellation rule level (e g first deadline, second deadline)", "children" \[ { "name" "policylevel", "kind" "optional", "type" "integer", "description" "level of the cancellation rule 1 = first level, 2 = second level (for multi step policies) " }, { "name" "policyid", "kind" "optional", "type" "integer", "description" "type of cancellation policy linked to the rate plan 1 = standard, 2 = flexible 1, 3 = flexible 2, 4 = flexible 3, 5 = flexible 4" }, { "name" "dayspriorcheckin", "kind" "optional", "type" "string", "description" "number of days before check in a guest can cancel without penalty use 0 if cancellation is set at 18 00 on day of arrival " }, { "name" "penaltytype", "kind" "optional", "type" "string", "description" "penalty cost parameter available > percentage " }, { "name" "penaltyapplied", "kind" "optional", "type" "string", "description" "whether the penalty is applied \n first night\n full stay" }, { "name" "penaltyamount", "kind" "optional", "type" "string", "description" "percentage value from 1 to 100 " }, { "name" "policydescription", "kind" "optional", "type" "string", "description" "human readable description of the cancellation policy rule" }, { "name" "timezone", "kind" "optional", "type" "string", "description" "time zone used to calculate the deposit charge timing " } ] } ] }, { "name" "getadditionaltax", "kind" "optional", "type" "boolean", "description" "indicates whether addtional taxes are enabled to be pulled based on the system configuration \n\navailable options \ntrue —> additional taxes is enabled and will be pulled\nfalse —> additional taxes is not enabled and will not be pulled" }, { "name" "payatbooking", "kind" "optional", "type" "boolean", "description" "indicates whether addtional pay at booking taxes are enabled to be pulled based on the system configuration \n\navailable options \ntrue —> pay at booking taxes is enabled and will be pulled\nfalse —> pay at booking taxes is not enabled and will not be pulled\nnull —> pay at booking taxes is enabled but there are no tax to pull" }, { "name" "payatproperty", "kind" "optional", "type" "boolean", "description" "indicates whether addtional pay at property taxes are enabled to be pulled based on the system configuration \navailable options \ntrue —> pay at property taxes is enabled and will be pulled\nfalse —> pay at property taxes is not enabled and will not be pulled\nnull —> pay at property taxes is enabled but there are no tax to pull " }, { "name" "payatbookingdata", "kind" "optional", "type" "object", "description" "list of taxes/fees payable at booking \nreturned only when getadditionaltax = true and payatbooking = true ", "children" \[ { "name" "taxtype", "kind" "optional", "type" "string", "description" "allowed values tax, fee" }, { "name" "taxapplicability", "kind" "optional", "type" "string", "description" "allowed values night, stay, first night" }, { "name" "taxmultiplicator", "kind" "optional", "type" "string", "description" "allowed values adult, room, guest\nwhen taxmultiplicator = guest, a guest level breakdown is returned" }, { "name" "taxincluded", "kind" "optional", "type" "boolean", "description" "fixed value false" }, { "name" "guest", "kind" "optional", "type" "object", "description" "returned only when taxmultiplicator = guest", "children" \[ { "name" "taxcalculator", "kind" "optional", "type" "string", "description" "allowed values currency, percentage, false" }, { "name" "taxcurrency", "kind" "optional", "type" "string", "description" "when taxcalculator is percentage, taxcurrency would be → null\n\nwhen taxcalculator is currency taxcurrency would be have → iso currency code (e g usd, eur)\n\ngratis → false" }, { "name" "agequalifying", "kind" "optional", "type" "string", "description" "allowed values adult, child, infant" }, { "name" "agefrom", "kind" "optional", "type" "string", "description" "return null when agequalifying is = adult \nreturn value between 0 and 17 (inclusive) when agequalifying is = child or infant " }, { "name" "ageto", "kind" "optional", "type" "string", "description" "return null when agequalifying is = adult \nreturn value between 0 and 17 (inclusive) and must be greater than or equal to minag, when agequalifying is = child or infant " }, { "name" "taxdescription", "kind" "optional", "type" "string", "description" "human readable description of the tax/fee, taken directly from the property configuration " }, { "name" "taxvalue", "kind" "optional", "type" "string", "description" "return percentage between 0 01 to 99 99 when taxcalculator = percentage\nreturn value between 0 01 to 99,999,999,999 99 when taxcalculator = currency" }, { "name" "taxcharge", "kind" "optional", "type" "boolean", "description" "false → gratis (no charge, calculation fields omitted)\ntrue → tax applies" } ] } ] }, { "name" "payatpropertydata", "kind" "optional", "type" "object", "description" "list of taxes/fees payable at property \nreturned only when getadditionaltax = true and payatproperty = true ", "children" \[ { "name" "taxtype", "kind" "optional", "type" "string", "description" "allowed values tax, fee" }, { "name" "taxapplicability", "kind" "optional", "type" "string", "description" "allowed values night, stay, first night" }, { "name" "taxmultiplicator", "kind" "optional", "type" "string", "description" "allowed values adult, room, guest\nwhen taxmultiplicator = guest, a guest level breakdown is returned " }, { "name" "taxincluded", "kind" "optional", "type" "boolean", "description" "fixed value false" }, { "name" "guest", "kind" "optional", "type" "object", "description" "returned only when taxmultiplicator = guest", "children" \[ { "name" "taxcalculator", "kind" "optional", "type" "string", "description" "allowed values currency, percentage, false" }, { "name" "taxcurrency", "kind" "optional", "type" "string", "description" "when taxcalculator is percentage, taxcurrency would be → null\n\nwhen taxcalculator is currency taxcurrency would be have → iso currency code (e g usd, eur)" }, { "name" "agequalifying", "kind" "optional", "type" "string", "description" "allowed values adult, child, infant" }, { "name" "agefrom", "kind" "optional", "type" "string", "description" "return null when agequalifying is = adult \nreturn value between 0 and 17 (inclusive) when agequalifying is = child or infant" }, { "name" "ageto", "kind" "optional", "type" "string", "description" "return null when agequalifying is = adult \nreturn value between 0 and 17 (inclusive) and must be greater than or equal to minag, when agequalifying is = child or infant" }, { "name" "taxvalue", "kind" "optional", "type" "string", "description" "return percentage between 0 01 to 99 99 when taxcalculator = percentage\nreturn value between 0 01 to 99,999,999,999 99 when taxcalculator = currency" }, { "name" "taxdescription", "kind" "optional", "type" "string", "description" "human readable description of the tax/fee, taken directly from the property configuration " }, { "name" "taxcharge", "kind" "optional", "type" "boolean", "description" "false → gratis (no charge, calculation fields omitted)\ntrue → tax applies" } ] } ] } ] } ], "autogeneratedanchorslug" "search results sps single property shopping", "legacyhash" "7fndleipgkhgztcdads2q" }