RecommendationsServiceInterface

RecommendationsServiceInterface.php : 18 Copy path

Interface

Service for fetching product and content recommendations from Raptor.

Methods¶

getContentBasedOnItemWeb() ¶

RecommendationsServiceInterface.php : 60 Copy path

public getContentBasedOnItemWeb(string $productId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$productId	string	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getContentBasedOnProductCategoryWeb() ¶

RecommendationsServiceInterface.php : 71 Copy path

public getContentBasedOnProductCategoryWeb(string $categoryId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$categoryId	string	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getContentCatalogueRank() ¶

RecommendationsServiceInterface.php : 248 Copy path

public getContentCatalogueRank([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getItemsBasedOnContentWeb() ¶

RecommendationsServiceInterface.php : 93 Copy path

public getItemsBasedOnContentWeb(string $contentId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$contentId	string	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getMerchandisingContentWeb() ¶

RecommendationsServiceInterface.php : 216 Copy path

public getMerchandisingContentWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getMerchandisingItemsWeb() ¶

RecommendationsServiceInterface.php : 206 Copy path

public getMerchandisingItemsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getNumOfUsersRightNowWeb() ¶

RecommendationsServiceInterface.php : 196 Copy path

public getNumOfUsersRightNowWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getPIMRelatedItemsForBasketWeb() ¶

RecommendationsServiceInterface.php : 237 Copy path

public getPIMRelatedItemsForBasketWeb(string $productIds[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$productIds	string	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getPIMRelatedItemsWeb() ¶

RecommendationsServiceInterface.php : 226 Copy path

public getPIMRelatedItemsWeb(string $productId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$productId	string	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getPopularBrandsWeb() ¶

RecommendationsServiceInterface.php : 166 Copy path

public getPopularBrandsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getPopularCategoriesWeb() ¶

RecommendationsServiceInterface.php : 176 Copy path

public getPopularCategoriesWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getPopularContentWeb() ¶

RecommendationsServiceInterface.php : 186 Copy path

public getPopularContentWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getPopularItemsInCategoryWeb() ¶

RecommendationsServiceInterface.php : 37 Copy path

public getPopularItemsInCategoryWeb(string $categoryId, bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$categoryId	string	-	-
$inStockOnly	bool	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getPopularItemsWeb() ¶

RecommendationsServiceInterface.php : 114 Copy path

public getPopularItemsWeb(bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$inStockOnly	bool	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getProductCatalogueRank() ¶

RecommendationsServiceInterface.php : 258 Copy path

public getProductCatalogueRank([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getSimilarContentWeb() ¶

RecommendationsServiceInterface.php : 82 Copy path

public getSimilarContentWeb(string $contentId[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$contentId	string	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getSimilarItemsWeb() ¶

RecommendationsServiceInterface.php : 25 Copy path

public getSimilarItemsWeb(string $productId, bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$productId	string	-	-
$inStockOnly	bool	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getUserContentHistoryWeb() ¶

RecommendationsServiceInterface.php : 156 Copy path

public getUserContentHistoryWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getUserContentRecommendationsWeb() ¶

RecommendationsServiceInterface.php : 104 Copy path

public getUserContentRecommendationsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ContentRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ContentRecommendations

Tags

getUserCrossSellingItemsWeb() ¶

RecommendationsServiceInterface.php : 136 Copy path

public getUserCrossSellingItemsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getUserItemHistoryWeb() ¶

RecommendationsServiceInterface.php : 49 Copy path

public getUserItemHistoryWeb([bool $inStockOnly = false ][, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$inStockOnly	bool	false	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getUserItemRecommendationsWeb() ¶

RecommendationsServiceInterface.php : 125 Copy path

public getUserItemRecommendationsWeb(bool $inStockOnly[, int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$inStockOnly	bool	-	-
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations

Tags

getUserLookAlikeItemsWeb() ¶

RecommendationsServiceInterface.php : 146 Copy path

public getUserLookAlikeItemsWeb([int $numOfItems = 10 ][, array<string, mixed> $options = [] ]) : ProductRecommendations

Parameters

Name	Type	Default value	Description
$numOfItems	int	10	-
$options	array<string, mixed>	[]	-

Return values

ProductRecommendations