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

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)
old_price – 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)

products_total

number

The total number of products that match the search query.

search_query

string

The search query text.

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

PersonaClicksdk.search(search_query, type, params, callback);params) { callback }

Search Type. See the example below.

Name	Type	Requirement	Description
search_query	string	required	The search query text.
type	enum	required
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

LIMIT

query	string	required	The search query text.
limit	number	optionally	The maximum number of products in the API response.

PAGE

offset

string

number

optionally

Page number (first page - 1, by default - 1).BRANDSstringoptionallyString with vendor names separated by comma

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

colors

string

Dictionary List

optionally

String with color names separated by comma

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.

PRICE_MIN

priceMin

string

number

optionally

Minimum product price in API response.

PRICE_MAX

priceMax

string

number

optionally

Maximum product price in API response.

LOCATIONS

locations

string

Dictionary List

optionally

String with location IDs separated by comma

Dictionary List of Location IDs. If used, the API response will return products available in the listed locations.

API response

Name	Type	Description
html	string	HTML code of the widget with full search results. Widget template is customizable in PersonaClick account.
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) old_price – product old price (type: string, by 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)
products_total	number	The total number of products that match the search query. The following query parameters do not affect this value: page, limit, and offset.
search_query	string	The search query text.
book_authors	array	Reserved.
categories	array	Reserved.
collections	array	Reserved.
keywords	array	Reserved.
queries	array	Reserved.
virtual_categories	array	Reserved.

Example of use

Code Block

language	java
theme	FadeToGrey

SearchParams params = new SearchParams();
params.put(SearchParams.Parameter.PAGE, "2");
params.put(SearchParams.Parameter.LIMIT, "15");
params.put(SearchParams.Parameter.BRANDS, "Alas,poor,Yorick");
params.put(SearchParams.Parameter.CATEGORIES, "1,146,100500");
params.put(SearchParams.Parameter.SORT_BY, "price");
params.put(SearchParams.Parameter.SORT_DIR, "asc");
params.put(SearchParams.Parameter.LOCATIONS, "NY,LA");
SearchParams.SearchFilters filters = new SearchParams.SearchFilters();
filters.put("weight", new String[] {"11.1", "14.8"});
params.put(SearchParams.Parameter.FILTERS, filters);
PersonaClick.search("To be or not to be", SearchParams.TYPE.FULL, params, new Api.OnApiCallbackListener() {
    @Override
    public void onSuccess(JSONObject response) {
   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 last search queries, last viewed or recommended products.

Syntax and parameters

Code Block

language	java
theme	FadeToGrey

PersonaClick.search_blank(callback);

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

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) old_price – 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)
suggests	array	Search query suggestions.
last_queries	array	An array of objects with last user's queries. Each object has the following properties: name – search query (type: string) url – link to a full search page (the format of the link is configured in the PersonaClick account)
last_products	boolean	Reserved for the JS SDK internal use.

Example of use

Code Block

language	java
theme	FadeToGrey

PersonaClick.search_blank(new Api.OnApiCallbackListener() {
    @Override
    public void onSuccess(JSONObject response) {
        // features showing search widget
    }
});

Table of Contents

maxLevel	2
class	personaclick-fixed-position

Versions Compared

Old Version 2

New Version 3

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

Blank Request

Method Objective

Syntax and parameters

API response

Example of use