Highest Discounted Products
- 07 Feb 2024
- 1 Minute to read
Highest Discounted Products
- Updated on 07 Feb 2024
- 1 Minute to read
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
This algorithm recommends items by sorting items regarding their discount ratio. It recommends products in order regarding their discount ratios. When the original price and discounted price are received, the discount ratio for each product is calculated. Recommended products will be sorted from the highest discount to the lowest 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 which is assigned by Insider. You can use PartnerID as well. | String | Yes |
| locale | us_US | Locale of 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. | String | No |
| 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 response. | Boolean | No |
Your title goes here
If you want to get top sellers products from category or categories you want, you should specify either categoryList or category and subCategory.
Sample Example
Sample Request
GET 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 come from Highest Discounted Products are not enough to fill the response data, some fallback algorithms below fill it:
- Highest discounted products of category without excluding right most item in the categoryList
Was this article helpful?