See Also: Legacy Response Format
This endpoint should not be used for customers integrating using our API as it is deprecated. See Personalized Recommendations for the endpoint we currently support.
This endpoint alone does not track data for reporting in the management console.
API Endpoint URLs
General Recommendations (Popular Items)
The primary endpoint for general recommendations. Currently defaults to using "Best Selling" (below), though this may change in the future.
https://api.searchspring.net/api/recommend
Trending (or Similar Items)
This endpoint will return products that were Most Viewed on your site.
If the seed parameter is passed, this will return products that were most often Also Viewed in the same user sessions on your site, when the seed product(s) was/were viewed.
https://api.searchspring.net/api/recommend/trending
Best Selling (or Complementary Items)
This endpoint will return products that were Most Bought on your site.
If the seed parameter is passed, this will return products that were most often Also Bought in the same user sessions on your site, when the seed product(s) was/were purchased.
https://api.searchspring.net/api/recommend/best-selling
Request Parameters
All parameters can be used with any of the endpoints listed above.
siteId (Required)
| Format | String |
| Description | The unique ID for the website to fetch recommendations for. This can be found on the My Account page in the Searchspring Management Console under the "Site ID". |
| Example Value | "scmq7n" |
attributes
| Format | Array[String(s)] |
| Description | Request specific fields to be returned for each product. |
| Example Values | ["days_since_published", "ga_unique_purchases"] |
- A field must be set to "Display" in Field Settings in order to be returned.
- Fields set on Core Mappings (such as Name and SKU) will always be returned
- If you pass an empty array, it will return only core fields.
- If you don't specify this parameter, all display fields will be returned.
tag
If using an API integration with Product Recommendations+ Profiles, the minimum threshold and templates in the profile editor will not work.
| Format | String |
| Description | The Recommendations+ Profile ID Tag. To apply a Recommendations+ Profile to the response, simply pass the tag here. The tag is the "Profile ID" listed under the title of a profile. |
| The profile settings will always override whatever endpoint you are hitting. | |
| Example Value | "also-viewed" |
seed
| Format | Array[String(s)] |
| Description | If you are looking for recommendations related to a specific product or set of products, pass the seed SKU(s) here. Only required for Complementary Items (also-bought) and Similar Items (also-viewed) recommendation types. |
| Example Values | ["C-LA-W1-20264", "C-NBK-R2-D7043"] |
limit
| Format | Integer |
| Description | Limit the number of product suggestions that are returned. |
| Maximum | limit of 100 |
| Default | 10 |
| Example Value | 4 |
Example Request
"Also Viewed" on a Product Detail Page
curl -X GET https://api.searchspring.net/api/recommend/trending.json?siteId=scmq7n&seed=12345&limit=2&attributes=color&attributes=color_family