--- title: Search Results - SPS Single Property Shopping - Occupancy Base slug: search-results-sps-single-property-shopping-occupancy-base createdAt: 2025-10-10T07:33:52.818Z --- :::ApiMethodV2 ```json { "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" } ``` :::