A valid request URL is required to generate request examples[
{
"collection_id": "<string>",
"version": "<string>",
"version_name": "<string>",
"sort_order": "ALPHA_ASC",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
}
],
"use_collection_specific_boost_bury": true,
"unpin_oos": true,
"main": true,
"updated_at": "<string>",
"market_id": "<string>",
"market_group_id": "<string>",
"is_market_active": true,
"scheduled_publish_at": "2023-11-07T05:31:56Z",
"scheduled_by_email": "<string>",
"metafield_sort": {
"key": "<string>",
"type": "number_integer"
},
"active_attachment_ids": [
"<string>"
]
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}List a collection's versions
Returns every saved version of the collection’s Depict configuration (newest first): sort, pins, rules, which one is main, market targeting and schedule. Read-only.
A valid request URL is required to generate request examples[
{
"collection_id": "<string>",
"version": "<string>",
"version_name": "<string>",
"sort_order": "ALPHA_ASC",
"pinned_main_product_ids": [
"<string>"
],
"collection_boost_rules": [
{
"strength": 123,
"type": "badge",
"badge": "on_sale",
"top_n": 123
}
],
"use_collection_specific_boost_bury": true,
"unpin_oos": true,
"main": true,
"updated_at": "<string>",
"market_id": "<string>",
"market_group_id": "<string>",
"is_market_active": true,
"scheduled_publish_at": "2023-11-07T05:31:56Z",
"scheduled_by_email": "<string>",
"metafield_sort": {
"key": "<string>",
"type": "number_integer"
},
"active_attachment_ids": [
"<string>"
]
}
]{
"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.
Path Parameters
Numeric Shopify collection id.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
The versions.
Numeric Shopify collection id.
Version UUID.
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 A merchant-wide rule that moves matching products up (boost) or down (bury) in every automatically sorted collection. type selects how products match.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
This is the collection's published (main) version.
Naive UTC.
Set when the version targets one Shopify market.
Set when the version targets a market group.
Published to its market / market group.
UTC ISO timestamp (Z) the cron will publish it at; null when unscheduled.
Show child attributes
Show child attributes
Was this page helpful?