Error
A valid request URL is required to generate request examples[
{
"theme_id": 123,
"timestamp": "<string>",
"has_changes": true,
"resources": [
{
"path": "<string>",
"content": "<string>",
"type": "collection_template",
"patched_resource": {
"path": "<string>",
"content": "<string>"
},
"changed": true,
"error": "<string>"
}
]
}
]{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}API Reference
Every theme-onboarding run for a merchant, newest first
The full history behind the admin Theme Onboardings page: per run, the theme, when it ran, and each resource Depict generated (with the patched file and whether it changed against the next-older run). Unpaginated and potentially tens of MB for long-lived stores; bodies past 8 MB stream, so a late failure truncates the body instead of answering 500. Read-only; for support/debugging, not for routine polling.
GET
/
onboarding
/
{merchant_id}
/
onboardings
Error
A valid request URL is required to generate request examples[
{
"theme_id": 123,
"timestamp": "<string>",
"has_changes": true,
"resources": [
{
"path": "<string>",
"content": "<string>",
"type": "collection_template",
"patched_resource": {
"path": "<string>",
"content": "<string>"
},
"changed": true,
"error": "<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>.
Was this page helpful?