Skip to main content
POST
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>.

sort_order
enum<string>
required

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.

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
version
string | null

The version whose saved settings apply; absent = main.

Body

application/json
boost_bury_rules
object[] | null

Unsaved collection rules to preview; null = the saved ones.

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

pinned_main_product_ids
string[] | null

Unsaved pins to preview; null = the saved ones.

active_attachment_ids
string[] | null

Unsaved groupings to preview; null = the saved ones.

metafield_sort
object | null

Response

The products in grid order.

main_product_id
string
required

Shopify product id (numeric string).

title
string
required
handle
string
required
images
object[]
required
tags
string[]
required
price
number | null
required
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED,
DRAFT,
SCHEDULED,
UNLISTED
has_online_store_channel
boolean | null
required

Whether the Online Store sales channel is enabled; null when ingestion has not stamped it.

in_stock
boolean
required
quantity
integer
required

Summed available quantity over variants.

badges
object[]
required
skus
string[]
required
created_at
string
required
published_at
string | null
required
variants
object[]
required
sort_index
integer
required

Position in the collection's sort, ignoring pins.

market_quantities
object | null
required

Available quantity per market id.

variant_ids_in_collection
string[] | null
required
variants_in_collection
integer | null
required
variants_total
integer | null
required
applied_boost_bury_rule
object

The rule that moved this product, if any.

metafield_sort_value
string | null

The sort metafield's value under a METAFIELD_* sort.