Home > widget-integration > RecommendationWidget

RecommendationWidget type

Signature:

export type RecommendationWidget = {
	widgetName: string;
	params: {
		limit?: number;
		shop: string;
		wid: string;
		recommendationType: "bestsellers" | "newest-arrivals" | "frequently-bought-together" | "trending-products" | "hand-picked-products" | "recently-viewed" | "most-viewed" | "related-items";
		modelType?: "FBT" | "Complementary" | "Alternative" | "AIRelated";
		calculatedBasedOn?: "view-events" | "purchase-events";
		rangeOfTime?: "1-day" | "2-day" | "3-day" | "4-day" | "5-day" | "6-day" | "7-day";
		ruleBased?: Array<{
			type: "sameCollection" | "sameProductType" | "sameVendor" | "sameTags" | "sameMetafield" | "sameProductCategory";
			status?: boolean;
			excluded?: string[];
			metafield?: string;
		}>;
	};
	widgetDesignSettings?: {
		layoutDisplay?: "carousel" | "grid" | "bundle";
		numberOfProductPerRow?: number;
		numberOfRecommendProduct?: number;
		bundleStyle?: "style1" | "style2";
		templateType?: "default" | "customization";
		themePreview?: string;
		titleAlignment?: "center" | "left";
		titleFont?: string;
		titleFontSize?: number;
		titleFontStyle?: string;
		titleFontWeight?: string | number;
		titleTextColor?: string;
		titleTextTransform?: "capitalize";
	};
	widgetStatus: "inactive" | "active";
};