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

query
string

Text to match; omit or leave blank to browse.

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0
collection_id
string

Limit to this Shopify collection's products; an empty value means no limit.

sort
enum<string>

Order by title. Without it: collection order when scoped, else exact-id match then title.

Available options:
title

Response

One page of products.

products
object[]
required
total
integer | null
required

Size of the scope (the catalogue, or collection_id's products) when query is blank; null when a text query is given.