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

sort_order
enum<string>
default:popular

popular = most liked first; published_at = newest first.

Available options:
popular,
published_at
features
string

Comma-separated features (content_block, product_duplicate, image_setting); a row must use all of them.

q
string

Case-insensitive match on the collection title or the brand name.

live
enum<string>

Only brands entitled to this Depict product.

Available options:
search,
recs
limit
integer

Page size, clamped to 1..48 (default 24).

offset
integer

Rows to skip, floored at 0.

Response

One page.

items
object[]
required
total
integer
required

Rows matching the filters, across all pages.

feature_counts
object
required

Rows in the 30-day window using each feature, before the feature filter.

search_live_count
integer
required

Rows whose brand has search, before the filters.

recs_live_count
integer
required

Rows whose brand has recommendations, before the filters.

limit
integer
required
offset
integer
required