Page Comparison

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

Code Block

language	java
theme	FadeToGrey

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

categories

products

array

HTML code of the widget with full search results. Widget template is customizable in PersonaClick account.productsarrayAn array with data of products.productsTotal

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

queries related to the search query.

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)
status	string	This property will be available in case of an error and will contain the "error" value.
message	string	The text of the error if it occurred

Example of use

Code Block

language	java
theme	FadeToGrey

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

Code Block

language	java
theme	FadeToGrey

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	Type	Requirement	Description
query	string	required	The search query text.
limit	number	optionally	The maximum number of products in the API response.
offset	number	optionally	The offset relative to the first product in the API response
brands	Dictionary List	optionally	Dictionary List of brands. If used, the API response will return only the products of the listed vendors. The vendors must be listed in the product feed.
colors	Dictionary List	optionally	Dictionary List of colors. 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.
priceMin	number	optionally	Minimum product price in API response.
priceMax	number	optionally	Maximum product price in API response.
locations	Dictionary List	optionally	Dictionary List of Location IDs. If used, the API response will return products available in the listed locations.
categories	Dictionary List	optionally	Dictionary List of Category IDs. If used, the API response will return only those products that are in the specified categories.
sortBy	string	optionally	Sorting products in the API response. Available values: popular - sorting products by popularity (by default) price - sorting by product price discount - sorting by discount (the difference between `oldprice` and `price` in the product feed)
sortDir	string	optionally	Sorting directions for the `sort_by` parameter. Available values: asc - ascending sorting desc - downwards sorting (by default)
filters	string	optionally	JSON object with additional request filters. See the example below.
categoryLimit	number	optionally	How many categories for sidebar filter to return.
exclude	Dictionary List	optionally	Dictionary List of IDs of products to be excluded.

API response

Name	Type	Description
categories	array	HTML code of the widget with full search results. Widget template is customizable in PersonaClick account.
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

Code Block

language	java
theme	FadeToGrey

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
}

Column

Page Navigation

Table of Contents

maxLevel	2
indent	0px
style	none

Related Pages

Filter by label (Content by label)

showLabels	false
showSpace	false
sort	title
cql	label = "searchengine"

Versions Compared

Old Version 11

New Version 12

Key

Instant Search

Method Objective

Syntax and parameters

Request parameters

API response

Example of use

Full Search

Method Objective

Syntax and parameters

Request Parameters

API response

Example of use