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.

Path Parameters

collection_id
string
required

Numeric Shopify collection id.

Query Parameters

merchant_id
string
required

Lite merchant id, e.g. shopify-<shop id>.

Response

The versions.

collection_id
string
required

Numeric Shopify collection id.

version
string
required

Version UUID.

version_name
string | null
required
sort_order
enum<string>
required

How Depict sorts the collection. MANUAL keeps the pinned order; METAFIELD_ASC/DESC sort by the version's metafield_sort key.

Available options:
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
pinned_main_product_ids
string[]
required
collection_boost_rules
object[]
required

A merchant-wide rule that moves matching products up (boost) or down (bury) in every automatically sorted collection. type selects how products match.

use_collection_specific_boost_bury
boolean
required
unpin_oos
boolean
required
main
boolean
required

This is the collection's published (main) version.

updated_at
string
required

Naive UTC.

market_id
string | null
required

Set when the version targets one Shopify market.

market_group_id
string | null
required

Set when the version targets a market group.

is_market_active
boolean
required

Published to its market / market group.

scheduled_publish_at
string<date-time> | null
required

UTC ISO timestamp (Z) the cron will publish it at; null when unscheduled.

scheduled_by_email
string | null
required
metafield_sort
object | null
required
active_attachment_ids
string[]
required