SEsearchspring

Personalized Recommendations API

Will return recommended products queried from a configured personalized recommendations profile. Returned results will be personalized to the shopper.

post/boost/{siteId}/recommend

Request

  • Base URL
    https://siteId.a.searchspring.io
  • URL
    https://siteId.a.searchspring.io/boost/{siteId}/recommend
  • Auth
    none declared

Path parameters

siteIdstring required

Unique identifier to associate the Searchspring account making the request to the database. This can be found on the My Account page in the Searchspring Management Console under the Account details section.

Request body

productsstring[]

IDs or SKUs of the products being viewed. This parameter is required only for recommendations profiles that use cross-sell or similar recommendations types, and is recommended for all requests made on Product Detail Pages. This parameter will often just be a single value on a PDP but could be multiple on something like a view wishlist page or a page for a bundle of products.

blockedItemsstring[]

IDs or SKUs you wish to block from being returned by the API in this call. This is useful if you have other products that are being displayed on the page that you don't want returned by the recs API, potentially if you have curated products on the page.

shopperstring

ID of current logged-in shopper from your ecommerce platform; this is required for personalization based on shopper history. If the shopper is anonymous, this parameter should be omitted.

cartstring[]

IDs or SKUs that are in the current shopper's cart. This is required to curate recommended products as the shopper navigates the site. Required for cart cross-sell.

lastViewedstring[]

IDs or SKUs that the shopper has recently viewed, with the most recently viewed product SKU listed first in the comma-seperated list. This parameter is required to curate recommended products as the shopper navigates the site.

beaconboolean

Specify wether or not using the new Beacon tracking system - this will tell the API to generate an auto-beacon event that is sent to our tracking system.

testboolean

Specify that this event is a test event - this prevents our tracking system from processing the event as a real user interaction.

Example request

{
  "shopper": "3022b347-a272-46c3-b676-62266e335a80"
}

Changes

No recorded changes to this operation across all 1 revision of this API.