> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vaultgraph.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Search catalog products



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/commerce/catalog/search
openapi: 3.1.0
info:
  title: VaultGraph Portal API
  version: 0.1.1
  description: Server-to-server endpoints exposed by the VaultGraph portal (beta).
servers:
  - url: https://app.vaultgraph.com
    description: Production
security: []
tags:
  - name: Shops
    description: Shop management endpoints.
  - name: Commerce
    description: >-
      Deployment-scoped commerce endpoints (catalog, checkout, order).
      Authenticated with a deployment (`dk_`) API key. Internal plumbing between
      the hosted MCP server and the merchant adapter — merchants integrate via
      the MCP, not these REST routes.
paths:
  /api/commerce/catalog/search:
    post:
      tags:
        - Commerce
      summary: Search catalog products
      operationId: searchCatalogProducts
      requestBody:
        required: false
        description: >-
          Search criteria. Every field is optional — an empty body returns the
          first page of the whole catalog.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCatalogRequest'
      responses:
        '200':
          description: One page of products, with optional next-page pagination
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProductPage'
        '400':
          description: Invalid search request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SearchCatalogRequest:
      type: object
      description: Catalog search criteria. Every field is optional.
      properties:
        query:
          type: string
          description: Free-text search query.
        filters:
          type: object
          properties:
            categories:
              type: array
              items:
                type: string
              description: Match products in ANY listed category (OR logic).
            price:
              type: object
              properties:
                min:
                  type: integer
                  description: Inclusive lower bound, minor units.
                max:
                  type: integer
                  description: Inclusive upper bound, minor units.
        pagination:
          type: object
          properties:
            cursor:
              type: string
              description: Opaque token from a previous response.
            limit:
              type: integer
              minimum: 1
              maximum: 100
    ProductPage:
      type: object
      required:
        - products
      properties:
        products:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        pagination:
          type: object
          required:
            - has_next_page
          properties:
            cursor:
              type: string
              description: Opaque next-page token. Present iff has_next_page is true.
            has_next_page:
              type: boolean
            total_count:
              type: integer
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        detail:
          type: string
    Product:
      type: object
      required:
        - id
        - title
        - categories
        - price_range
        - variants
      properties:
        id:
          type: string
        title:
          type: string
        brand:
          type: string
          description: Brand or maker label, e.g. "Ray-Ban". Optional.
        description:
          type:
            - string
            - 'null'
        media:
          type: array
          description: Gallery media. Optional — omit it for an image-less product.
          items:
            $ref: '#/components/schemas/Media'
        image_url:
          type: string
          description: >-
            Primary display image URL (the first image in media). Present
            whenever the product has any image media.
        categories:
          type: array
          items:
            type: string
        price_range:
          $ref: '#/components/schemas/PriceRange'
        list_price_range:
          $ref: '#/components/schemas/PriceRange'
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant'
        url:
          type: string
          description: Merchant link to this product. Optional.
    Media:
      type: object
      required:
        - type
        - url
      properties:
        type:
          type: string
          description: Media kind, e.g. "image".
        url:
          type: string
        alt_text:
          type:
            - string
            - 'null'
        width:
          type: integer
        height:
          type: integer
    PriceRange:
      type: object
      required:
        - min
        - max
      properties:
        min:
          $ref: '#/components/schemas/Price'
        max:
          $ref: '#/components/schemas/Price'
    Variant:
      type: object
      required:
        - id
        - product_id
        - title
        - price
        - availability
      properties:
        id:
          type: string
        product_id:
          type: string
        title:
          type: string
        sku:
          type:
            - string
            - 'null'
        price:
          $ref: '#/components/schemas/Price'
        list_price:
          $ref: '#/components/schemas/Price'
        availability:
          type: object
          required:
            - available
          properties:
            available:
              type: boolean
        media:
          type: array
          description: Variant-specific gallery media. Optional.
          items:
            $ref: '#/components/schemas/Media'
        image_url:
          type: string
          description: >-
            Primary display image URL for this variant (its first image, falling
            back to the product's). Present whenever an image exists.
        url:
          type: string
          description: Merchant link to this variant. Optional.
    Price:
      type: object
      required:
        - amount
        - currency
      properties:
        amount:
          type: integer
          description: Integer minor units (e.g. cents for USD).
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO 4217 currency code.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````