Error
A valid request URL is required to generate request examples[
{
"surface_id": "<string>",
"anchor_type": "<string>",
"anchor_id": "<string>",
"market_id": "<string>",
"pins": [
{
"pinned_id": "<string>",
"pinned_level": "<string>",
"position": 123,
"legacy_pinned_id": "<string>",
"foundation_pinned_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_pinned_product_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_pinned_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"legacy_anchor_id": "<string>",
"foundation_anchor_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_anchor_product_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_anchor_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
Read a surface's pin sets
Returns every pin set of a surface: one entry per (anchor_type, anchor_id, market_id), each listing the pinned products by slot position. Call it before saving pins, since a save replaces a whole set. Read-only.
GET
/
recommendations
/
surfaces
/
{surface_name}
/
pins
Error
A valid request URL is required to generate request examples[
{
"surface_id": "<string>",
"anchor_type": "<string>",
"anchor_id": "<string>",
"market_id": "<string>",
"pins": [
{
"pinned_id": "<string>",
"pinned_level": "<string>",
"position": 123,
"legacy_pinned_id": "<string>",
"foundation_pinned_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_pinned_product_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_pinned_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"legacy_anchor_id": "<string>",
"foundation_anchor_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_anchor_product_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"foundation_anchor_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]{
"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.
Pattern:
^[a-z0-9_-]+$Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
One entry per (anchor_type, anchor_id, market_id) set.
Show child attributes
Show child attributes
Was this page helpful?

