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

# The merchant's open onboarding messages and setup-guide copy

> Lists the in-app messages the onboarding programme queued for the merchant that are neither dismissed nor expired, plus the copy (headline, per-step text, hidden steps, order) of the Home, Search and Recommendations setup guides from the shared back-office template. Read-only and uncached; the portal polls it while Home is open.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /onboarding-messages
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-messages:
    get:
      summary: The merchant's open onboarding messages and setup-guide copy
      description: >-
        Lists the in-app messages the onboarding programme queued for the
        merchant that are neither dismissed nor expired, plus the copy
        (headline, per-step text, hidden steps, order) of the Home, Search and
        Recommendations setup guides from the shared back-office template.
        Read-only and uncached; the portal polls it while Home is open.
      operationId: onboardingMessages
      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: Open messages and the template copy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingMessagesResponse'
        '400':
          description: merchant_id is missing.
          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 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:
    OnboardingMessagesResponse:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/OnboardingMessage'
          description: >-
            Open (not dismissed, not expired) messages, newest first, at most
            20.
        template:
          type: object
          properties:
            version:
              type: integer
              description: 0 when the back office never saved a template.
            setup:
              $ref: '#/components/schemas/OnboardingSetupCopy'
            search_setup:
              $ref: '#/components/schemas/OnboardingSetupCopy'
            recommendations_setup:
              $ref: '#/components/schemas/OnboardingSetupCopy'
          required:
            - version
            - setup
      required:
        - messages
        - template
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    OnboardingMessage:
      type: object
      properties:
        id:
          type: integer
        program_id:
          type: string
          description: The onboarding programme step that queued it.
        surface:
          type: string
          description: 'Where the app mounts it: "Home banner", "Home card", "Setup card", …'
        payload:
          type: object
          properties:
            title:
              type: string
            body:
              type: string
            buttons:
              type: array
              items:
                type: object
                properties:
                  label:
                    type: string
                  href:
                    type: string
                    description: Absolute link; portal links become in-app navigations.
                  primary:
                    type: boolean
                required:
                  - label
                  - href
          required:
            - title
            - body
            - buttons
        queued_at:
          type: string
        seen_at:
          type:
            - string
            - 'null'
        clicked_at:
          type:
            - string
            - 'null'
      required:
        - id
        - program_id
        - surface
        - payload
        - queued_at
        - seen_at
        - clicked_at
    OnboardingSetupCopy:
      type: object
      properties:
        headline:
          type: object
          properties:
            title:
              type: string
            body:
              type: string
        steps:
          type: object
          additionalProperties:
            type: object
            properties:
              title:
                type: string
              description:
                type: string
              effort:
                type: string
          description: Per-step copy overrides, keyed by step id.
        hidden:
          type: array
          items:
            type: string
          description: Step ids the guide hides.
        order:
          type: array
          items:
            type: string
          description: Step ids in display order.
      description: A setup guide's copy as customer success edited it in the back office.
  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.

````