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

# Read the search empty-state configuration

> What the search overlay shows before the shopper types: product sort, pinned products, suggestion chips per locale, blocked suggestion terms, generator instructions and UI string overrides. Read-only; change it with the search-config PATCH. The product preview itself is not here (runway's public /empty-state-products serves it).



## OpenAPI

````yaml /api-reference/openapi/lite.json get /search-config/states
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-config/states:
    get:
      summary: Read the search empty-state configuration
      description: >-
        What the search overlay shows before the shopper types: product sort,
        pinned products, suggestion chips per locale, blocked suggestion terms,
        generator instructions and UI string overrides. Read-only; change it
        with the search-config PATCH. The product preview itself is not here
        (runway's public /empty-state-products serves it).
      operationId: searchConfigStates
      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 empty-state configuration, defaults resolved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchConfigStates'
        '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. `Search is
            not set up for this merchant`: no Search section (not
            search-entitled, or no store config); the portal hides the section
            on exactly this detail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error, or a stored value is corrupt (written out of band).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    SearchConfigStates:
      type: object
      properties:
        empty_state_config:
          type: object
          properties:
            sort_order:
              type: string
              enum:
                - CREATED_DESC
                - STOCK_DESC
                - BESTSELLERS
              description: Order of the products shown before the shopper types.
            pinned_main_product_ids:
              type: array
              items:
                type: string
            generated_empty_state_suggestions:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            localized_strings_overrides:
              type: object
              additionalProperties:
                type: object
                additionalProperties:
                  type: string
            suggestion_blocked_terms:
              type: array
              items:
                type: string
            suggestion_extra_instructions:
              type:
                - string
                - 'null'
          required:
            - sort_order
            - pinned_main_product_ids
            - generated_empty_state_suggestions
            - localized_strings_overrides
            - suggestion_blocked_terms
            - suggestion_extra_instructions
      required:
        - empty_state_config
    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.

````