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

# Replace the products hidden from search

> Whole-replaces the excluded-products list (send the full list; `[]` clears it). Duplicate ids are dropped, first wins. Live search stops returning these products.



## OpenAPI

````yaml /api-reference/openapi/lite.json patch /search-config/excluded-products
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/excluded-products:
    patch:
      summary: Replace the products hidden from search
      description: >-
        Whole-replaces the excluded-products list (send the full list; `[]`
        clears it). Duplicate ids are dropped, first wins. Live search stops
        returning these products.
      operationId: searchExcludedProductsUpdate
      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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchExcludedProductsUpdate'
      responses:
        '200':
          description: Saved. The body is JSON `null`.
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: >-
            The query, path or body failed the schema; `detail` carries zod's
            messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '402':
          description: >-
            The merchant's plan does not include Search (superusers bypass
            this).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paywall'
        '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'
        '415':
          description: Content-Type is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    SearchExcludedProductsUpdate:
      type: object
      properties:
        excluded_products:
          type: array
          items:
            type: object
            properties:
              main_product_id:
                type: string
                pattern: ^\d+$
                description: Numeric Shopify product id (no GID prefix).
              title:
                type: string
                maxLength: 512
              image_url:
                type:
                  - string
                  - 'null'
                maxLength: 2048
                pattern: ^https?:\/\/
            required:
              - main_product_id
              - title
              - image_url
          maxItems: 500
      required:
        - excluded_products
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    Paywall:
      type: object
      properties:
        detail:
          type: string
        code:
          type: string
          enum:
            - product_required
            - collection_limit_exceeded
            - installation_frozen
        product:
          type: string
          enum:
            - search
            - recs
            - vm
        limit:
          type: integer
      required:
        - detail
        - code
      description: >-
        402: the merchant's plan does not include this. Branch on `code`; show
        `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.

````