Error
A valid request URL is required to generate request examples"success"{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
How far the merchant's automatic theme onboarding got
One word for the whole store, reduced over every theme Depict tried to onboard: success beats warning beats failure; pending when nothing has run yet. Returns a bare JSON string. Read-only.
GET
/
onboarding
/
{merchant_id}
/
status
Error
A valid request URL is required to generate request examples"success"{
"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>.
Response
The status, as a JSON string.
The best outcome across the merchant's themes: success > warning > failure > pending (pending when no theme was onboarded yet). The collection templates route answers unavailable when no onboarding row exists for the theme at all, as on a headless store.
Available options:
success, warning, failure, pending, unavailable Was this page helpful?