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.

Query Parameters

merchant_id
string
required

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

Response

Every surface keyed by name; {} when nothing is configured.

Every surface keyed by name, in creation order.

{key}
object

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.