Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

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

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

NameTypeRequirementDescription
search_querystringrequiredThe search query text.
typeenumrequiredSearch Type. See the example below.
paramsenumrequiredRequest parameters. See the description below.
callbackfunctionrequiredCallback-function, where the API response will be passed to. 

Request parameters

NameTypeRequirementDescription
LOCATIONSstringoptionallyString with location IDs separated by comma. If used, the API response will return products available in the listed locations.

API response

NameTypeDescription
productsarrayAn 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_totalnumberThe total number of products that match the search query.
search_querystringThe search query text.
categoriesarray

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.

queriesarrayAn 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_authorsarrayReserved.
collectionsarrayReserved.
keywordsarrayReserved.
virtual_categoriesarrayReserved.

Example of use

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.

Syntax and parameters

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

NameTypeRequirementDescription
search_querystringrequiredThe search query text.
typeenumrequiredSearch Type. See the example below.
paramsenumrequiredRequest parameters. See the description below.
callbackfunctionrequiredCallback-function, where the API response will be passed to. 

Request Parameters

NameTypeRequirementDescription
LIMITstringoptionallyThe maximum number of products in the API response.
PAGEstringoptionallyPage number (first page - 1, by default - 1).
BRANDSstringoptionallyString 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.
COLORSstringoptionallyString 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.
PRICE_MINstringoptionallyMinimum product price in API response.
PRICE_MAXstringoptionallyMaximum product price in API response.
LOCATIONSstringoptionallyString with location IDs separated by comma. If used, the API response will return products available in the listed locations.
CATEGORIESstringoptionallyString with category IDs separated by comma. If used, the API response will return only those products that are in the specified categories.
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)
SORT_DIRstringoptionally

Sorting directions for the sort_by parameter.
Available values:

  • asc - ascending sorting
  • desc - downwards sorting (by default)
FILTERSstringoptionallyAdditional request filters. See the example below.

API response

NameTypeDescription
htmlstringHTML 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. The value will be available only if using the "extended" parameter in the API request (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). The value will be available only if using the "extended" parameter in the API request.
  • 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.
book_authorsarrayReserved.
categoriesarrayReserved.
collectionsarrayReserved.
keywordsarrayReserved.
queriesarrayReserved.
virtual_categoriesarrayReserved.

Example of use

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

PersonaClick.search_blank(callback);

NameTypeRequirementDescription
callbackfunctionrequiredCallback-function, where the API response will be passed to. 

API response

NameTypeDescription
productsarrayAn 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)
suggestsarray
Search query suggestions.
last_queriesarrayAn 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_productsbooleanReserved for the JS SDK internal use.

Example of use

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

Page Navigation



Related Pages

  • No labels

Copyright 2018-2024 PersonaClick