The Highest Discounted Products algorithm recommends products based on their discount ratios, prioritizing those with higher discounts. It calculates the discount ratio for each product using the original and discounted prices. Recommended products will be sorted from highest to lowest discount for the given size. For each currency type, the discount ratio is calculated separately. This type of algorithm works best on main and category pages.
Endpoint
GET https://recommendation.api.useinsider.com/v2/highest-discounted
Query Parameters
Parameter | Sample Value | Description | Data Type | Required |
|---|---|---|---|---|
partnerName | mybrand | Partner Identifier assigned by Insider One. You can use PartnerID as well. | String | Yes |
locale | us_US | Locale of the requested product catalog | String | Yes |
platform | web | Requested platform. Web comes by default. | Enum | No |
currency | USD | Requested currency of the products. If no value is set, the default currency in your settings is used. | String | Yes |
userId | a1b2c3d4 | User identifier which is assigned by Insider One | String | No |
hp | false, true, or 1, 0 | Makes affinities affect products of the response. The default is false. | Boolean | No (Can only be used with userId) |
size | 50 | Required number of items in response. Valid values are 0 to 100. | Integer | No |
categoryList | [“Clothes”, “Skirts”] | Category filter of the products | Array (of string) | No |
filter | Smart Recommender filtering. There can be more than one filter parameter. | String | No | |
details | true | Adds details to the products of the response | Boolean | No |
shuffle | false | Shuffles the products of the response | Boolean | No |
getGroupProducts | false | Shows variant products under the products of the response | Boolean | No |
groupProductsFields | Adds these fields to the variant products’ details | String | No | |
excludeVariants | true | Exclude variants from the response | Boolean | No |
excludeViewDay | 30 | After how many days viewed products should be excluded. The default is -1. | Integer | No (Can only be used with userId) |
excludeViewItem | 10 | How many viewed products should be excluded. The default is -1. | Integer | No (Can only be used with userId) |
excludePurchaseDay | 30 | After how many days purchased products should be excluded. The default is -1. | Integer | No (Can only be used with userId) |
excludePurchaseItem | 10 | How many purchased products should be excluded. The default is -1. | Integer | No (Can only be used with userId) |
productId | ABC123CBA | Current product ID | String | No |
If you want to get top sellers products from the category or categories you want, specify either categoryList or category and subCategory.
Sample Request
The sample below displays a request for the Highest Discounted Products; the algorithm recommends products based on their discount ratios, prioritizing those with higher discounts.
https://recommendation.api.useinsider.com/v2/highest-discounted?partnerName={Partner Name}&locale={Locale}&size=5¤cy={Currency}Sample Response
{
"success": true,
"total": 5,
"types": {
"hdop": 5
},
"data": [
"AB76543",
"AB54321",
"YZ76543",
"AB49876",
"AB01234"
]
}Fallback Algorithms
If the products from the Highest Discounted Products are not enough to fill the response data, some fallback algorithms below fill it:
Highest discounted products of the category without excluding the right-most item in the categoryList