| recommender_code | string | required | Unique code of the recommendation block. See this value in the "data-recommender-code" attribute of the block created in PersonaClick account. The parameter builds the endpoint for the recommendation request. |
| 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. |
| segment | string | optionally | Can take one of the values: "A" or "B" according to the segment to which the user is assigned. You can use your algorithm to divide users evenly between the segments. |
| item | number/string | required in some cases | Product ID. This This parameter is mandatory for the requests of blocks with algorithms that use the algorithms "Similar" and "Also bought"depend on the current product. Algorithms: "Similar", "Products usually purchased with this product", "Store recommendations", etc. |
| exclude | string | optionally | Product IDs (splitted by comma), which should be excluded from the recommended products list. |
| category | number/string | required in some cases | Category ID. This parameter is mandatory for all blocks set on category pages. |
| search_query | string | required in some cases | The text of the search query. This parameter is mandatory for the requests of blocks that use the "Search" algorithm. |
| limit | number | optionally | A maximum number of products in the API response. |
| locations | string | optionally | Location IDs, splitted by comma. If used, the API response will return products available in the listed locations. |
| brands | string | optionally | Brand names, splitted by comma. If used, only the products of the listed brands will be returned in the API response. |
| exclude_brands | string | optionally | Brand names, splitted by comma. If used, the API response will exclude the products of the listed brands. |
| categories | string | optionally | Category IDs, splitted by comma. If used, the API response will only return products that are included in the listed categories. |
| discount | boolean | optionally | If used with "true" value, then only those products, the value of which is less than the "oldprice" value, will be returned in the API response. |
| resize_image | number | optionally | Product Image Size. Available values (px): 120, 140, 160, 180, 200, 220. The default is the original size. |
| extended | number | optionally | If it's set to 1 value, the API will return extended product information in the recommends property. Otherwise, only product IDs will be returned. |
| prevent_shuffle | boolean | optionally | If set to true value this will disable product shuffling in the API response. |
| page | number | optionally | Used when pagination is needed. The API returns products of the specified page and limit (limit is set in the block's settings in the account or as an additional parameter in the request). |