Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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

surface_name
string
required

The surface's URL-safe name.

Pattern: ^[a-z0-9_-]+$

Query Parameters

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

Response

One entry per (anchor_type, anchor_id, market_id) set.

surface_id
string
required
anchor_type
string
required
anchor_id
string | null
required
market_id
string | null
required
pins
object[]
required