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

# Set the option name the collection grid groups variants by

> Sets which product option (e.g. Color) groups variants into one card in the collection grid; omit the parameter to clear it. Writes config.merchant.variant_group_by_name; returns null.



## OpenAPI

````yaml /api-reference/openapi/lite.json put /merchants/{merchant_id}/variant_group_by_name
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:
  /merchants/{merchant_id}/variant_group_by_name:
    put:
      summary: Set the option name the collection grid groups variants by
      description: >-
        Sets which product option (e.g. Color) groups variants into one card in
        the collection grid; omit the parameter to clear it. Writes
        config.merchant.variant_group_by_name; returns null.
      operationId: setVariantGroupByName
      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: path
        - schema:
            type: string
            description: Option name to group by; absent clears the grouping.
          required: false
          description: Option name to group by; absent clears the grouping.
          name: variant_group_by_name
          in: query
      responses:
        '200':
          description: Saved.
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: The parameter is repeated or not a string.
          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:
    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.

````