Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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 | ||||
|---|---|---|---|---|
| ||||
sdk.suggest(params) { callback } |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | required | Request parameters. See the description below. | |
| callback | function | required | Callback-function, where the API response will be passed to. |
Request parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| query | string | required | The search query text. |
API response
| Name | Type | Description |
|---|
| categories | array |
- 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)
| HTML code of the widget with full search results. Widget template is customizable in PersonaClick account. | ||
| products | array | An array with data of products. |
| productsTotal | number | The total number of products that match the |
| search query |
| . |
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)
| Note |
|---|
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 |
- name – relevant search query (type: string)
- url – link to a full search page (the format of the link is configured in the PersonaClick account)
| queries related to the search query. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.suggest(query: "To be or not to be") { searchResult in
// 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
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.search(params) { callback } |
| Name | Type | Requirement | Description |
|---|---|---|---|
| params | enum | required | Request parameters. See the description below. |
| callback | function | required | Callback-function, where the API response will be passed to. |
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| query | string | required | The search query text. |
| limit | number | optionally | The maximum number of products in the API response. |
| offset | number | optionally | The offset relative to the first product in the API response |
| brands | Dictionary List | optionally | Dictionary List of brands. If used, the API response will return only the products of the listed vendors. The vendors must be listed in the product feed. |
| colors | Dictionary List | optionally | Dictionary List of 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. |
| priceMin | number | optionally | Minimum product price in API response. |
| priceMax | number | optionally | Maximum product price in API response. |
| locations | Dictionary List | optionally | Dictionary List of Location IDs. If used, the API response will return products available in the listed locations. |
| categories | Dictionary List | optionally | Dictionary List of Category IDs. If used, the API response will return only those products that are in the specified categories. |
| sortBy | string | optionally | Sorting products in the API response. Available values:
|
| sortDir | string | optionally | Sorting directions for the
|
| filters | string | optionally | JSON object with additional request filters. See the example below. |
| categoryLimit | number | optionally | How many categories for sidebar filter to return. |
| extended | boolean | optionally | Allows getting extended data in the API response. |
| exclude | Dictionary List | optionally | Dictionary List of IDs of products to be excluded. |
API response
| Name | Type | Description |
|---|---|---|
| categories | array | HTML code of the widget with full search results. Widget template is customizable in PersonaClick account. |
| products | array | An array with data of products. |
| productsTotal | number | The total number of products that match the search query. |
| queries | array | An array of queries related to the search query. |
Example of use
| Code Block | ||||
|---|---|---|---|---|
| ||||
sdk.search(query: "To be or not to be", limit: 15, offset: 3, categoryLimit: 5, categories: ["1", "146", "100500"], extended: false, sortBy: "price", sortDir: "asc", locations: ["NY", "LA"], brands: ["Alas", "poor", "Yorick"], filters: ["bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]], priceMin: 1000, priceMax: 5000, colors: ["red", "yellow", "green"], exclude: ["100", "146", "231"]) { searchResult in
// features showing full search widget
} |
| Table of Contents | ||||
|---|---|---|---|---|
|