Error

A valid request URL is required to generate request examples

{
  "keys": [
    {
      "key": "<string>",
      "type": "<string>",
      "product_count": 123,
      "truncated_count": 123,
      "value_count": 123
    }
  ],
  "limitHit": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

API Reference

The metafield keys a merchant's catalog carries

Lists every Shopify product metafield key (with its type) found in the merchant’s synced catalog, most common first, with how many products carry it and how many distinct values it takes. Call it to discover which metafields a collection can be sorted by or which a boost/bury rule or badge can match on; then call /product-metafield-values for one key’s values. Read-only. It scans the whole catalog (up to ~20 s) and answers 503 when that scan times out; retrying at once rarely helps. Responses are cacheable for 60 s.

GET

product-metafield-keys

Error

A valid request URL is required to generate request examples

{
  "keys": [
    {
      "key": "<string>",
      "type": "<string>",
      "product_count": 123,
      "truncated_count": 123,
      "value_count": 123
    }
  ],
  "limitHit": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

The key listing.

keys

object[]

required

Show child attributes

limitHit

boolean

required

True when the catalog has more (key, type) pairs than the 2000-row cap; the listing keeps the most common.