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>"
}{
"detail": "<string>"
}Save one pin set of a surface
Saves one pin set of a surface: the body is the complete set for one (anchor_type, anchor_id, market_id), and the stored pins for that set are reconciled to it (added, moved, removed); an empty pins clears the set. Other sets are untouched. Side effect: queues a background recompute of the surface. Returns the saved set.
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>"
}{
"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>.
Body
anchor_type is one of any, category, lvl1, lvl2, lvl3.
any on an unanchored surface, category on a category surface, lvl1 on a product surface.
100Show child attributes
Show child attributes
The product or collection the set applies to; null = every anchor. Must be null for any.
1 - 2561 - 256The market the set applies to; null = every market.
1 - 256Optional guard: when set, must equal the surface's id (400 otherwise).
Response
The saved set.
Show child attributes
Show child attributes
Was this page helpful?