A valid request URL is required to generate request examples[
{
"collection_id": "<string>",
"title": "<string>",
"handle": "<string>",
"image_urls": [
"<string>"
],
"shopify_sort_order": "MANUAL",
"sort_order": "ALPHA_ASC",
"has_depict_configuration": true,
"sync_back_to_shopify": true,
"unpin_oos": true,
"updated_at": "<string>",
"shopify_updated_at": "<string>",
"use_collection_specific_boost_bury": true,
"main_version": "<string>",
"n_products": 123,
"n_pinned_main_product_ids": 123,
"product_images": [
"<string>"
],
"has_scheduled_version": true
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}List every collection of the merchant
Returns ALL of the merchant’s Shopify collections (no paging; large stores have thousands), each with its Depict state: active or not, sort order, pin count, first product images. Read-only. Prefer GET /collections/paginated for search or large stores.
A valid request URL is required to generate request examples[
{
"collection_id": "<string>",
"title": "<string>",
"handle": "<string>",
"image_urls": [
"<string>"
],
"shopify_sort_order": "MANUAL",
"sort_order": "ALPHA_ASC",
"has_depict_configuration": true,
"sync_back_to_shopify": true,
"unpin_oos": true,
"updated_at": "<string>",
"shopify_updated_at": "<string>",
"use_collection_specific_boost_bury": true,
"main_version": "<string>",
"n_products": 123,
"n_pinned_main_product_ids": 123,
"product_images": [
"<string>"
],
"has_scheduled_version": true
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
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
Lite merchant id, e.g. shopify-<shop id>.
Response
Every collection, by collection id.
Numeric Shopify collection id.
Primary-locale title.
The collection's own sort order in Shopify.
MANUAL, BEST_SELLING, ALPHA_ASC, ALPHA_DESC, CREATED, CREATED_DESC, PRICE_ASC, PRICE_DESC, MOST_RELEVANT How Depict sorts the collection's unpinned products, within each boost/bury strength. BEST_SELLING: units sold in the last 30 days (BY_REVENUE: revenue). TRENDING: units sold in the last 7 days (BY_REVENUE: revenue). Unit ties on either break by 30-day revenue. CLICKS_DESC: clicks in the last 30 days. STOCK_DESC: total stock. CREATED: oldest first, CREATED_DESC: newest first, by the store's New in date (published or created, per dynamic status). PRICE*, ALPHA*: price, title. METAFIELD_ASC/DESC: the version's metafield_sort key. MANUAL: the saved order, never re-sorted, and boost/bury does not apply. MOST_RELEVANT: not a Depict sort. It comes from Shopify's relevance sort, which Depict cannot compute: Depict keeps the collection's existing order in Shopify and still applies boost/bury. After Depict's first write that existing order is the one Depict last wrote, so it stops following Shopify's relevance and earlier boosts and pins linger in it.
ALPHA_ASC, ALPHA_DESC, BEST_SELLING, BEST_SELLING_BY_REVENUE, MOST_RELEVANT, TRENDING, TRENDING_BY_REVENUE, CREATED, CREATED_DESC, PRICE_ASC, PRICE_DESC, STOCK_DESC, CLICKS_DESC, METAFIELD_ASC, METAFIELD_DESC, MANUAL Whether Depict has saved any configuration (sort, pins, content blocks…) for it.
Active: Depict writes its order back to Shopify. False = the collection is not managed by Depict.
Out-of-stock pinned products drop out of their pins.
When the Depict configuration last changed (naive UTC); null on an inactive list row.
Naive UTC.
True: the version's own boost/bury rules apply instead of the merchant-wide ones.
UUID of the published version; null on an inactive list row.
Always present. Image URLs of the collection's first products; null when it has none, and always null on the paginated list unless include_images=true.
Was this page helpful?