> ## 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 merchant's search relevance settings

> Returns how storefront search ranks and filters for the merchant: keyword/meaning blend, searchable fields with weights, filter facets, sold-out handling and synonym groups. Unset values come back resolved to the serving defaults. Read-only. A 404 means the merchant has no Search section yet; the portal uses this read to decide whether to show it.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /search-config/configuration
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/configuration:
    get:
      summary: Read the merchant's search relevance settings
      description: >-
        Returns how storefront search ranks and filters for the merchant:
        keyword/meaning blend, searchable fields with weights, filter facets,
        sold-out handling and synonym groups. Unset values come back resolved to
        the serving defaults. Read-only. A 404 means the merchant has no Search
        section yet; the portal uses this read to decide whether to show it.
      operationId: searchConfiguration
      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 settings, defaults resolved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchConfiguration'
        '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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    SearchConfiguration:
      type: object
      properties:
        search_configuration:
          type: object
          properties:
            vector_alpha:
              type:
                - number
                - 'null'
              description: null = no override; serving applies its own default.
            query_by_fields:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                    enum:
                      - title
                      - colors
                      - variant_color
                      - material
                      - occasions
                      - product_type
                      - style_attributes
                      - pattern
                      - variant_title
                      - attribute_text
                      - gender
                      - tags
                      - merchandising_tags
                      - short_description
                      - description
                      - name_gloss
                  weight:
                    type: integer
                    minimum: 0
                    maximum: 127
                required:
                  - field
                  - weight
              description: >-
                Never null: a PATCH `null` (reset) reads back as the default
                fields.
            filter_facets:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                    enum:
                      - colors
                      - material
                      - gender
                      - product_type
                      - on_sale
                      - is_bestseller
                      - new
                      - size
                  label:
                    type: string
                required:
                  - field
                  - label
              description: >-
                Active filters with display labels; a PATCH sends back only the
                `field` names.
            out_of_stock_exempt_tags:
              type: array
              items:
                type: string
            hide_out_of_stock_products:
              type: boolean
            tenant_synonym_groups:
              type: array
              items:
                type: array
                items:
                  type: string
              description: >-
                Groups of words that mean the same to search, e.g.
                `[['trousers','pants']]`.
          required:
            - vector_alpha
            - query_by_fields
            - filter_facets
            - out_of_stock_exempt_tags
            - hide_out_of_stock_products
            - tenant_synonym_groups
      required:
        - search_configuration
    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.

````