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

# What the merchant's synced catalogue contains, in counts

> Returns counts over the merchant's synced catalogue: products, collections, how many are out of stock or have no image, how many carry a description or tags, and how many share a tag with another product. Call it to describe a store to itself before any shopper data exists — the onboarding Home shows these instead of invented sales figures. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /catalogue-facts
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:
  /catalogue-facts:
    get:
      summary: What the merchant's synced catalogue contains, in counts
      description: >-
        Returns counts over the merchant's synced catalogue: products,
        collections, how many are out of stock or have no image, how many carry
        a description or tags, and how many share a tag with another product.
        Call it to describe a store to itself before any shopper data exists —
        the onboarding Home shows these instead of invented sales figures.
        Read-only.
      operationId: catalogueFacts
      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 counts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogueFacts'
        '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:
    CatalogueFacts:
      type: object
      properties:
        products:
          type: integer
          description: Products read from Shopify.
        collections:
          type: integer
        out_of_stock:
          type: integer
          description: Products with no variant in stock right now.
        no_image:
          type: integer
          description: >-
            Products without a first image: they cannot be merchandised or
            recommended.
        big_collections:
          type: integer
          description: Collections holding more than 100 products.
        small_collections:
          type: integer
          description: Collections holding fewer than five products.
        with_description:
          type: integer
        with_tags:
          type: integer
        with_neither:
          type: integer
          description: 'No description and no tags: findable by title only.'
        sharing_tag:
          type: integer
          description: >-
            Products that share at least one tag with another product, so they
            can be paired before any shopper arrives.
        product_types:
          type: integer
      required:
        - products
        - collections
        - out_of_stock
        - no_image
        - big_collections
        - small_collections
        - with_description
        - with_tags
        - with_neither
        - sharing_tag
        - product_types
      description: >-
        Counts taken from the merchant's own synced catalogue. Every number is
        countable in Shopify by the merchant; nothing here is inferred or
        modelled.
    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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.