Commerce Einstein Webstore Recommendations

Get Commerce Einstein product recommendations.

Resource

1/commerce/webstores/webstoreId/ai/recommendations

Available version

55.0

Requires Chatter

HTTP methods

GET

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`anchorValues`	String	List of product or category IDs to use as context for the recommendations. When using a product recommender, such as `SimilarProducts` or `ComplementaryProducts`, specify product IDs. When using a category recommender, such as `MostViewedByCategory` or `TopSellingByCategory`, specify category IDs. The anchor list can't contain both product IDs and category IDs. Note	Required for product or category recommenders	55.0
`effectiveAccountId`	String	ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context. To view prices from the API, administrators must specify an effective account. Note	Optional	55.0
`recommender`	String	Specifies the recommender to use to generate recommendations. `RecentlyViewed` — Generates recommendations based on items that the customer recently viewed. `SimilarProducts` — Generates recommendations based on the viewing behavior of customers who viewed the same product and the product’s similarity to other products. These recommendations match the category of the product viewed. `ComplementaryProducts` — Generates recommendations of products that complement other products. These recommendations don’t match the category of the product being viewed. `CustomersWhoBoughtAlsoBought` — Generates recommendations of products that were bought by other customers who also bought this product. `MostViewedByCategory` — Generates recommendations of products that were most viewed in a specific category. `TopSellingByCategory` — Generates recommendations by analyzing which products were recently purchased by other customers in the category being viewed. `Upsell` — Generates recommendations by analyzing the purchasing behavior of other shoppers who either bought or viewed the same product. `TopSelling` — Generates recommendations by analyzing which products were recently purchased by other customers. `PersonalizedForShopper` — Generates personalized recommendations for the customer, or recommendations based on products that were recently viewed by other shoppers. For more information about each recommender, see the Usage Notes section for the Einstein Recommendations Component for B2C Stores.	Required	55.0

Parameter Name

Type

Description

Required or Optional

Available Version

anchorValues

String

List of product or category IDs to use as context for the recommendations. When using a product recommender, such as SimilarProducts or ComplementaryProducts, specify product IDs. When using a category recommender, such as MostViewedByCategory or TopSellingByCategory, specify category IDs.

The anchor list can't contain both product IDs and category IDs.

Note

Required for product or category recommenders

55.0

effectiveAccountId

String

ID of the buyer account or guest buyer profile for which the request is made. If unspecified, the default value is determined from context.

To view prices from the API, administrators must specify an effective account.

Note

Optional

55.0

recommender

String

Specifies the recommender to use to generate recommendations.

RecentlyViewed — Generates recommendations based on items that the customer recently viewed.
SimilarProducts — Generates recommendations based on the viewing behavior of customers who viewed the same product and the product’s similarity to other products. These recommendations match the category of the product viewed.
ComplementaryProducts — Generates recommendations of products that complement other products. These recommendations don’t match the category of the product being viewed.
CustomersWhoBoughtAlsoBought — Generates recommendations of products that were bought by other customers who also bought this product.
MostViewedByCategory — Generates recommendations of products that were most viewed in a specific category.
TopSellingByCategory — Generates recommendations by analyzing which products were recently purchased by other customers in the category being viewed.
Upsell — Generates recommendations by analyzing the purchasing behavior of other shoppers who either bought or viewed the same product.
TopSelling — Generates recommendations by analyzing which products were recently purchased by other customers.
PersonalizedForShopper — Generates personalized recommendations for the customer, or recommendations based on products that were recently viewed by other shoppers.

For more information about each recommender, see the Usage Notes section for the Einstein Recommendations Component for B2C Stores.

Required

55.0

Response body for GET

Commerce Einstein Recommendation Results

Connect REST API Developer Guide

Commerce Einstein Webstore Recommendations