A valid request URL is required to generate request examples"<string>"{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"code": "product_required",
"product": "search",
"limit": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Save a collection's Depict configuration
The collection editor’s save: writes the body as a version (a new one when version is null) and, with main, makes it the published version. Side effects: a Shopify order sync-back, replication of a main save to linked multi-store collections, and tracked events. 402 when the installation is frozen. Returns the saved version’s UUID.
A valid request URL is required to generate request examples"<string>"{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"code": "product_required",
"product": "search",
"limit": 123
}{
"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>.
Body
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 Product ids pinned to the top, in order.
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
The version to save into; null creates a new version.
Make the saved version the published (main) one.
Required exactly when sort_order is METAFIELD_ASC/METAFIELD_DESC.
Show child attributes
Show child attributes
Null/absent leaves the stored attachments unchanged.
^[A-Za-z0-9_-]{1,255}\.[A-Za-z0-9_-]{1,64}$Response
The saved version's UUID.
The response is of type string.
Was this page helpful?