Skip to main content
RichRelevance

Email Integration Parameters

Parameters required in the email's HTML when implementing Recommend + Email.

Details

The tables below detail the various parameter names, descriptions and whether or not the parameter is required in the email's HTML when implementing Recommend + Email.

Parameters

Parameter Name Quick Info Description Examples Required
a API Key The API key assigned to your web site by {rr} &a=[API_KEY] Yes
userid or u User ID The unique User ID value that matches the site User ID. &userid=12345 Yes
campaignid or cpi Campaign ID The unique name for the campaign that the merchant is setting up &campaignId=
order_confirmation or campaignId=
Electronics
PromoJuly2011
Yes
zoneName Look & Feel for ImageMaP This is the name of the layout received from {rr} &zoneName=Vertical_3 Yes
date YYYY-MM-DD Date the campaign is sent &date=2009-12-02

 

Yes

 

 

 

lid Product position Indicates the position of the product in the set of recs returned. Will be used for redirection to correct product page. Only used on click links. &lid=2 Yes

version or rmv

Version

Please note that all the brand/category/strategy filter attributes defined below only work with Version 2

&version=2

 
bi Block item ID This option will force Recommend  to NOT recommend specified products. &bi=123|234|567 No

o

Order ID

The ID of an order if the email is related to an order.

&o=48958387

No

seedBrandIds Brand ID One or more brand IDs separated by a pipe &seedBrandIds=65432|98765 No

seedCategoryIds or cis

Category ID

One or more Category IDs separated by a pipe

&seedCategoryIds=
12345 or &seedCategory
Ids=12345|2345
|67890

No

seedProductIds Product ID One or more Product IDs separated by a pipe. Note: The system de-duplicates between items identified as a seedProductIds. &seedProductIds=123 No

st

Search Term

Specifies a search term that can be used by the SearchBought strategy family. Needs to be URL encoded.

&st=Harry%20Potter

No

strategySet

Filter_Strategies

A prioritized list of strategy sets that you would want to be returned based on the campaign use case. Please see additional details under Strategy Families listing below. If this is not provided, our recommendation engine will run King of the Hill (KOTH) to provide best recommendations given the information provided.

&strategySet=SiteWideBestSellers or &strategySet=ProductBoughtBought|
ProductViewedViewed

No

filbr

List of Brands

Lists of brands you want to act on. This parameter works in conjunction with filbrinc. Both must be setup correctly to get desired results.

&filbr=SONY|Samsung

No

filbrinc

Include True/False

This flag allows you to show or remove the brands you provided under filbr. The default value is false, which would remove the specified brands.

&filbrinc=true

No

filcat

List of Categories

Lists of categories you want to act on. This parameter works in conjunction with filcatinc. Both must be setup correctly to get desired results. The category external ID (not category name) must be specified.

&filcat=TVS|
DVDS

No

filcatinc

Include True/False

This flag allows you to show or remove the categories you provided under filcat. The default value is false, which would remove the specified categories.

&flicatinc=true

No

filprmin

Price Min

This flag allows you to pass in a minimum price threshold. Please note that this needs to be in cents.

&filprmin=2500

No

filprmax

Price Max

This flag allows you to pass in a maximum price threshold. Please note that this needs to be in cents.

&filprmax=10000

No

filprinc

Include True/False

This flag allows you to include or remove products matching the minimum and maximum prices set using filprmin and filprmax. The default value is false.

&filprinc=true

No

 

If you're using the strategySet parameter, these strategy families are available:

Strategy Families / Filter Strategies/ Variable ‘fs’

Description

Additional Required Parameters

Suggested Parameters

SiteWideBestSellers

Sitewide strategies such as top sellers, popular products etc.

None

 

RatingsReviews

Ratings & reviews-based strategies

None

 

CategoryBestSellers

Category-based strategies – Category top sellers etc.

Category ID

Brand (for BrandTopSellers)

NewArrivals

Strategies that recommend new arrivals (given the data is provided in the feed)

Category ID

 

MoversAndShakers

Strategies that recommend the products that were in demand in the recent past (1 wk, 2wks, 3 wks)

None

 

ProductViewedViewed

Recommendations on other products viewed when people Viewed ProductX

Product ID

 

ProductBoughtBought

Recommendations on other products purchased when people purchased ProductX

Product ID

 

SearchBought

Strategies that return products based on search term passed. Ex: “What did people buy when searching for ‘XYZ’?”

Search term

 

CategoryBoughtBought

“People who bought items in CategoryX also bought items in the following Categories: Y, Z, A.”

Category ID

 

Personalized

Personalized strategies for the user – these may include recently Viewed items and recommendations based on recent view history, or recommendations based on recent purchase history, etc. Personalized strategies look at your browser cookies to determine the seed.

User ID