Overview

Store-level recommendations allow retailers to fetch products available at a specific store. When store parameters are included in the request, products unavailable at that store are excluded from the response. Each product also includes store-level details, such as st_availability.

The feature is available in the V3 Recommendations API only.

Workflow for Store Level Recommendations

Enable Store-Level Recommendations

A retailer needs two things in place before store-scoped requests will work.

The retailer must have a store implementation.
The store ID must be available in the catalog as the store identifier, so filtering can happen.

Request Store-Scoped Recommendations

Include these parameters in the V3 Recommendations request. Both must be sent together.

Parameter	Required	Description
store	Yes	Set to true to enable store-scoped product lookup
store.id	Yes	Target store identifier. Use all to request the "all" store

GET v3.0/{apiKey}/{siteKey}/recommendation?pageType=PRODUCT&id=xxs812&uid=uid1234&store=true&store.id=all

📘
Good to Know
Store can be combined with variants in the same request (&variants=true&variants.count=1). When combined, store data sits inside each variant object.

Read the Store Response

Store data appears inside each product, or inside each variant when the request combines store and variants.

{
  "uniqueId": "xxs812",
  "title": "Armitage Sectional",
  "vId": "xxs812_J210890",
  "variantCount": 2,
  "variantTotal": 2,
  "variants": [
    {
      "vId": "xxs812_J210890",
      "title": "Armitage Sectional",
      "store": [
        {
          "st_availability": "made to order",
          "uniqueId": "xxs812_J210890_all"
        }
      ]
    }
  ]
}

Store field	Meaning
st_availability	Availability of the item in that store (for example, "made to order")
uniqueId	Store-level ID, formatted as {productId}{variantId}{storeId} (for example, xxs812_J210890_all)