V1 (deprecated)

1 min

The v1 APIs are now deprecated! If you are building a new implementation, we strongly recommend going through V2 by visiting Overview

Using Klevu’s category navigation API, you can now retrieve products for your individual categories, where the order of products is decided by Klevu’s trend-driven intelligent algorithms. If you have setup merchandising rules in the Klevu Merchant Center, all your settings are respected and the order of products is decided accordingly. The continuous learning in Klevu’s backend ensures regular updates on individual category pages reflecting the changing trends of your website.

Record search

Use this API method if you want not only the record IDs but also other details associated with the matching records. The method allows you to retrieve facets and autosuggestions as well.

GET

https://<cloudSearchURL>/cloud-search/n-search/search

Query Parameters

ticketstringrequired
Description
This is your Klevu JS API Key.
termstringrequired
Description
This should always be set to " * " .
isCategoryNavigationRequestBooleanrequired
Description
This should always be set to true.
categoryIntegerrequired
Description
Hierarchy of the category for which the query is being issued. e.g. Gifts;Gifts For;Gifts for Him Use ";" as a separator between a parent and its child category. It is important that the complete hierarchy of a category is supplied. This is to make sure the results from the correct heirarchy are retrieved.
svNumberrequired
Description
The sv parameter is used for indicating which version of the Klevu Magento plugin you are using (e.g. 1.2.5). In case of a non-magento store, please use the constant “20.0.0”
paginationStartsFromInteger
Description
Index of the first record to be fetched.If for example showing 12 results per page, use the index 12 for the second page and 24 for the third page and so on.
noOfResultsInteger
Description
Indicates the number of records to be fetched. If for example, paginationStartsFrom is set to 0, it will obtain results from 0.
enableFiltersBoolean
Description
If set to true, filters relevant to the search results are retrieved and included in the response. The default value is false.
enableMultiSelectFiltersBoolean
Description
If set to true, we treat different values of a filter as checkboxes. Otherwise, if set to false, they are treated as radio buttons. e.g. color:green;;color:white;;brand:nike When set to true, it finds products with either green OR white color with the brand nike. When set to false, it finds products with both green AND white color AND brand nike. Default value is false.
applyFiltersstring
Description
Tells Klevu which filters to apply on the search results. In case of multiple filters, please use the double semicolon (;;) as the delimiter. Values provided here should be the strings taken from the value attribute of the option element under the filters. e.g. color:green;;color:white;;brand:nike
maxNoOfValuesInAFilterInteger
Description
Number of values to return for each filter. The default is 50.
sortOrderstring
Description
If you want to sort results in certain order, please use one of the following values: - rel for Relevance, - lth for Price: Low to High, - htl for Price: High to Low. The default value is rel.
showOutOfStockProductsBoolean
Description
True to include out of stock products in the search result set, false otherwise. The default value is false.
fetchMinMaxPriceBoolean
Description
If set to true, it returns the minimum and maximum prices found for the obtained search results. This can be used, for example, for displaying price slider. If set to false, Klevu will return price ranges (e.g. 0-500, 500-1000 etc.). The price range intervals are dynamically generated by Klevu. The default value is false.
priceFieldSuffixstring
Description
If you are a shopify plus customer with the multicurrency feature enabled, you can now provide a currency (other than the base currency of your store), to fetch prices in that currency. If in case the prices are not available in the supplied currency, Klevu will return prices in the base currency of the store. e.g. priceFieldSuffix=USD
visibilitystring
Description
Always set this parameter to search to include products with the visibility of search to be included in the result set. The default value is search.
optionalFiltersstring
Description
A parameter to enable personalisation. It instructs Klevu to boost products with the filter values specified here. In case of multiple filters, please use the double semicolon (;;) as a delimiter With each filter value, one can assign a boost score. For example, if in past a user was seen preferring green color products over any other color and brand to be nike, one can specify the optionalFilters as the following: e.g. color:green^10;;brand:nike^3.0 Here, use ;; as a delimiter between two filter values and a score between 1 and 100 to boost filter options. Values provided here should be the strings taken from the value attribute of the option element under the filters.
responseTypestring
Description
Type of response to be returned. Possible values are xml or json. The default value is xml.
lsqtstring
Description
When you receive a response for a search query, look at the value of the typeOfQuery element under the metaData section. When you fire a subsequent query (e.g. to apply additional filters, or to obtain results for the next page), pass this value as the value of the lsqt (last search query type) parameter. Possible values are WILDCARD_AND, FUZZY_AND, OR, FUZZY_OR.
flstring
Description
When Klevu returns search results, the response has certain fields for each record included. If you like to retrieve only a set of selected filters, use a list of comma separated field names.

curl

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://eucs15.ksearchnet.com/cloud-search/n-search/search?ticket=klevu-156925593843210765&term=*&isCategoryNavigationRequest=true&category=KLEVU_PRODUCT%20watches&sv=20.0.0&paginationStartsFrom=0&noOfResults=2&enablePartialSearch=false&enableFilters=false&enableMultiSelectFilters=false&showOutOfStockProducts=true&responseType=json',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

