- 07 Feb 2024
- 1 Minute to read
Manual Merchandising
- Updated on 07 Feb 2024
- 1 Minute to read
Overview
This algorithm brings the details of products manually specified and only products that are in stock are returned. It enables you to showcase specific products or content (for special days, etc.) from a list that is specified on the campaign configuration. And only the products that are in stock will be displayed in the recommendation widget. This type of algorithm can be used on all page types to promote specific products.
Endpoint
GET https://recommendation.api.useinsider.com/v2/manual-merchandising
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 | ABC1234 | The id of the product whose complementary is requested. | 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/manual-merchandising?partnerName={Partner Name}&locale={Locale}¤cy={Currency}&productId=ABC12345,XYZ12345
Sample Response
{
"success": true,
"total": 2,
"types": {
"mm": 2
},
"data": [
"ABC12345",
"XYZ12345"
]
}
Fallback Algorithms
There is no fallback algorithm for this recommendation type as only requested items are recommended.