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>.

key
string
required

The metafield as namespace.key (e.g. custom.weight), as listed by /product-metafield-keys.

Pattern: ^[A-Za-z0-9_-]{1,255}\.[A-Za-z0-9_-]{1,64}$

Response

The value listing.

values
object[]
required
limitHit
boolean
required

True when the key has more distinct values than the 50-row cap; the listing keeps the most common.