Instant Search

Method Objective

The method requests products that match the search query. The method must be called for each entered character of the search query. The search for products starts from the second entered symbol.

Syntax and parameters

sdk.suggest(params) { callback }

Name	Type	Requirement	Description
params		required	Request parameters. See the description below.
callback	function	required	Callback-function, where the API response will be passed to.

Request parameters

Name	Type	Requirement	Description
query	string	required	The search query text.

API response

Name	Type	Description
products	array	An array of objects with product information. Each object has the following properties: id – product ID (type: string) name – product name (type: string) url – product page link (type: string) picture – link to the product image in the PersonaClick image repository (type: string) price – product price (type: number) oldprice – product old price (type: string, default – 0) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) price_formatted – formatted product price including currency (type: string) brand – product vendor (type: string) is_new – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API)
products_total	number	The total number of products that match the search query.
search_query	string	The search query text.
categories	array	An array of objects with information about the categories matching the search query. Each object has the following properties: id – category ID (type: string) name – category name (type: string) url – category page link (type: string) parent – parent category ID (type: string) alias – wordy category identifier (type: string) If no links are specified for categories in the product feed, the API will return an empty array for this property.
queries	array	An array of objects with relevant popular queries. Each object has the following properties: name – relevant search query (type: string) url – link to a full search page (the format of the link is configured in the PersonaClick account)
html	string	Contains a rendered custom HTML template for the Instant Search widget, or null if the HTML template is empty or the default one is used.
search_query_redirects	object	The object will be available if a redirect is created for the search query: Account -> Search -> Search redirect The object contains the following properties: deep_link (type: string) query (type: string) redirect_link (type: string)

Example of use

sdk.suggest(query: "To be or not to be") { searchResult in
    // features showing instant search widget
}

Full Search

Method Objective

The method requests products that match the full search query and is used to display the search results.

Syntax and parameters

sdk.search(params) { callback }

Name	Type	Requirement	Description
params	enum	required	Request parameters. See the description below.
callback	function	required	Callback-function, where the API response will be passed to.

Request Parameters

Name	Requirement	Description
query	required	The search query text.
limit	optionally	The maximum number of products in the API response (by default - 10).
offset	optionally	The offset relative to the first product in the API response
brands	optionally	If used, the API response will return only the products of the listed vendors. The vendors must be listed in the product feed.
colors	optionally	If used, the API response will return the products of the listed colors. The colors of the product should be specified in the product feed.
fashionSizes	optionally	If used, the API response will return the products of the listed sizes. The sizes of the product should be specified in the product feed.
priceMin	optionally	Minimum product price in API response.
priceMax	optionally	Maximum product price in API response.
locations	optionally	Location IDs. If used, the API response will return products available in the listed locations.
categories	optionally	Category IDs. If used, the API response will return only those products that are in the specified categories.
sortBy	optionally	Sorting products in the API response. Available values: popular (by default) price discount (the difference between `oldprice` and `price` in the product feed) sales_rate date price_margin rating
sortDir	optionally	Sorting directions for the `sort_by` parameter. Available values: asc - ascending sorting desc - downwards sorting (by default)
filters	optionally	JSON object with additional request filters. See the example below.
brandLimit	optionally	How many brands for sidebar filter to return.
categoryLimit	optionally	How many categories for sidebar filter to return.
exclude	optionally	IDs of products to be excluded.
excludedBrands	optionally	Brands whose products need to be excluded from the API response.

API response

