A valid request URL is required to generate request examples{
"status": "pending",
"existing_search_app": true,
"error": "<string>",
"theme_id": 123,
"duplicate_theme_id": 123,
"updated_at": "<string>",
"editor_deep_link": "<string>",
"preview_link": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"code": "product_required",
"product": "search",
"limit": 123
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Start preparing the search header on the merchant's theme
Queues the background job that prepares Depict’s search header for the merchant’s live theme (nothing is published; the result is stashed). Call once; then poll searchOnboardingStatus until stashed, and continue with searchOnboardingGoLive. Needs a plan that includes Search.
A valid request URL is required to generate request examples{
"status": "pending",
"existing_search_app": true,
"error": "<string>",
"theme_id": 123,
"duplicate_theme_id": 123,
"updated_at": "<string>",
"editor_deep_link": "<string>",
"preview_link": "<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.
Query Parameters
Lite merchant id, e.g. shopify-<shop id>.
Response
Started; the body is the new status to poll from.
null = the merchant never started search onboarding.
pending, running, stashed, failed, stale, golive_running, live_ready, golive_failed, null The store already runs the Search by Depict app and never started this flow: it gets in touch instead of pressing the button.
The unpublished theme copy that carries the search header.
Theme-editor link that adds the search block to the duplicate's header; only at live_ready.
Storefront preview of the duplicate; only at live_ready.
Was this page helpful?