A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"context": "product",
"steps": [
{
"kind": "best_sellers",
"params": {
"freshness_days": 123,
"candidate_pool": 123
},
"filters": [
{
"type": "price",
"min_fraction_of_median": 123,
"max_fraction_of_median": 123
}
],
"limit": 123,
"seed": {
"source": "anchor",
"max_seeds": 123
}
}
],
"filters": [
{
"type": "price",
"min_fraction_of_median": 123,
"max_fraction_of_median": 123
}
],
"limit": 123,
"excluded_product_ids": [
"<string>"
],
"pin_mode": "insert",
"looks": "none",
"custom_rules": [
"<unknown>"
],
"only_show_pinned": true,
"avoid_surfaces": [
"<string>"
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Read one recommendation surface
Returns one saved surface by name: its id, context, steps, filters, limit, exclusions and the read-only serving directives. Call it to inspect a surface before changing it with the PUT on the same path. Read-only.
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"context": "product",
"steps": [
{
"kind": "best_sellers",
"params": {
"freshness_days": 123,
"candidate_pool": 123
},
"filters": [
{
"type": "price",
"min_fraction_of_median": 123,
"max_fraction_of_median": 123
}
],
"limit": 123,
"seed": {
"source": "anchor",
"max_seeds": 123
}
}
],
"filters": [
{
"type": "price",
"min_fraction_of_median": 123,
"max_fraction_of_median": 123
}
],
"limit": 123,
"excluded_product_ids": [
"<string>"
],
"pin_mode": "insert",
"looks": "none",
"custom_rules": [
"<unknown>"
],
"only_show_pinned": true,
"avoid_surfaces": [
"<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.
Path Parameters
The surface's URL-safe name.
^[a-z0-9_-]+$Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
The saved surface.
A saved surface. pin_mode, looks, custom_rules, only_show_pinned and avoid_surfaces are ops-only serving directives, as are a step's seed and the recently_viewed kind: read-only here, an upsert keeps the directives.
Stable uuid; kept across upserts. Pins, metrics and compose address the surface by it.
URL-safe ([a-z0-9_-]+); also the storefront metaobject handle the theme block references.
^[a-z0-9_-]+$Where the surface renders: product (a product page, anchored on that product), category (a collection page, anchored on the collection) or any (unanchored). Per-product recommenders need product.
product, category, any Recommenders in priority order: each fills the slots the ones before it left empty.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
Applied to every step's candidates.
Median-relative: 0.5 = half the anchor's (or catalogue's) median price.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Slots the surface renders.
Products never recommended on this surface.
insert, override none, first, only Was this page helpful?