Complementary Products
- 07 Feb 2024
- 1 Minute to read
Complementary 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 complementary of products. This type of algorithm works best on product pages and cart pages.
Endpoint
GEThttps://recommendation.api.useinsider.com/v2/complementary
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 |
productId | ABC0123 | Base product id. | 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 |
userId | a1b2c3d4 | User identifier which is assigned by Insider. | String | No |
excludeViewDay | 30 | After how many days should viewed products be excluded. | Integer | No (Can be used only with userId) |
excludeViewItem | 100 | How many viewed products should be excluded. | Integer | No (Can be used only with userId) |
excludePurchaseDay | 30 | After how many days should purchased products be excluded. | Integer | No (Can be used only with userId) |
excludePurchaseItem | 100 | How many purchased products should be excluded. | Integer | No (Can be used only with userId) |
hp | false | Makes affinities affect products of the response. | Boolean | No |
Sample Example
Sample Request
POST https://recommendation.api.useinsider.com/v2/complementary?partnerName={PartnerName}&locale={Locale}¤cy={Currency}&productId={ProductId}
Sample Response
{
"success": true,
"total": 5,
"types": {
"cp": 5
},
"data": [
"ABC321Z8",
"ABC312Z8",
"ABC123Z8",
"ABC234Z8",
"ABC345Z8"
]
}
Fallback Algorithms
If the products come from Complementary Products are not enough to fill the response data, some fallback algorithms below fill it:
- Purchased Together
- Top Sellers of Category
- Top Sellers
Was this article helpful?