--- title: Hand Picked slug: apis/smart-recommendations-hand-picked docTags: createdAt: 2022-05-02T12:10:53.000Z --- :::hint{type="info"} If you haven't gone through the prerequisites and the v2 structure, please have a look at [Overview](docId\:cZeodl0sKcuv-18IPupLr) ::: Klevu can power a recommendation banner showcasing any products which you, the merchant, has manually curated. The most common placements for this banner type are: **Homepage: Our Recommended Products** Show a recommendation banner with products you would like all customers to see. :::ApiMethodV2 ```json { "tab": "examples", "url": "https://eucs19v2.ksearchnet.com/cs/v2/search", "name": "Hand Picked Product Recommendations", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "typeOfRequest", "type": "String", "description": "For this recommendation type, please specify SEARCH." }, { "kind": "required", "name": "customANDQuery", "type": "String", "description": "Here we make a custom query to Klevu, since we know exactly which records we expect in the response. Specify the IDs of all of the products you would like your customers to see, separated by OR" }, { "kind": "required", "name": "topIds", "type": "Array", "description": "Use this field to specify the order the results should be returned, with the ones you would like to be more prominent coming first." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "3XlvmT855lGkJOht0nPXg", "code": "{\n \"meta\": {\n \"qTime\": 7,\n \"responseCode\": 200\n },\n \"queryResults\": [\n {\n \"id\": \"recsHandPicked\",\n \"meta\": {\n \"qTime\": 4,\n \"noOfResults\": 12,\n \"totalResultsFound\": 2,\n \"typeOfSearch\": \"WILDCARD_AND\",\n \"offset\": 0,\n \"debuggingInformation\": {},\n \"notificationCode\": 1,\n \"searchedTerm\": \"*\",\n \"apiKey\": \"klevu-158755634955912036\",\n \"isPersonalised\": false\n },\n \"records\": [\n {\n \"color\": \"White Hoodie thick\",\n \"discount\": \"\",\n \"hideGroupPrices\": \"\",\n \"itemGroupId\": \"5192753152131\",\n \"freeShipping\": \"\",\n \"storeBaseCurrency\": \"EUR\",\n \"price\": \"56.68\",\n \"toPrice\": \"\",\n \"imageUrl\": \"https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797420_medium.jpg?v=1611184206&vid=34322452512899,34322452971651,34322453430403,34322471256195,34322471551107,34322471846019,34322472173699\",\n \"currency\": \"EUR\",\n \"inStock\": \"yes\",\n \"id\": \"34322453430403\",\n \"imageHover\": \"https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797422_medium.jpg?v=1611184206&vid=34322466177155,34322466603139,34322466930819,34322467192963,34322467586179,34322467946627,34322468339843\",\n \"sku\": \"30504298-white-hoodie-thick-asian-m\",\n \"brand\": \"klevu-personalisation-demo\",\n \"startPrice\": \"48.48\",\n \"image\": \"https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797420_medium.jpg?v=1611184206&vid=34322452512899,34322452971651,34322453430403,34322471256195,34322471551107,34322471846019,34322472173699\",\n \"deliveryInfo\": \"\",\n \"hideAddToCart\": \"\",\n \"salePrice\": \"56.68\",\n \"swatchesInfo\": \"variantColor1:Black Hoodie thin ;;;; variantColor3:Blue Hoodie thick ;;;; variantColor2:White Hoodie thick ;;;; variantColor5:White Hoodie thin ;;;; variantColor4:Black Hoodie thick ;;;; variantColor6:Yellow Hoodie thin ;;;; variantImage6:https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797423_medium.jpg?v=1611184258&vid=16847225487491 ;;;; variantImage3:https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797419_medium.jpg?v=1611184206&vid=16847185313923 ;;;; variantId6:34322463555715 ;;;; variantImage2:https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797420_medium.jpg?v=1611184206&vid=16847185510531 ;;;; variantImage5:https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797424_medium.jpg?v=1611184206&vid=16847190851715 ;;;; variantId4:34322456838275 ;;;; variantImage4:https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797418_medium.jpg?v=1611184250&vid=16847223521411 ;;;; variantId5:34322460016771 ;;;; variantId2:34322452512899 ;;;; variantId3:34322453889155 ;;;; variantImage1:https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1664797425_medium.jpg?v=1611184240&vid=16847221883011 ;;;; variantId1:34322448646275 ;;;;\",\n \"weight\": \"\",\n \"klevu_category\": \"KLEVU_PRODUCT;Products;;All;;Women Sweatshirts @ku@kuCategory@ku@\",\n \"totalVariants\": 0,\n \"groupPrices\": \"\",\n \"url\": \"https://klevu-personalisation-demo.myshopify.com/products/singleroad-mens-hoodies-men-women-2021-spring-sweatshirt-male-japanese-streetwear-oversized-yellow-anime-hoodie-men-sweatshirts\",\n \"size\": \"Asian-M\",\n \"name\": \"Singleroad Men's Hoodies Men Women 2021 Sweatshirt Male Japanese Streetwear Oversized Anime Hoodie Men Sweatshirts\",\n \"shortDesc\": \"gender:gender:men; closure:closure:none; ;;;; Brand Name: Single Road Origin: CN(Origin) Sleeve Length(cm): Full Gender:\",\n \"category\": \"All;;Women Sweatshirts\",\n \"typeOfRecord\": \"KLEVU_PRODUCT\"\n },\n {\n \"discount\": \"\",\n \"hideGroupPrices\": \"\",\n \"itemGroupId\": \"5192749842563\",\n \"freeShipping\": \"\",\n \"storeBaseCurrency\": \"EUR\",\n \"price\": \"50.00\",\n \"toPrice\": \"\",\n \"imageUrl\": \"https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1665231658_medium.jpg?v=1611183787\",\n \"currency\": \"EUR\",\n \"inStock\": \"yes\",\n \"id\": \"34322423840899\",\n \"imageHover\": \"\",\n \"sku\": \"42882422-xl\",\n \"brand\": \"klevu-personalisation-demo\",\n \"startPrice\": \"\",\n \"image\": \"https://cdn.shopify.com/s/files/1/0386/6653/5043/products/product-image-1665231658_medium.jpg?v=1611183787\",\n \"deliveryInfo\": \"\",\n \"hideAddToCart\": \"\",\n \"salePrice\": \"50.0\",\n \"swatchesInfo\": \"\",\n \"weight\": \"\",\n \"klevu_category\": \"KLEVU_PRODUCT;Products;;All;;Women Sweatshirts @ku@kuCategory@ku@\",\n \"totalVariants\": 0,\n \"groupPrices\": \"\",\n \"url\": \"https://klevu-personalisation-demo.myshopify.com/products/womens-white-printed-hooded-oversize-knitted-sweatshirt\",\n \"name\": \"WoMen's Printed Hooded Oversize Knitted Sweatshirt\",\n \"shortDesc\": \";;;; Brand Name: FASHİON ROOM Material: Cotton Origin: CN(Origin)\",\n \"category\": \"All;;Women Sweatshirts\",\n \"typeOfRecord\": \"KLEVU_PRODUCT\"\n }\n ],\n \"filters\": []\n }\n ]\n}", "language": "200", "customLabel": "" } ], "selectedLanguageId": "3XlvmT855lGkJOht0nPXg" }, "examples": { "languages": [ { "id": "jSU7DlYyJ_eUh63YSP682", "code": "{\n \"recordQueries\": [\n {\n \"id\": \"recsHandPicked\",\n \"typeOfRequest\": \"SEARCH\",\n \"settings\": {\n \"customANDQuery\":\"(id:\\\"34322453430403\\\" OR id:\\\"34322423840899\\\")\",\n \"topIds\": [\n {\n \"key\": \"id\",\n \"value\": \"34322453430403\"\n },\n {\n \"key\": \"id\",\n \"value\": \"34322423840899\"\n }\n ],\n \"typeOfRecords\": [\n \"KLEVU_PRODUCT\"\n ]\n }\n }\n ],\n \"context\": {\n \"apiKeys\": [\n \"klevu-158755634955912036\"\n ]\n }\n}", "language": "json", "customLabel": "Request Body (JSON)" }, { "id": "8Yg33Te4JzfoWp5yEbmJh", "code": " 'https://eucs19v2.ksearchnet.com/cs/v2/search',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_POSTFIELDS =>'{\n \"recordQueries\": [\n {\n \"id\": \"recsHandPicked\",\n \"typeOfRequest\": \"SEARCH\",\n \"settings\": {\n \"customANDQuery\":\"(id:\\\\\"34322453430403\\\\\" OR id:\\\\\"34322423840899\\\\\")\",\n \"topIds\": [\n {\n \"key\": \"id\",\n \"value\": \"34322453430403\"\n },\n {\n \"key\": \"id\",\n \"value\": \"34322423840899\"\n }\n ],\n \"typeOfRecords\": [\n \"KLEVU_PRODUCT\"\n ]\n }\n }\n ],\n \"context\": {\n \"apiKeys\": [\n \"klevu-158755634955912036\"\n ]\n }\n}',\n CURLOPT_HTTPHEADER => array(\n 'Content-Type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;", "language": "php", "customLabel": "" }, { "id": "WCDgTsSqAXfiwklk2V174", "code": "// WARNING: For POST requests, body is set to null by browsers.\nvar data = JSON.stringify({\n \"recordQueries\": [\n {\n \"id\": \"recsHandPicked\",\n \"typeOfRequest\": \"SEARCH\",\n \"settings\": {\n \"customANDQuery\": \"(id:\\\"34322453430403\\\" OR id:\\\"34322423840899\\\")\",\n \"topIds\": [\n {\n \"key\": \"id\",\n \"value\": \"34322453430403\"\n },\n {\n \"key\": \"id\",\n \"value\": \"34322423840899\"\n }\n ],\n \"typeOfRecords\": [\n \"KLEVU_PRODUCT\"\n ]\n }\n }\n ],\n \"context\": {\n \"apiKeys\": [\n \"klevu-158755634955912036\"\n ]\n }\n});\n\nvar xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if(this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://eucs19v2.ksearchnet.com/cs/v2/search\");\nxhr.setRequestHeader(\"Content-Type\", \"application/json\");\n\nxhr.send(data);", "language": "javascript", "customLabel": "" }, { "id": "nPW0NIJe-j5R9I5W4BGN0", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\r\\n \\\"recordQueries\\\": [\\r\\n {\\r\\n \\\"id\\\": \\\"recsHandPicked\\\",\\r\\n \\\"typeOfRequest\\\": \\\"SEARCH\\\",\\r\\n \\\"settings\\\": {\\r\\n \\\"customANDQuery\\\":\\\"(id:\\\\\\\"34322453430403\\\\\\\" OR id:\\\\\\\"34322423840899\\\\\\\")\\\",\\r\\n \\\"topIds\\\": [\\r\\n {\\r\\n \\\"key\\\": \\\"id\\\",\\r\\n \\\"value\\\": \\\"34322453430403\\\"\\r\\n },\\r\\n {\\r\\n \\\"key\\\": \\\"id\\\",\\r\\n \\\"value\\\": \\\"34322423840899\\\"\\r\\n }\\r\\n ],\\r\\n \\\"typeOfRecords\\\": [\\r\\n \\\"KLEVU_PRODUCT\\\"\\r\\n ]\\r\\n }\\r\\n }\\r\\n ],\\r\\n \\\"context\\\": {\\r\\n \\\"apiKeys\\\": [\\r\\n \\\"klevu-158755634955912036\\\"\\r\\n ]\\r\\n }\\r\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://eucs19v2.ksearchnet.com/cs/v2/search\")\n .method(\"POST\", body)\n .addHeader(\"Content-Type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();", "language": "java", "customLabel": "" }, { "id": "0Ih7nieKhHFMl7CRY51j_", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://eucs19v2.ksearchnet.com/cs/v2/search',\n 'headers': {\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"recordQueries\": [\n {\n \"id\": \"recsHandPicked\",\n \"typeOfRequest\": \"SEARCH\",\n \"settings\": {\n \"customANDQuery\": \"(id:\\\"34322453430403\\\" OR id:\\\"34322423840899\\\")\",\n \"topIds\": [\n {\n \"key\": \"id\",\n \"value\": \"34322453430403\"\n },\n {\n \"key\": \"id\",\n \"value\": \"34322423840899\"\n }\n ],\n \"typeOfRecords\": [\n \"KLEVU_PRODUCT\"\n ]\n }\n }\n ],\n \"context\": {\n \"apiKeys\": [\n \"klevu-158755634955912036\"\n ]\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});", "language": "nodejs", "customLabel": "" } ], "selectedLanguageId": "jSU7DlYyJ_eUh63YSP682" }, "description": "The end-point is used for retrieving hand picked product recommendations.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "hand-picked-product-recommendations", "legacyHash": "AehSnlU30i4_pCisP-Q9j" } ``` ::: ### Try it here! :::Iframe{code="" iframeHeight="550"} :::