The Substitute Products algorithm provides users with suggestions for products that can serve as replacements for items they have interacted with. The goal is to enhance user satisfaction and engagement by presenting products that align with their functional preferences and interests. This algorithm generates recommendations based on factors such as product name similarity, view-to-view statistics, and view-to-purchase statistics.
Endpoint
Visit our Postman collection to test this request.
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 | 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 the response | Boolean | No |
userId | testUser | User identifier which is assigned by Insider One. | String | No |
hp | true, false or 0, 1 | Makes affinities affect products of the response. The default is false. | Boolean | No |
excludePurchaseDay | 30 | After how many days purchased products should be excluded. | 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 | Yes |
Sample Request
The sample below displays a request to Substitute Recommendation, an algorithm that suggests alternative products to items a user has interacted with.
https://recommendation.api.useinsider.com/v2/substitute?partnerName={PartnerName}&locale={Locale}&productId={ABC123CBA}&size=5Sample 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