Name	Type	Description
categories	array	An array of objects with information about the categories matching the search query. Each object has the following properties: id – category ID (type: string) name – category name (type: string) url – category page link (type: string) parent – parent category ID (type: string) alias – wordy category identifier (type: string) If no links are specified for categories in the product feed, the API will return an empty array for this property.
products	Object Array	An array of objects with product information. Each object has the following properties: barcode – product barcode, if it was imported in the product catalog (type: string) brand – product vendor (type: string) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) id – product ID (type: string) isNew – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API) model – model and product name (type: string) name – product name (type: string) oldPrice – old price of the product with zeroed pennies (type: double) oldPriceFormatted – formatted integer old price of the product, including currency (type: string) oldPriceFull – old price of the product (type: double) oldPriceFullFormatted – formatted old price of the product, including currency (type: string) params – JSON of object array with pairs of "key" (type: string), "values" (type: array) properties. The data matches the values of the "param" parameter of the product feed/catalog (XML, HTTP API). picture – link to the product image in the PersonaClick image repository (type: string) price – current price of the product with zeroed pennies (type: double) priceFormatted – formatted integer current price of the product, including currency (type: string) priceFull – current price of the product (type: double) priceFullFormatted – formatted current price of the product, including currency (type: string) url – product page URL (type: string)
productsTotal	number	The total number of products that match the search query.
queries	array	An array of queries related to the search query.

Example of use

sdk.search(query: "To be or not to be", limit: 15, offset: 3, categoryLimit: 5, categories: ["1", "146", "100500"], extended: false, sortBy: "price", sortDir: "asc", locations: ["NY", "LA"], brands: ["Alas", "poor", "Yorick"], filters: ["bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]], priceMin: 1000, priceMax: 5000, colors: ["red", "yellow", "green"], exclude: ["100", "146", "231"]) { searchResult in
    // features showing full search widget
}

Blank Request

Method Objective

The method allows getting the user's recent search queries, as well as recommended suggestions and products for the user.

Syntax and parameters

sdk.searchBlank() { callback }

Name	Type	Requirement	Description
callback	function	required	Callback-function, where the API response will be passed to.

API response

Name	Type	Description
lastQueries	Query array	The user's most recent search queries. Each Query in the array contains the following properties: name – the search query url – the URL to the full search page with the matching search query
products	Product array	An array with product information. Each Product has the following properties: barcode – product barcode, if it was imported in the product catalog (type: string) brand – product vendor (type: string) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) deeplinkIos – product deep link for iOS (type: string) discount – the percentage difference between the old price and the current price (type: number) id – product ID (type: string) imageUrl – URL of the original product image (type: string) resizedImageUrl – link to the product image in the PersonaClick image repository (type: string) resizedImages – the object with the URLs of the resize product image. Available object keys matching the size of the image in pixels: 120, 140, 160, 180, 200, 220, 310, 520 (type: object) isNew – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API) model – model and product name (type: string) name – product name (type: string) oldPrice – integer old price of the product (type: number) oldPriceFormatted – formatted integer old price of the product, including currency (type: string) oldPriceFull – old price of the product (type: number) oldPriceFullFormatted – formatted old price of the product, including currency (type: string) params – object array with pairs of "key" (type: string), "values" (type: array) properties. The data matches the values of the "param" parameter of the product feed/catalog (XML, HTTP API). price – integer current price of the product (type: number) priceFormatted – formatted integer current price of the product, including currency (type: string) priceFull – current price of the product (type: number) priceFullFormatted – formatted current price of the product, including currency (type: string) relativeSalesRate – level of sales of current product ( in percentage) in relation to the maximum level of sales of products in the store (type: number) salesRate – level of product sales (absolute value) (type: number) url – product page URL (type: string)
lastProducts	boolean	If true, then the products property of the API response contains the products recently viewed by the user, otherwise, it contains the recommended products.
suggests	Suggest array	User-relevant suggestions. Each Suggest in the array contains the following properties: name – the search query url – the URL to the full search page with the matching search query

Example of use

sdk.searchBlank() { searchResult in
    // features showing blank search widget
}

Page Navigation

Related Pages

Page:

Search Engine (Android SDK - Java)
Page:

Search Engine (Android SDK - Kotlin)
Page:

Search Engine (iOS SDK)
Page:

Search Engine (JS SDK)
Page:

Search Engine (REST API)
Page:

Search Engine (RN SDK)

Browser not supported