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

# End a collection version A/B test, promote a winner, or refresh a variant

> Applies one lifecycle action (see the body). Promoting makes the variant's version the collection's main version and syncs it to Shopify. Returns the updated test.



## OpenAPI

````yaml /api-reference/openapi/lite.json patch /collections/{collection_id}/ab-tests/{test_id}
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:
  /collections/{collection_id}/ab-tests/{test_id}:
    patch:
      summary: >-
        End a collection version A/B test, promote a winner, or refresh a
        variant
      description: >-
        Applies one lifecycle action (see the body). Promoting makes the
        variant's version the collection's main version and syncs it to Shopify.
        Returns the updated test.
      operationId: collectionAbTestUpdate
      parameters:
        - schema:
            type: string
            description: Numeric Shopify collection id.
          required: true
          description: Numeric Shopify collection id.
          name: collection_id
          in: path
        - schema:
            type: string
            description: The test's id.
          required: true
          description: The test's id.
          name: test_id
          in: path
        - 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/PatchCollectionVersionAbTestRequest'
      responses:
        '200':
          description: The updated test.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionVersionAbTest'
        '400':
          description: >-
            The query or body failed the schema, or the merchant has no Shopify
            configuration.
          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, or no such test on the
            collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '409':
          description: >-
            The test's status does not allow this action (e.g. deleting a
            running test).
          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:
    PatchCollectionVersionAbTestRequest:
      oneOf:
        - type: object
          properties:
            action:
              type: string
              enum:
                - end
            variant:
              type:
                - string
                - 'null'
              enum:
                - A
                - B
                - null
          required:
            - action
        - type: object
          properties:
            action:
              type: string
              enum:
                - promote
            variant:
              type: string
              enum:
                - A
                - B
          required:
            - action
            - variant
        - type: object
          properties:
            action:
              type: string
              enum:
                - refresh_variant
            variant:
              type: string
              enum:
                - A
                - B
          required:
            - action
            - variant
      description: >-
        `end` stops a running test; `promote` makes the variant's version main
        and ends the test; `refresh_variant` re-publishes a variant's ordering
        after its version changed.
    CollectionVersionAbTest:
      type: object
      properties:
        test_id:
          type: string
        collection_id:
          type: string
        name:
          type: string
        variant_a_version_uuid:
          type: string
        variant_b_version_uuid:
          type: string
        scope_type:
          type: string
          enum:
            - all
            - market_groups
        market_group_ids:
          type: array
          items:
            type: string
        applies_to_market_ids:
          type: array
          items:
            type: string
          description: >-
            The scope resolved to numeric Shopify market ids, sorted; two
            running tests on a collection never share one.
        traffic_split:
          type: integer
          description: Percent of traffic routed to variant B (10–90).
        start_date:
          type: string
          format: date-time
        end_date:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - running
            - ended
            - winner_promoted
        promoted_variant:
          type:
            - string
            - 'null'
          enum:
            - A
            - B
            - null
        created_at:
          type: string
          format: date-time
        created_by_email:
          type: string
          description: 'Always empty: the test is storefront-readable.'
      required:
        - test_id
        - collection_id
        - name
        - variant_a_version_uuid
        - variant_b_version_uuid
        - scope_type
        - market_group_ids
        - applies_to_market_ids
        - traffic_split
        - start_date
        - end_date
        - status
        - promoted_variant
        - created_at
        - created_by_email
    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.

````