Substitute Products
- 07 Feb 2024
- 1 Minute to read
Substitute Products
- Updated on 07 Feb 2024
- 1 Minute to read
Article Summary
Share feedback
Thanks for sharing your feedback!
Overview
This algorithm is a different approach on Collaborative Filtering Algorithms which has considered similarity of products. It recommends products that are similar and helps the product discovery process. It considers product similarity and price proximity. This type of algorithm works best on product pages and cart pages.
Endpoint
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 |
| 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 |
Sample Example
Sample Request
GET https://recommendation.api.useinsider.com/v2/substitute?partnerName={PartnerName}&locale={Locale}¤cy={Currency}&price=100&size=5
Sample Response
{
"success": true,
"total": 5,
"types": {
"sp": 5
},
"data": [
"ABC-123654",
"ABC-123321",
"ABC-123789",
"ABC-123987",
"ABC-123456"
]
}Fallback Algorithms
If the products come from Substitute Products are not enough to fill the response data, some fallback algorithms below fill it:
- Viewed Together
- Most Viewed Of Category
Was this article helpful?