A valid request URL is required to generate request examples{
"theme_onboarding_status": "success",
"user_approved": true,
"templates": [
{
"template_suffix": "<string>",
"is_depict_template": true,
"active": true,
"written": true,
"source_already_patched": true
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}The collection templates a collection can switch between
Lists the collection templates in the store’s published theme, marks the one this collection uses, and flags which render Depict’s grid. When the Depict variant of the active template does not exist yet, a written: false placeholder is appended and theme_onboarding_status says whether Depict is still writing it (the portal polls while it is pending). Read-only; several Shopify calls per request.
A valid request URL is required to generate request examples{
"theme_onboarding_status": "success",
"user_approved": true,
"templates": [
{
"template_suffix": "<string>",
"is_depict_template": true,
"active": true,
"written": true,
"source_already_patched": true
}
]
}{
"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
Lite merchant id, e.g. shopify-<shop id>.
The Shopify collection id (numeric, no gid prefix).
Response
The templates and the theme's onboarding state.
The main theme's onboarding outcome; pending while the Depict template is still being written.
success, warning, failure, pending The merchant has activated a Depict template on this theme before.
Show child attributes
Show child attributes
Was this page helpful?