Search Engine (RN SDK)

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

pcsdk.search(params).then(success).catch(error)

Name	Type	Requirement	Description
params	object	required	Object with request parameters.
success	function	required	Callback-function, where the API response will be passed to. Response type: object.
error	function	optionally	Callback-function to be called when an error occurs (any HTTP status code other than 200).

Request parameters

Name	Type	Requirement	Description
type	string	required	The value should always be "instant_search".
search_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.
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) 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)
book_authors	array	Reserved.
collections	array	Reserved.
keywords	array	Reserved.
virtual_categories	array	Reserved.

Example of use

pcsdk.search({type: "instant_search", search_query: "To be or not to be"})
    .then((response) => {
        // features showing instant search widget
    })
    .catch((error) => {
        // when something went wrong
    });

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

pcsdk.search(params).then(success).catch(error)

Name	Type	Requirement	Description
params	object	required	Object with request parameters.
success	function	required	Callback-function, where the API response will be passed to. Response type: object.
error	function	optionally	Callback-function to be called when an error occurs (any HTTP status code other than 200).

Request Parameters

Name	Type	Requirement	Description
type	string	required	The value should always be "full_search".
search_query	string	required	The search query text.
limit	number	optionally	The maximum number of products in the API response.
page	number	optionally	Page number (first page - 1, by default - 1).
offset	number	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 used, the API response will return only the products of the listed vendors. The vendors must be listed in the product feed.
colors	array	optionally	An array of product 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	number	optionally	Minimum product price in API response.
price_max	number	optionally	Maximum product price in API response.
categories	array	optionally	An array of category IDs. If used, the API response will return only those products that are in the specified categories.
category_names	number	optionally	Using the category names in the search. If used, the API 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_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)
order	string	optionally	Sorting directions for the `sort_by` parameter. Available values: asc - ascending sorting desc - downwards sorting (by default)

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

pcsdk.search({
    type: "full_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"
})
    .then((response) => {
        // features showing full search
    })
    .catch((error) => {
        // when something went wrong
    });