> ## 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 merchant's boost/bury rules

> Replaces ALL of the merchant's boost/bury rules with `rules` in one atomic write; any rule not sent is deleted, and an empty list clears them. To add or edit one rule, GET /boost-bury first and send the full list back. Side effects: the new rules take effect the next time collections are sorted (no immediate re-sort is triggered), and an `updated_boost_bury` analytics event is recorded. Returns null.



## OpenAPI

````yaml /api-reference/openapi/lite.json put /boost-bury/rules
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:
  /boost-bury/rules:
    put:
      summary: Replace the merchant's boost/bury rules
      description: >-
        Replaces ALL of the merchant's boost/bury rules with `rules` in one
        atomic write; any rule not sent is deleted, and an empty list clears
        them. To add or edit one rule, GET /boost-bury first and send the full
        list back. Side effects: the new rules take effect the next time
        collections are sorted (no immediate re-sort is triggered), and an
        `updated_boost_bury` analytics event is recorded. Returns null.
      operationId: boostBuryRulesUpdate
      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/UpdateBoostBuryRules'
      responses:
        '200':
          description: Saved.
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: >-
            The query or body failed the schema (including a metafield rule
            whose operator/value does not fit its metafield_type).
          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:
    UpdateBoostBuryRules:
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/BoostBuryRule'
      required:
        - rules
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    BoostBuryRule:
      oneOf:
        - type: object
          properties:
            strength:
              type: integer
              description: >-
                Priority and direction: > 0 boosts matching products toward the
                top, < 0 buries them toward the bottom; a larger magnitude wins
                over a smaller one.
            top_n:
              type:
                - integer
                - 'null'
              description: >-
                Cap: only the first N matching products (best-ranked for a badge
                rule) are moved; null or absent = every match.
            type:
              type: string
              enum:
                - badge
            badge:
              $ref: '#/components/schemas/ProductBadgeType'
          required:
            - strength
            - type
            - badge
        - type: object
          properties:
            strength:
              type: integer
              description: >-
                Priority and direction: > 0 boosts matching products toward the
                top, < 0 buries them toward the bottom; a larger magnitude wins
                over a smaller one.
            top_n:
              type:
                - integer
                - 'null'
              description: >-
                Cap: only the first N matching products (best-ranked for a badge
                rule) are moved; null or absent = every match.
            type:
              type: string
              enum:
                - collection
            collection_id:
              type: string
              description: >-
                Numeric Shopify collection id (no gid:// prefix); matches that
                collection's products.
          required:
            - strength
            - type
            - collection_id
        - type: object
          properties:
            strength:
              type: integer
              description: >-
                Priority and direction: > 0 boosts matching products toward the
                top, < 0 buries them toward the bottom; a larger magnitude wins
                over a smaller one.
            top_n:
              type:
                - integer
                - 'null'
              description: >-
                Cap: only the first N matching products (best-ranked for a badge
                rule) are moved; null or absent = every match.
            type:
              type: string
              enum:
                - tag
            tags:
              type: array
              items:
                type: string
              description: >-
                Matches products carrying any of these Shopify tags (see GET
                /boost-bury/tags).
          required:
            - strength
            - type
            - tags
        - type: object
          properties:
            strength:
              type: integer
              description: >-
                Priority and direction: > 0 boosts matching products toward the
                top, < 0 buries them toward the bottom; a larger magnitude wins
                over a smaller one.
            top_n:
              type:
                - integer
                - 'null'
              description: >-
                Cap: only the first N matching products (best-ranked for a badge
                rule) are moved; null or absent = every match.
            type:
              type: string
              enum:
                - metafield
            key:
              type: string
              pattern: ^[A-Za-z0-9_-]{1,255}\.[A-Za-z0-9_-]{1,64}$
              description: Product metafield as `namespace.key`.
            metafield_type:
              type: string
              enum:
                - number_integer
                - number_decimal
                - single_line_text_field
                - multi_line_text_field
                - url
                - color
                - date
                - date_time
                - boolean
                - rating
                - weight
                - dimension
                - volume
              description: >-
                The metafield's Shopify type; it decides which operators are
                allowed (measurement types allow only `exists`).
            operator:
              type: string
              enum:
                - exists
                - equals
                - gt
                - lt
              description: >-
                `exists` matches any product with the metafield set;
                `equals`/`gt`/`lt` compare against `value`.
            value:
              type:
                - string
                - 'null'
              description: The compared raw metafield value; null for `exists`.
          required:
            - strength
            - type
            - key
            - metafield_type
            - operator
            - value
      description: >-
        A merchant-wide rule that moves matching products up (boost) or down
        (bury) in every automatically sorted collection. `type` selects how
        products match.
    ProductBadgeType:
      type: string
      enum:
        - on_sale
        - out_of_stock
        - new_in
        - bestseller
        - bestseller_revenue
        - slow_mover
        - few_variants_available
        - partially_out_of_stock
        - partially_low_stock
        - trending
        - trending_revenue
        - tag
        - collection
      description: Matches products currently carrying this badge.
  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.

````