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

The Shopify collection id (numeric, no gid prefix).

Query Parameters

merchant_id
string
required

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

template_suffix
string
required

The Shopify template suffix: "" is the default collection template, "depict" is collection.depict.

theme_id
string
required

The main theme's id (theme_id from onboardingMainTheme); activating a Depict template marks that theme approved.

Pattern: ^-?\d+$

Response

The template the collection now uses.

template_suffix
string
required

The Shopify template suffix: "" is the default collection template, "depict" is collection.depict.

is_depict_template
boolean
required

The template renders Depict's sorted grid.