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

# Publish a collection version to the storefront

> Makes `body.version` live: as the collection's main version, or for its market / market group (retiring that market's previously live version). Writes the version's content blocks, product duplicates and image settings to Shopify metafields/metaobjects, then triggers the order sync-back. The path's {version} must equal `body.version`. An unknown version is a 404 and writes nothing. Requires collection versions in the plan (402 otherwise). Returns null.



## OpenAPI

````yaml /api-reference/openapi/lite.json put /collections/{collection_id}/publish_version/{version}
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}/publish_version/{version}:
    put:
      summary: Publish a collection version to the storefront
      description: >-
        Makes `body.version` live: as the collection's main version, or for its
        market / market group (retiring that market's previously live version).
        Writes the version's content blocks, product duplicates and image
        settings to Shopify metafields/metaobjects, then triggers the order
        sync-back. The path's {version} must equal `body.version`. An unknown
        version is a 404 and writes nothing. Requires collection versions in the
        plan (402 otherwise). Returns null.
      operationId: publishVersion
      parameters:
        - schema:
            type: string
            description: Numeric Shopify collection id.
          required: true
          description: Numeric Shopify collection id.
          name: collection_id
          in: path
        - schema:
            type: string
            format: uuid
            description: The version's UUID.
          required: true
          description: The version's UUID.
          name: version
          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/PublishCollectionVersionRequest'
      responses:
        '200':
          description: Published.
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: >-
            The query or body failed the schema, the path version differs from
            `body.version`, or the shop has no usable Shopify configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '402':
          description: >-
            The plan does not include collection versions (Merchandising at
            Medium or above, or the free trial).
          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 for this caller, or no such version of the
            collection.
          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:
    PublishCollectionVersionRequest:
      type: object
      properties:
        version:
          type: string
          format: uuid
        content_blocks:
          type: array
          items:
            type: string
          description: Content block ids enabled on this version.
        product_duplicates:
          type: array
          items:
            type: string
        image_settings:
          type: array
          items:
            type: string
      required:
        - version
        - content_blocks
        - product_duplicates
        - image_settings
    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.

````