200

{
    "meta": {
        "layoutId": "",
        "layoutType": "",
        "noOfResults": 2,
        "paginationStartFrom": 0,
        "powerdByLogo": "",
        "totalResultsFound": 9,
        "typeOfQuery": "WILDCARD_AND",
        "storeBaseCurrency": "GBP",
        "notificationCode": 1,
        "term": "*",
        "excludeIds": null,
        "isPersonalised": false,
        "idsUsedForPersonalisation": null
    },
    "result": [
        {
            "discount": "",
            "hideGroupPrices": "",
            "type": "Watches",
            "itemGroupId": "4384059195454",
            "freeShipping": "",
            "storeBaseCurrency": "GBP",
            "price": "49.00",
            "toPrice": "",
            "imageUrl": "https://cdn.shopify.com/s/files/1/0116/9457/1582/products/mg01-bk-0_34e7622a-503f-42f7-8e63-a57d758cf293_medium.jpg?v=1575478386",
            "currency": "GBP",
            "inStock": "yes",
            "id": "31366496419902",
            "imageHover": "https://cdn.shopify.com/s/files/1/0116/9457/1582/products/mg01-bk-0_1024x1024_f5db396b-312b-49e3-aa4d-d6731e17d7b1_medium.jpg?v=1575478386",
            "sku": "24-MG01",
            "brand": "KKE",
            "startPrice": "",
            "image": "https://cdn.shopify.com/s/files/1/0116/9457/1582/products/mg01-bk-0_34e7622a-503f-42f7-8e63-a57d758cf293_medium.jpg?v=1575478386",
            "deliveryInfo": "",
            "hideAddToCart": "",
            "salePrice": "49.0",
            "oldPrice": "49.0",
            "swatches": {
                "swatch": [],
                "lowestPrice": "",
                "numberOfAdditionalVariants": ""
            },
            "weight": "",
            "klevu_category": "KLEVU_PRODUCT;Products;;Watches  @ku@kuCategory@ku@",
            "totalVariants": "0",
            "groupPrices": "",
            "url": "https://jsv2-shopify-demo.ksearchmisc.com/products/endurance-watch",
            "tags": "Digital, LED, watch",
            "size": "Free Size",
            "name": "Endurance Watch",
            "shortDesc": "It's easy to track and monitor your training progress with the Endurance Watch. You'll see standard info like time, date and day of the week, but it also functions for the serious high-mileage athete: lap counter, stopwatch, distance, heart rate,",
            "category": "Watches",
            "typeOfRecord": "KLEVU_PRODUCT"
        },
        {
            "discount": "",
            "hideGroupPrices": "",
            "type": "Watches",
            "itemGroupId": "4384058769470",
            "freeShipping": "",
            "storeBaseCurrency": "GBP",
            "price": "92.00",
            "toPrice": "",
            "imageUrl": "https://cdn.shopify.com/s/files/1/0116/9457/1582/products/mg02-bk-0_e6375bd6-e9b3-41ad-ae00-b6ee4457023b_medium.jpg?v=1575478380",
            "currency": "GBP",
            "inStock": "yes",
            "id": "31366495961150",
            "imageHover": "https://cdn.shopify.com/s/files/1/0116/9457/1582/products/mg02-bk-0_1024x1024_42c6e9b6-bf83-4bcc-825b-f532eeda29a3_medium.jpg?v=1575478380",
            "sku": "24-MG02",
            "brand": "KKE",
            "startPrice": "",
            "image": "https://cdn.shopify.com/s/files/1/0116/9457/1582/products/mg02-bk-0_e6375bd6-e9b3-41ad-ae00-b6ee4457023b_medium.jpg?v=1575478380",
            "deliveryInfo": "",
            "hideAddToCart": "",
            "salePrice": "92.0",
            "oldPrice": "92.0",
            "swatches": {
                "swatch": [],
                "lowestPrice": "",
                "numberOfAdditionalVariants": ""
            },
            "weight": "",
            "klevu_category": "KLEVU_PRODUCT;Products;;Watches  @ku@kuCategory@ku@",
            "totalVariants": "0",
            "groupPrices": "",
            "url": "https://jsv2-shopify-demo.ksearchmisc.com/products/dash-digital-watch",
            "tags": "dash, digital, watch",
            "size": "Free Size",
            "name": "Dash Digital Watch",
            "shortDesc": "The Dash Digital Watch will challenge you to push harder and longer. Log workouts by date, average, and segment times, and recharge by setting hydration and nutrition alarms. This watch is styled with a sleek, square face and durable rubber strap",
            "category": "Watches",
            "typeOfRecord": "KLEVU_PRODUCT"
        }
    ],
    "filters": [],
    "price": {
        "min": "",
        "max": "",
        "start": "",
        "end": ""
    },
    "autoComplete": [],
    "popularTerm": [],
    "pages": [],
    "categories": [],
    "popularProducts": [],
    "recentlyViewedProducts": [],
    "ranges": [],
    "error": {
        "errorMessage": ""
    }
}