See also: Response Format
In order to use personalization features, you must have IntelliSuggest event tracking installed on your site. Be sure to install recommendations tracking as well!
API Endpoint URL
Your Site ID can be found on the My Account page.
https://[siteId].a.searchspring.io/boost/[siteId]/recommend
NOTE: For GET requests, please ensure all characters are URL encoded. It is recommended to ensure requests do not exceed 2,000 characters due to character limits imposed by some browsers.
Request Parameters
siteId (Required)
| Format | String |
| Description | The unique ID for your site, used in all API requests. |
| Example | scmq7n |
shopper
| Format | String |
| Description | The Id associated with the logged-in shopper on your store. Required for most personalization functionality. If the shopper is anonymous, leave this field out. |
| Example | 3022b347-a272-46c3-b676-62266e335a80 |
cart
| Format | String |
| Description | An comma-separated list of product SKUs that are in the current user's cart. Required for real-time personalization functionality. |
| Example Value | 123-ABC,567-DEF,8910-GHI |
lastViewed
| Format | String |
| Description | A comma-separated list of the 5 most recent product IDs or SKUs whose pages the user has visited. Required for real-time personalization functionality. |
| Example Value | 145-JKL,267-MNO,3910-PQR,467-STU,589-VWX |
product
| Format | String |
| Description | The ID or SKU of the product being viewed. Required for profiles that use cross-sell or similar profiles, usually on Product Detail Pages. |
| Example Value | 987-ZYX |
tags (Required)
| Format | String |
| Description | A comma-separated list of profile Ids (tags) from profiles in the management console. The response will include a profile for each tag. |
| Example Value | also-viewed,also-bought,most-popular |
categories
| Format | String |
| Description | A comma-separated list of category Ids for use with Category Trending recommendations profiles. |
| Example Value | 182645380 |
Example Request
When the shopper has logged in, or you know their actual ID
This will improve their personalized experience.
HTTP
https://scmq7n.a.searchspring.io/boost/scmq7n/recommend?product=987-ZYX&shopper=3022b347-a272-46c3-b676-62266e335a80&cart=123-ABC,567-DEF,8910-GHI&lastViewed=145-JKL,267-MNO,3910-PQR,467-STU,589-VWX&tags=also-viewed,also-bought,most-popular
cURL
curl -X GET -G https://scmq7n.a.searchspring.io/boost/scmq7n/recommend -d shopper=3022b347-a272-46c3-b676-62266e335a80 -d cart=123-ABC -d lastViewed=145-JKL,267-MNO,3910-PQR,467-STU,589-VWX -d tags=also-viewed,also-bought,most-popular
When the shopper is unknown
HTTP
https://scmq7n.a.searchspring.io/boost/scmq7n/recommend?product=987-ZYX&cart=123-ABC,567-DEF,8910-GHI&lastViewed=145-JKL,267-MNO,3910-PQR,467-STU,589-VWX&tags=also-viewed,also-bought,most-popular
cURL
curl -X GET -G https://scmq7n.a.searchspring.io/boost/scmq7n/recommend -d cart=123-ABC -d lastViewed=145-JKL,267-MNO,3910-PQR,467-STU,589-VWX -d tags=also-viewed,also-bought,most-popular
Comments
0 comments
Please sign in to leave a comment.