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.

Request

Endpoint	Request Type
https://api.personaclick.com/search	GET

Parameters

Name	Type	Requirement	Description
shop_id	string	required	Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
did	string	required	Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
seance	string	required	Unique ID of the current user session. See "Initialization (REST API)" for information about getting and using User Session ID.
type	string	required	Search Type. Should be set to "instant_search" in this case. See the example below.
search_query	string	required	The text of the search query.
collapse	boolean	optionally	Allows disabling grouping of products by "group_id". This param's "false" value enables the API to return products regardless of a group. The "true" value is only one product of a group. The default value is "true".

API Response Code

HTTP status code	Description
200 OK	The request was successful.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

Name	Type	Description
products	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) categories – an Object array with details of the product category hierarchy, where each object has properties: "id" – category ID (type: string) "level" – сategory level in the hierarchy (type: string) "name" – category name (type: string) "name_with_parent" – string name from the name of the parent and main product categories, separated by a "-" (type: string) "parent_id" – parent category ID (type: string) "url" – category page url (type: string) category_ids – an array of IDs of the product category hierarchy (type: String array) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) discount – the percentage difference between the old price and the current price (type: number) discount_formatted – the percentage difference between the old and the current price that is formatted as a string with the "%" symbol (type: string) discount_percent – user-defined discount value (type: number) gift – specifies whether the product is a gift (type: boolean) group_id – product group ID (type: string) installment – the payment cost if purchasing the product in installments (type: number) id – product ID (type: string) image_url – URL of the original product image (type: string) image_url_handle – relative URL of the original product image (type: string) image_url_resized – 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) is_new – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API) leftovers – rough number of the products left in stock. Available values are: "one" - one product "few" - 2-10 products "lot" - over 10 products model – model and product name (type: string) name – product name (type: string) oldprice – integer old price of the product (type: number) oldprice_formatted – formatted integer old price of the product, including currency (type: string) oldprice_full – old price of the product (type: number) oldprice_full_formatted – 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). picture – link to the product image in the PersonaClick image repository (type: string) price – integer current price of the product (type: number) price_formatted – formatted integer current price of the product, including currency (type: string) price_full – current price of the product (type: number) price_full_formatted – formatted current price of the product, including currency (type: string) price_with_promocode – the product price when using the promo code specified for the product (type: number) price_with_promocode_formatted – formatted product price when using the promo code specified for the product, including currency (type: string) promocode – the promo code is for a specific product (type: string) rating – product rating (type: number) relative_sales_rate – level of sales of current product ( in percentage) in relation to the maximum level of sales of products in the store (type: number) sales_rate – level of product sales (absolute value) (type: number) url – product page URL (type: string) url_handle - relative product page URL (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) 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)
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

Request Example

curl https://api.personaclick.com/search?shop_id=0d42fd8b713d0752776ca589cc0056&did=iVxRcAaGzA&type=instant_search&search_query=To%20be%20or%20not%20to%20be

Full Search

Method Objective

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

Request

Endpoint	Request Type
https://api.personaclick.com/search	GET

Parameters

See the example below.

Name	Type	Requirement	Description
shop_id	string	required	Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
did	string	required	Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.
seance	string	required	Unique ID of the current user session. See "Initialization (REST API)" for information about getting and using User Session ID.
type	string	required	Search Type. Should be set to "full_search" in this case. See the example below.
search_query	string	required	The search query text.
limit	number	optionally	The maximum number of products in the API response (by default: 10).
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	string	optionally	Comma-separated 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	string	optionally	Comma-separated 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.
fashion_sizes	string	optionally	Comma-separated product fashion sizes. 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.
price_min	number	optionally	Minimum product price in API response.
price_max	number	optionally	Maximum product price in API response.
categories	string	optionally	Comma-separated category IDs. If used, the API response will return only those products that are in the specified categories.
category_names	boolean	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. By default: true.
sort_by	string	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
order	string	optionally	Sorting directions for the `sort_by` parameter. Available values: asc - ascending sorting desc - downwards sorting (by default)
category_limit	number	optionally	The maximum number of categories in the API response matching the search query. By default: 1000.
brand_limit	number	optionally	The maximum number of brands in the API response mathching the search query. By default: 1000.
extended	number	optionally	If the value is 1, the API will return additional product properties in the response: barcode, categories, param. See the descriptions below.
locations	string	optionally	Comma-separated location IDs. If used, the API will return only products available in the specified locations. Locations must be specified in the imported product catalog (XML, HTTP API).
filters	string	optionally	JSON string with the properties and their values that the products should match in the API response. The data matches the values of the "param" parameter of the product feed/catalog (XML, HTTP API). Format: {"property1":["value1","value2"],"property2":["value1","value2"]}
exclude	string	optionally	Comma-separated products IDs to exclude from search results.
input_query	string	optionally	The search query was entered by the user as is - before using the suggestions.
collapse	boolean	optionally	Allows disabling grouping of products by "group_id". This param's "false" value enables the API to return products regardless of a group. The "true" value is only one product of a group. The default value is "true".

