> ## 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.

# 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.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /onboarding/{merchant_id}/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:
  /onboarding/{merchant_id}/status:
    get:
      summary: How far the merchant's automatic theme onboarding got
      description: >-
        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.
      operationId: onboardingStatus
      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: path
      responses:
        '200':
          description: The status, as a JSON string.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThemeOnboardingStatus'
        '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 for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    ThemeOnboardingStatus:
      type: string
      enum:
        - success
        - warning
        - failure
        - pending
      description: >-
        The best outcome across the merchant's themes: success > warning >
        failure > pending (pending when no theme was onboarded yet).
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
  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.

````