A valid request URL is required to generate request examples[
{
"id": "<string>",
"display_name": "<string>",
"bucket": "any",
"description": "<string>"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}The recommender catalog a surface step can use
Returns the recommender catalog: every step kind a surface may use, its display name, and whether it needs a product anchor (bucket: per_product). Call it before building or editing a surface’s steps. Read-only.
A valid request URL is required to generate request examples[
{
"id": "<string>",
"display_name": "<string>",
"bucket": "any",
"description": "<string>"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
One entry per step kind, in catalog order.
The step kind to use it.
per_product recommenders start from the anchor product and need a product surface, unless a step's seed names the shopper's history.
any, per_product, client_history What the recommender returns and from which signal. Every kind leaves out draft products; stock_mode controls sold-out products (generative cross-sell keeps its in-stock pool); a step that returns too few products leaves the rest of the surface to the next step.
Was this page helpful?