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.

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

filtersObject

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:

Code Block
{"property1":["value1","value2"],"property2":["value1","value2"]}

popupObjectReserved for the JS SDK internal useprice_rangeObject

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

queriesarrayReserved.

Request Example

Code Block

language	bash
theme	FadeToGrey

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

EndpointRequest Typehttps://api.personaclick.com/search/blankGET

Parameters

Name

TypeRequirement

Description

shop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store SettingsdidstringrequiredUnique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.

API Response Code

HTTP status code

Description200 OK

The request was successful.

404 Not FoundThere are no mandatory parameters in the request.

API Response Data

NameTypeDescriptionlast_queriesObject 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

productsObject arrayAn 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

Name

Type

Description

products

array

An array of objects with product information. Each object has the following properties:

id – product ID

barcode – product barcode, if it was imported in the product catalog (type: string)

name

brand – product

name

vendor (type: string)

url – product page link

categories – an Object array with details of the product category hierarchy, where each object has properties:
"id" – category ID (type: string)

picture – link to the product image

"level" – сategory level in the

PersonaClick image repository

hierarchy (type: string)

price – product price

"name" – category name (type:

number

string)

old_price – product old price

"name_with_parent" – string name from the name of the parent and main product categories, separated by a "-" (type: string

, default – 0

)

currency – product currency (type: string, matches the currency of the PersonaClick account

"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

PersonaClick account)

price_formatted – formatted product price including currency

discount – the percentage difference between the old price and the current price (type:

string

number)

brand – product vendor

discount_formatted – the percentage difference between the old and the current price that is formatted as a string with the "%" symbol (type: string)

is

discount_

new – new arrival product

percent – user-defined discount value (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.

Request Example

Code Block

language	bash
theme	FadeToGrey

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

EndpointRequest Typehttps://api.personaclick.com/searchGET

Parameters

See the example below.

NameTypeRequirementDescriptionshop_idstringrequiredUnique Store Key in PersonaClick. Located there: Account > Settings > Store SettingsdidstringrequiredUnique Device ID. See "Initialization (REST API)" for information about getting and using Device ID.seancestringrequiredUnique ID of the current user session. See "Initialization (REST API)" for information about getting and using User Session ID.typestringrequiredSearch Type. Should be set to "full_search" in this case. See the example below.search_querystringrequiredThe search query text.limitnumberoptionallyThe maximum number of products in the API response.pagenumberoptionallyPage number (first page - 1, by default - 1).offsetnumberoptionallyThe 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).brandsstringoptionallyComma-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.colorsstringoptionallyComma-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.price_minnumberoptionallyMinimum product price in API response.price_maxnumberoptionallyMaximum product price in API response.categoriesstringoptionallyComma-separated category IDs. If used, the API response will return only those products that are in the specified categories.category_namesnumberoptionallyUsing 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_bystringoptionallySorting 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)

orderstringoptionally

Sorting directions for the sort_by parameter.
Available values:

asc - ascending sorting
desc - downwards sorting (by default)

category_limitnumberoptionallyThe maximum number of categories in the API response matching the search query.extendednumberoptionally

If the value is 1, the API will return additional product properties in the response: barcode, categories, param. See the descriptions below.

locationsstringoptionallyComma-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).filtersstringoptionally

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:

Code Block
{"property1":["value1","value2"],"property2":["value1","value2"]}

excludestringoptionallyComma-separated products IDs to exclude from search results.input_querystringoptionallyThe search query was entered by the user as is - before using the suggestions.

API Response Code

HTTP status code

Description200 OK

The request was successful.

404 Not FoundThere are no mandatory parameters in the request.

API Response Dara

NameTypeDescriptionhtmlstringHTML code of the widget with full search results. Widget template is customizable in PersonaClick account.productsarray

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)
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)
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_totalnumberThe total number of products that match the search query. The following query parameters do not affect this value: page, limit, and offset.search_querystringThe search query text.brandsObject arrayObject array, each containing the name property with the vendor name in the value.categoriesObject 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)

Note
If no links are specified for categories in the product feed, the API will return an empty array for this property.

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.

Request Example

Code Block

language	bash
theme	FadeToGrey

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

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:

Code Block
{"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.

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.

Request Example

Code Block

language	bash
theme	FadeToGrey

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

Code Block

language	bash
theme	FadeToGrey

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

Code Block

language	bash
theme	FadeToGrey

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

Column

Page Navigation

Table of Contents

maxLevel	1
indent	0px
style	none

Related Pages

Filter by label (Content by label)

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

Page Comparison

Versions Compared

Old Version 21

New Version Current

Key

Instant Search

Method Objective

Request

Parameters

API Response Code

API Response Data

Request Example

Blank Request

Method Objective

Request

Parameters

API Response Code

API Response Data

Request Example

Full Search

Method Objective

Request

Parameters

API Response Code

API Response Dara

Request Example

Full Search

Method Objective

Request

Parameters

API Response Code

API Response Data

Request Example

Blank Request

Method Objective

Request

Parameters

API Response Code

API Response Data

Request Example

Resultless Search Queries

Method Objective

Request

Parameters

API Response Code

API Response Data

Request Example