The Manual Merchandising algorithm retrieves product details that are manually specified, returning only products that are in stock. It enables you to showcase specific products or content (for special days, etc.) from a list specified in the campaign configuration. In addition, 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 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 |
| userId | testUser | User ID | String | No |
| hp | false, true or 0, 1 | Makes affinities affect products of the response. The default is false. | Boolean | No (Can only be used with userId) |
| size | 50 | Required number of items in response. Valid values are 0 to 100. | Integer | 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 |
| excludeViewDay | 30 | After how many days viewed products should be excluded. The default is -1. | Integer | No (Can only be used with userId) |
| excludeViewItem | 10 | How many viewed products should be excluded. The default is -1. | Integer | No (Can only be used with userId) |
| excludePurchaseDay | 30 | After how many days purchased products should be excluded. The default is -1. | 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) |
Sample Request
The sample below displays a request to the Manual Merchandising algorithm.
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.