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

PersonaClick.search(search_query, type, params, callback);

Name	Type	Requirement	Description
search_query	string	required	The search query text.
type	enum	required	Search Type. See the example below.
params	enum	required	Request parameters. See the description below.
success	function	required	Callback-function, where the API response will be passed to.

Request parameters

Name	Type	Requirement	Description
LOCATIONS	string	optionally	String with location IDs separated by comma. If used, the API response will return products available in the listed locations.

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

SearchParams params = new SearchParams();
params.put(SearchParams.Parameter.LOCATIONS, "NY,LA");
PersonaClick.search("To be or not to be", SearchParams.TYPE.INSTANT, params, new Api.OnApiCallbackListener() {
    @Override
    public void onSuccess(JSONObject response) {
        // 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.

Note
Note that the Full Search tool can be integrated by placing a configured DIV on the search page. The DIV will be filled with products matching the search query automatically. You can find the DIV in the Search Section of the PersonaClick account.

Syntax and parameters

Code Block

theme	FadeToGrey

personaclickPersonaClick.search("search"_query, paramstype, successparams, errorcallback);

Name	Type	Requirement	Description
search_query	string	required	The search query text.
type	enum	required	Search Type. See the example below.
params

object

enum

required

Object with request parameters

Request parameters. See the description below.
success	function	required	Callback-function, where the API response will be passed to.

Response type: object.errorfunctionoptionallyCallback-function to be called when an error occurs (any HTTP status code other than 200).

Request Parameters

Name	Type	Requirement	Description
search_queryLIMIT	string	required	The search query text.	limit	number	optionally	The maximum number of products in the API response.
pagePAGE	numberstring	optionally	Page number (first page - 1, by default - 1).
offsetBRANDS	numberstring	optionally	The offset relative to the first product in the API response (similar to: *(page - 1) limit and when used simultaneously with page** is a priority, by default - 0).	brands	array	optionally	An array of vendor names. If String with vendor names separated by comma. If used, the API response will return only the products of the listed vendors. The vendors must be listed in the product feed.
colorsCOLORS	arraystring	optionally	An array of product colors. If String with color names separated by comma. 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.
pricePRICE_minMIN	numberstring	optionally	Minimum product price in API response.
pricePRICE_maxMAX	numberstring	optionally	Maximum product price in API response.
categoriesLOCATIONS	arraystring	optionally	An array of category IDsString with location IDs separated by comma. If used, the API response will return only those products that are available in the specified categorieslisted locations.
category_namesCATEGORIES	numberstring	optionally	Using the category names in the search. If String with category IDs separated by comma. If used, the API response will respond with products from categories whose names intersect with the search query. These products will get the lowest priority and will be at the very end of the response. By default - 1.sort_byreturn only those products that are in the specified categories.
SORT_BY	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)
orderSORT_DIR	string	optionally	Sorting directions for the `sort_by` parameter. Available values: asc - ascending sorting desc - downwards sorting (by default)
FILTERS	string	optionally	Additional request filters. See the example below.

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	js
theme	FadeToGrey

personaclick("search", {search_query: "To be or not to be", page: 2, limit: 15, brands: ["Alas", "poor", "Yorick"], categories: [1, 146, 100500], sort_by: "price", order: "asc"}, function(response) {
  // features showing full search widget
}, function(error) {
  // when something went wrongSearchParams 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) {
        // features showing full search widget
    }
});

Table of Contents

maxLevel	2
class	personaclick-fixed-position

Versions Compared

Old Version 3

New Version 4

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