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

# Whether the merchant's recommendations are computed yet

> Reports whether the merchant's recommendations have been computed: the run in flight (if any), the last finished run, and `ready` (the last run completed with at least one market). Poll it after enabling recommendations or changing surfaces to know when storefront recommendations are live. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /recommendations/precompute-status
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:
  /recommendations/precompute-status:
    get:
      summary: Whether the merchant's recommendations are computed yet
      description: >-
        Reports whether the merchant's recommendations have been computed: the
        run in flight (if any), the last finished run, and `ready` (the last run
        completed with at least one market). Poll it after enabling
        recommendations or changing surfaces to know when storefront
        recommendations are live. Read-only.
      operationId: recsPrecomputeStatus
      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
      responses:
        '200':
          description: The running and last runs, and the verdict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecsPrecomputeStatus'
        '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'
        '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'
        '502':
          description: The precompute worker could not answer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    RecsPrecomputeStatus:
      type: object
      properties:
        running:
          type:
            - object
            - 'null'
          properties:
            instanceId:
              type: string
            heldForMs:
              type: number
          required:
            - instanceId
            - heldForMs
          description: The run in flight, if any.
        lastRun:
          anyOf:
            - $ref: '#/components/schemas/RecsPrecomputeRunSummary'
            - type: 'null'
        ready:
          type: boolean
          description: The last finished run completed with at least one complete market.
      required:
        - running
        - lastRun
        - ready
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    RecsPrecomputeRunSummary:
      type: object
      properties:
        instanceId:
          type: string
        startedAtMs:
          type:
            - number
            - 'null'
          description: When the run was minted (epoch ms); null for an unrecognised id.
        status:
          type: string
          description: >-
            Cloudflare Workflow status (`complete`, `errored`, `running`, ...)
            or `unknown` once the instance has expired.
        error:
          type:
            - string
            - 'null'
        marketsTotal:
          type:
            - integer
            - 'null'
        marketsComplete:
          type:
            - integer
            - 'null'
        skipped:
          type:
            - boolean
            - 'null'
          description: The run found nothing to compute (zero markets).
      required:
        - instanceId
        - startedAtMs
        - status
        - error
        - marketsTotal
        - marketsComplete
        - skipped
  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.

````