> ## Documentation Index
> Fetch the complete documentation index at: https://docs.depict.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Where the merchant's search onboarding stands

> The state of adding Depict search to the merchant's storefront theme: a background job prepares a search header on an unpublished copy of the live theme, then builds that copy for the merchant to preview and publish. Poll it after searchOnboardingEnable or searchOnboardingGoLive. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /search-onboarding/status
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /search-onboarding/status:
    get:
      summary: Where the merchant's search onboarding stands
      description: >-
        The state of adding Depict search to the merchant's storefront theme: a
        background job prepares a search header on an unpublished copy of the
        live theme, then builds that copy for the merchant to preview and
        publish. Poll it after searchOnboardingEnable or searchOnboardingGoLive.
        Read-only.
      operationId: searchOnboardingStatus
      parameters:
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
      responses:
        '200':
          description: The current status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchOnboardingStatusResponse'
        '400':
          description: '`merchant_id` is missing; `detail` carries zod''s message.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: >-
            `Merchant not found`: the merchant is not this caller's (terminal).
            `Store config is not ready yet`: mid-install, retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    SearchOnboardingStatusResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/SearchOnboardingStatus'
        existing_search_app:
          type: boolean
          description: >-
            The store already runs the Search by Depict app and never started
            this flow: it gets in touch instead of pressing the button.
        error:
          type:
            - string
            - 'null'
        theme_id:
          type:
            - integer
            - 'null'
        duplicate_theme_id:
          type:
            - integer
            - 'null'
          description: The unpublished theme copy that carries the search header.
        updated_at:
          type:
            - string
            - 'null'
        editor_deep_link:
          type:
            - string
            - 'null'
          description: >-
            Theme-editor link that adds the search block to the duplicate's
            header; only at live_ready.
        preview_link:
          type:
            - string
            - 'null'
          description: Storefront preview of the duplicate; only at live_ready.
      required:
        - status
        - existing_search_app
        - error
        - theme_id
        - duplicate_theme_id
        - updated_at
        - editor_deep_link
        - preview_link
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    SearchOnboardingStatus:
      type:
        - string
        - 'null'
      enum:
        - pending
        - running
        - stashed
        - failed
        - stale
        - golive_running
        - live_ready
        - golive_failed
        - null
      description: null = the merchant never started search onboarding.
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.

````