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

# Query Catalog

> Filter and project simple products and variants on the server. Requires catalog:read. Defaults to active sellable SKUs, excluding parent containers. costComparison=above_price compares known cost in each product's catalog currency using valid recorded conversions; unknown costs or unavailable conversions do not match. Fields bound the response. Maximum 500 rows per page. Omit counts after the first page with includeCount=false. No SQL input is accepted.



## OpenAPI

````yaml /openapi.json post /api/v1/catalog/query
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.ai
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: catalog
    description: catalog
    x-group: Catalog
  - name: commerce
    description: commerce
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: inventory
    description: Inventory quantities, planning signals, and marketplace listing absence
    x-group: Inventory
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: scripts
    description: scripts
    x-group: Scripts
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/catalog/query:
    post:
      tags:
        - catalog
      summary: Query Catalog
      description: >-
        Filter and project simple products and variants on the server. Requires
        catalog:read. Defaults to active sellable SKUs, excluding parent
        containers. costComparison=above_price compares known cost in each
        product's catalog currency using valid recorded conversions; unknown
        costs or unavailable conversions do not match. Fields bound the
        response. Maximum 500 rows per page. Omit counts after the first page
        with includeCount=false. No SQL input is accepted.
      operationId: post_v1_catalog_query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                organizationId:
                  type: string
                  minLength: 1
                filters:
                  default:
                    statuses:
                      - active
                    sellableOnly: true
                  type: object
                  properties:
                    statuses:
                      default:
                        - active
                      minItems: 1
                      maxItems: 3
                      type: array
                      items:
                        type: string
                        enum:
                          - active
                          - draft
                          - archived
                    productIds:
                      minItems: 1
                      maxItems: 2000
                      type: array
                      items:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    skus:
                      minItems: 1
                      maxItems: 500
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 200
                    currencies:
                      minItems: 1
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        pattern: ^[A-Z]{3}$
                    sellableOnly:
                      default: true
                      type: boolean
                    costComparison:
                      description: >-
                        Compare known cost against catalog price in the catalog
                        currency, using recorded valid cost conversions. Missing
                        cost or conversion is excluded.
                      type: string
                      const: above_price
                  additionalProperties: false
                fields:
                  default:
                    - id
                    - parentId
                    - type
                    - name
                    - sku
                    - status
                    - price
                    - currency
                    - cost
                    - costCurrency
                    - costInCatalogCurrency
                    - costConversion
                    - updatedAt
                  description: >-
                    Selected fields; id and the currency companions of monetary
                    fields are always returned.
                  minItems: 1
                  maxItems: 13
                  type: array
                  items:
                    type: string
                    enum:
                      - id
                      - parentId
                      - type
                      - name
                      - sku
                      - status
                      - price
                      - currency
                      - cost
                      - costCurrency
                      - costInCatalogCurrency
                      - costConversion
                      - updatedAt
                limit:
                  type: integer
                  minimum: 1
                  maximum: 500
                  default: 100
                cursor:
                  type: string
                  maxLength: 1000
                includeCount:
                  default: true
                  type: boolean
              additionalProperties: false
      responses:
        '200':
          description: Result
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                properties:
                  ok:
                    type: boolean
                  apiVersion:
                    type: string
                  operationId:
                    type: string
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      matchedCount:
                        anyOf:
                          - type: number
                          - type: 'null'
                      returnedCount:
                        type: number
                      diagnostics:
                        anyOf:
                          - type: object
                            properties:
                              missingCostCount:
                                type: number
                              uncomparableCostCount:
                                type: number
                            required:
                              - missingCostCount
                              - uncomparableCostCount
                          - type: 'null'
                      hasMore:
                        type: boolean
                      nextCursor:
                        anyOf:
                          - type: string
                          - type: 'null'
                      filters:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                      comparisonCurrency:
                        anyOf:
                          - type: string
                          - type: 'null'
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            parentId:
                              anyOf:
                                - type: string
                                - type: 'null'
                            type:
                              type: string
                              enum:
                                - product
                                - variant
                            name:
                              type: string
                            sku:
                              anyOf:
                                - type: string
                                - type: 'null'
                            status:
                              anyOf:
                                - type: string
                                - type: 'null'
                            price:
                              anyOf:
                                - type: number
                                - type: 'null'
                            currency:
                              anyOf:
                                - type: string
                                - type: 'null'
                            cost:
                              anyOf:
                                - type: number
                                - type: 'null'
                            costCurrency:
                              anyOf:
                                - type: string
                                - type: 'null'
                            costInCatalogCurrency:
                              anyOf:
                                - type: number
                                - type: 'null'
                            costConversion:
                              anyOf:
                                - type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties: {}
                                - type: 'null'
                            updatedAt:
                              type: string
                          required:
                            - id
                    required:
                      - success
                      - matchedCount
                      - returnedCount
                      - diagnostics
                      - hasMore
                      - nextCursor
                      - filters
                      - comparisonCurrency
                      - items
        '400':
          description: Invalid request.
        '401':
          description: Authentication required.
        '403':
          description: Missing capability or organization/product access.
        '409':
          description: Idempotency key reused with different input.
        '503':
          description: Temporarily unavailable. Retry the same idempotency key.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

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