Build the unpublished theme copy with search in it

Error

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>"
}

POST

search-onboarding

go-live

Error

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

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.

Query Parameters

merchant_id

string

required

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

Response

Started; the body is the new status to poll from.

status

enum<string> | null

required

null = the merchant never started search onboarding.

Available options:

pending,

running,

stashed,

failed,

stale,

golive_running,

live_ready,

golive_failed,

null

existing_search_app

boolean

required

The store already runs the Search by Depict app and never started this flow: it gets in touch instead of pressing the button.

error

string | null

required

theme_id

integer | null

required

duplicate_theme_id

integer | null

required

The unpublished theme copy that carries the search header.

updated_at

string | null

required

editor_deep_link

string | null

required

Theme-editor link that adds the search block to the duplicate's header; only at live_ready.

preview_link

string | null

required

Storefront preview of the duplicate; only at live_ready.