Recommendation Settings

The Recommendation request has several settings that can affect how it returns products.

Some recommendation settings may only function for a select set of recommendations; the reason for this is typically that the setting is either redundant for that particular recommendation type, or that it is incompatible with the recommendation type.

Please refer to each individual setting to see if the recommendation type you wish to employ supports it.

Below is an overview of the settings, and their effects:

Setting	Data Type	Default Value
AllowFillIfNecessaryToReachNumberOfRecommendations	Boolean	True
AllowProductsCurrentlyInCart	Nullable Boolean	Null
AllowReplacingOfRecentlyShownRecommendations	Boolean	True
Custom	*	*
NumberOfRecommendations	Integer	10
PrioritizeDiversityBetweenRequests	Boolean	False
PrioritizeResultsNotRecommendedWithinSeconds	Nullable Integer	Null
RecommendVariant	Boolean	True
SelectedBrandProperties	Nullable Data Key	Null
SelectedProductProperties	Nullable Data Key	Null
SelectedVariantProperties	Nullable Data Key	Null

AllowFillIfNecessaryToReachNumberOfRecommendations

Define whether Fill is permitted in the recommendation to ensure the recommendation slider is fully populated with products.

Fill can be further refined through the use of a Filter Scope.

Defaults to True.

This setting does not support the following recommendations:

Click to expand

• RecentlyViewedProducts
• SortProducts
• SortVariants
• PopularProducts
• PersonalProductRecommendation
• PopularContents
• PersonalContentRecommendation
• PopularBrandsRecommendation
• PersonalBrandRecommendation
• PopularProductCategoriesRecommendation
• PersonalContentCategoryRecommendation
• PopularContentCategoriesRecommendation

AllowProductsCurrentlyInCart

Defines whether the recommendation slider is allowed to display products that have already been added to the card.

Defaults to Null.

AllowReplacingOfRecentlyShownRecommendations

Defines whether or not to switch up the recommendation slider with varied products, to prevent users from continuously being presented with the same limited number of products.

Defaults to True.

This setting does not support the following recommendations:

Click to expand

• RecentlyViewedProducts
• SearchTermBasedProductRecommendation
• SimilarProducts
• SortProducts
• SortVariants

Custom

The Custom setting is meant for internal use by Relewise, and should not be used. If you believe you need to employ a custom recommendation setting not found on this page, make sure to reach out to us first, so we can assist you in implementing your desired functionality correctly.

NumberOfRecommendations

Defines the amount of products to be returned in the recommendation request. Default value is 10. Relewise recommends not returning more products than you need, to keep response sizes minimal.

Defaults to 10.

PrioritizeDiversityBetweenRequests

This setting prevents users from seeing recommendations that have previously been shown in other recommendation sliders with this setting set to True.

Defaults to False.

This setting does not support the following recommendations:

Click to expand

• RecentlyViewedProducts
• SearchTermBasedProductRecommendation
• SimilarProducts
• SortProducts
• SortVariants

PrioritizeResultsNotRecommendedWithinSeconds

Defines a period of time, in seconds, where Relewise will prioritize not recommending products that have already been recommended to the same user. This has no effect if the user is anonymous.

Defaults to Null, which is treated as 1 second.

This setting does not support the following recommendations:

Click to expand

• RecentlyViewedProducts
• SearchTermBasedProductRecommendation
• SimilarProducts
• SortProducts
• SortVariants

RecommendVariant

Defines whether the request may return Variant products alongside regular products.

Defaults to True.

SelectedBrandProperties

Defines the Brand properties to be returned in the request.

Defaults to Null.

SelectedProductProperties

Defines the Product properties to be returned in the request. Common data keys include DisplayName, Pricing, CategoryPaths.

Defaults to Null.

Note that the property allVariants should be used with caution, as it returns all variants regardless of filters. This means that for sites with a large amount of variant products, the response can become prohibitively big and cumbersome. To avoid performance issues, use this property sparingly and with caution.

If you are uncertain of whether or not to use allVariants, reach out to us so that we might advise you on the best case for your site.

Example of a SelectedProductProperties

"SelectedProductProperties": {
    "DisplayName": true,
    "CategoryPaths": true,
    "Assortments": false,
    "Pricing": true,
    "AllData": true,
    "ViewedByUserInfo": false,
    "PurchasedByUserInfo": false,
    "Brand": true,
    "AllVariants": false
}

SelectedVariantProperties

Defines the Product properties to be returned in the request. Common data keys include DisplayName, Pricing, AllSpecifications.

Defaults to Null.