API Response Code

HTTP status code	Description
200 OK	The request was successful.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

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: barcode – product barcode, if it was imported in the product catalog (type: string) brand – product vendor (type: string) categories – an Object array with details of the product category hierarchy, where each object has properties: "id" – category ID (type: string) "level" – сategory level in the hierarchy (type: string) "name" – category name (type: string) "name_with_parent" – string name from the name of the parent and main product categories, separated by a "-" (type: string) "parent_id" – parent category ID (type: string) "url" – category page url (type: string) category_ids – an array of IDs of the product category hierarchy (type: String array) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) discount – the percentage difference between the old price and the current price (type: number) discount_formatted – the percentage difference between the old and the current price that is formatted as a string with the "%" symbol (type: string) discount_percent – user-defined discount value (type: number) gift – specifies whether the product is a gift (type: boolean) group_id – product group ID (type: string) installment – the payment cost if purchasing the product in installments (type: number) id – product ID (type: string) image_url – URL of the original product image (type: string) image_url_handle – relative URL of the original product image (type: string) image_url_resized – 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) is_new – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API) leftovers – rough number of the products left in stock. Available values are: "one" - one product "few" - 2-10 products "lot" - over 10 products model – model and product name (type: string) name – product name (type: string) oldprice – integer old price of the product (type: number) oldprice_formatted – formatted integer old price of the product, including currency (type: string) oldprice_full – old price of the product (type: number) oldprice_full_formatted – 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). picture – link to the product image in the PersonaClick image repository (type: string) price – integer current price of the product (type: number) price_formatted – formatted integer current price of the product, including currency (type: string) price_full – current price of the product (type: number) price_full_formatted – formatted current price of the product, including currency (type: string) price_with_promocode – the product price when using the promo code specified for the product (type: number) price_with_promocode_formatted – formatted product price when using the promo code specified for the product, including currency (type: string) promocode – the promo code is for a specific product (type: string) rating – product rating (type: number) relative_sales_rate – level of sales of current product ( in percentage) in relation to the maximum level of sales of products in the store (type: number) sales_rate – level of product sales (absolute value) (type: number) url – product page URL (type: string) url_handle - relative product page URL (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.
brands	Object array	Object array, each containing the name property with the vendor name in the value.
categories	Object 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.
filters	Object	JSON string with properties and their values of all API response products. The data matches the values of the "param" parameter of the product feed/catalog (XML, HTTP API). Format: {"property1":["value1","value2"],"property2":["value1","value2"]}
popup	Object	Reserved for the JS SDK internal use
price_range	Object	The object containing the values of the minimum and maximum price of the products in the API response. Available properties: min - minimum price max - maximum price
price_ranges	Object array	The array contains objects with price ranges and the number of products that match the range. Available properties: from - minimum price of the range (doesn't exist for the first range, type: number) to - maximum price of the range (doesn't exist for the last range, type: number) count - number of products that match the range (type: number)
queries	array	Reserved.

Request Example

curl https://api.personaclick.com/search?shop_id=0d42fd8b713d0752776ca589cc0056&did=iVxRcAaGzA&type=full_search&seance=QL9Pr0JTYu&search_query=To%20be%20or%20not%20to%20be&input_query=To%20be%20or&limit=20&page=1&filters=%7B%22Alas%22%3A%5B%22poor%22%2C%22Yorick%22%5D%2C%22William%22%3A%5B%22Shakespeare%22%5D%7D

Blank Request

Method Objective

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

Request

Endpoint	Request Type
https://api.personaclick.com/search/blank	GET

Parameters

Name	Type	Requirement	Description
shop_id	string	required	Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
did	string	required	Unique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.

API Response Code

HTTP status code	Description
200 OK	The request was successful.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

Name	Type	Description
last_queries	Object array	The user's most recent search queries. Each object 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	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) categories – an Object array with details of the product category hierarchy, where each object has properties: "id" – category ID (type: string) "level" – сategory level in the hierarchy (type: string) "name" – category name (type: string) "name_with_parent" – string name from the name of the parent and main product categories, separated by a "-" (type: string) "parent_id" – parent category ID (type: string) "url" – category page url (type: string) category_ids – an array of IDs of the product category hierarchy (type: String array) currency – product currency (type: string, matches the currency of the PersonaClick account, or the user value set in the settings of the PersonaClick account) discount – the percentage difference between the old price and the current price (type: number) discount_formatted – the percentage difference between the old and the current price that is formatted as a string with the "%" symbol (type: string) discount_percent – user-defined discount value (type: number) gift – specifies whether the product is a gift (type: boolean) group_id – product group ID (type: string) installment – the payment cost if purchasing the product in installments (type: number) id – product ID (type: string) image_url – URL of the original product image (type: string) image_url_handle – relative URL of the original product image (type: string) image_url_resized – 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) is_new – new arrival product (type: boolean). See the parameter in the product catalog import (XML, HTTP API) leftovers – rough number of the products left in stock. Available values are: "one" - one product "few" - 2-10 products "lot" - over 10 products model – model and product name (type: string) name – product name (type: string) oldprice – integer old price of the product (type: number) oldprice_formatted – formatted integer old price of the product, including currency (type: string) oldprice_full – old price of the product (type: number) oldprice_full_formatted – 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). picture – link to the product image in the PersonaClick image repository (type: string) price – integer current price of the product (type: number) price_formatted – formatted integer current price of the product, including currency (type: string) price_full – current price of the product (type: number) price_full_formatted – formatted current price of the product, including currency (type: string) price_with_promocode – the product price when using the promo code specified for the product (type: number) price_with_promocode_formatted – formatted product price when using the promo code specified for the product, including currency (type: string) promocode – the promo code is for a specific product (type: string) rating – product rating (type: number) relative_sales_rate – level of sales of current product ( in percentage) in relation to the maximum level of sales of products in the store (type: number) sales_rate – level of product sales (absolute value) (type: number) url – product page URL (type: string) url_handle - relative product page URL (type: string)
last_products	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	Object array	User-relevant suggestions. Each object in the array contains the following properties: name – the search query url – the URL to the full search page with the matching search query

Request Example

curl https://api.personaclick.com/search/blank?shop_id=0d42fd8b713d0752776ca589cc0056&did=iVxRcAaGzA

Resultless Search Queries

Method Objective

The method allows getting a list of no result search queries, as well as the number of such queries for the last 2 weeks.

Request

Endpoint	Request Type
https://api.personaclick.com/search/no_result_queries	GET

Parameters

Name	Type	Requirement	Description
shop_id	string	required	Unique Store Key in PersonaClick. Located there: Account > Settings > Store Settings
shop_secret	string	required	Store Secret Key in PersonaClick. Located there: Account > Settings > Store Settings

API Response Code

HTTP status code	Description
200 OK	The request was successful.
403 Forbidden	Authentication failed.
404 Not Found	There are no mandatory parameters in the request.

API Response Data

The API returns an array of objects, each containing the following properties:

Name	Type	Description
query	string	Search Query
quantity	number	The number of search queries in the last 2 weeks.

Request Example

curl https://api.personaclick.com/search/no_result_queries?shop_id=0d42fd8b713d0752776ca589cc0056&shop_secret=0123456789abcdef0123456789abcdef

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