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

# Schedule a collection version to publish later

> Sets when the version is published automatically (by a cron, within minutes of the time); replaces any earlier schedule. Records the caller as the scheduler. Nothing is published now. Scheduling the main version is the normal way to time a publish of the live configuration; it is valid even when that version is already the one the storefront shows. Requires scheduled publishing in the plan (402 otherwise); schedules already set still publish.



## OpenAPI

````yaml /api-reference/openapi/lite.json put /collections/{collection_id}/schedule_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}/schedule_version/{version}:
    put:
      summary: Schedule a collection version to publish later
      description: >-
        Sets when the version is published automatically (by a cron, within
        minutes of the time); replaces any earlier schedule. Records the caller
        as the scheduler. Nothing is published now. Scheduling the main version
        is the normal way to time a publish of the live configuration; it is
        valid even when that version is already the one the storefront shows.
        Requires scheduled publishing in the plan (402 otherwise); schedules
        already set still publish.
      operationId: scheduleVersion
      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/ScheduleCollectionVersionRequest'
      responses:
        '200':
          description: Scheduled.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                required:
                  - status
        '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 plan does not include scheduled publishing (Merchandising at
            Large 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.
          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:
    ScheduleCollectionVersionRequest:
      type: object
      properties:
        scheduled_publish_at:
          type: string
          format: date-time
          description: >-
            ISO 8601 date-time with seconds and Z or an offset, e.g.
            `2026-10-01T08:00:00Z` (what `Date.toISOString()` produces).
      required:
        - scheduled_publish_at
    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.

````