> ## 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. # List Products > List products for the authenticated organization with optional filters and pagination. Authenticate with an API key or OAuth bearer token. The organization is taken from that credential; do not send `organizationId`. ### Stock and variants Rows are in `items`. Read catalog stock from `items[].stockQuantity`: parent rows already aggregate their non-deleted variants, and virtual bundles use component availability with any manual cap. Null means unknown, not zero. A row with `variantCount` above 0 has variants; fetch them from `GET /api/v1/products/{productId}`. List rows do not contain `inventoryQuantity`, `inventory.quantity`, or an embedded `variants` array. ## OpenAPI ````yaml /openapi.json get /api/v1/products 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.sg 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: campaigns description: Campaign briefs, offer windows, and marketplace runs x-group: Campaigns - name: developer-platform description: Authenticated developer platform APIs x-group: Developer Platform - name: documents description: Knowledge base document uploads x-group: Knowledge Base - 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: settlements description: settlements x-group: Settlements - name: ucp description: Universal Commerce Protocol x-group: UCP paths: /api/v1/products: get: tags: - products summary: List Products description: >- List products for the authenticated organization with optional filters and pagination. Authenticate with an API key or OAuth bearer token. The organization is taken from that credential; do not send `organizationId`. ### Stock and variants Rows are in `items`. Read catalog stock from `items[].stockQuantity`: parent rows already aggregate their non-deleted variants, and virtual bundles use component availability with any manual cap. Null means unknown, not zero. A row with `variantCount` above 0 has variants; fetch them from `GET /api/v1/products/{productId}`. List rows do not contain `inventoryQuantity`, `inventory.quantity`, or an embedded `variants` array. operationId: get_v1_products parameters: - name: status in: query required: false description: >- Filter by one catalog view status. Lifecycle values include draft, active, archived and deleted; derived views include flagged, errors, qc_pending and qc_rejected. A product may have a lifecycle value and multiple derived signals simultaneously. schema: type: string - name: marketplace in: query required: false description: Filter by enabled marketplace. schema: type: string enum: - shopee - lazada - tiktok - shopify - zalora - amazon - ebay - name: country in: query required: false description: Filter by marketplace country (e.g., Singapore, Malaysia). schema: type: string maxLength: 80 - name: q in: query required: false description: Search query for product name or SKU. schema: type: string maxLength: 200 - name: sku in: query required: false description: >- Exact catalog SKU match after trim. Not fuzzy and not substring. Repeat the parameter or comma-separate up to 50 SKUs. Combined with other filters using AND. schema: type: string maxLength: 200 - name: minPrice in: query required: false description: Minimum price filter. schema: type: number minimum: 0 - name: maxPrice in: query required: false description: Maximum price filter. schema: type: number minimum: 0 - name: sortBy in: query required: false description: Sort order for results. schema: type: string enum: - updatedAt - createdAt - name - price default: updatedAt - name: limit in: query required: false description: >- Result limit per page. Values above the cap are clamped silently; the applied value is returned in `pagination.limit`. Defaults to 20. schema: default: 20 type: integer minimum: 1 maximum: 50 - name: offset in: query required: false description: >- Zero-based pagination offset. Use `pagination.nextOffset` from the previous response to page forward. Defaults to 0. schema: type: integer minimum: 0 default: 0 responses: '200': description: Success content: application/json: schema: type: object properties: items: type: array items: type: object required: - id - name - sku - parentId - isVariant - stockQuantity - variantCount properties: id: type: string format: uuid name: type: string sku: type: - string - 'null' parentId: type: - string - 'null' format: uuid isVariant: type: boolean stockQuantity: type: - integer - 'null' minimum: 0 description: >- Catalog stock in whole units, matching the Products page. Parent rows aggregate non-deleted variants in the same organization; virtual bundles derive stock from components and any manual cap. Null means unknown: never substitute zero for missing or null stock. This is not a sum of marketplace inventory mirrors or a per-location available-to-promise balance. variantCount: type: integer minimum: 0 description: >- Number of non-deleted variants; greater than 0 means the product has variants. A parent row's stockQuantity already includes their stock. Read the variants themselves from `GET /api/v1/products/{productId}`. status: type: string statusFacets: type: object description: >- Read-only product-wide state. Lifecycle status and derived quality/error signals are independent; this field is recalculated from current product, marketplace QC, and review flags. required: - lifecycle - derived properties: lifecycle: type: string enum: - draft - active - archived - deleted - unknown derived: type: array items: type: string enum: - flagged - errors - qc_pending - qc_rejected zaloraQualityControl: type: object hasMore: type: boolean nextOffset: type: integer summary: type: object properties: totalCount: type: integer description: >- All-tab count under the other filters, before applying the selected status. Use pagination.total for the matching result count. statusCounts: type: object additionalProperties: type: integer description: >- Counts by product status under the other selected filters. pagination: type: object description: >- Echoes the offset/limit actually applied to the query (after clamping) plus discovery metadata for paging. properties: offset: type: integer description: Offset that was applied to this page. limit: type: integer description: >- Limit that was applied to this page (after clamping to `maxLimit`). total: type: integer description: >- Total number of records matching the filters, ignoring offset/limit. hasMore: type: boolean nextOffset: type: - integer - 'null' description: Null when `hasMore` is false. maxLimit: type: integer description: Server-side maximum for the `limit` query parameter. defaultLimit: type: integer description: Default `limit` applied when none is provided. required: - offset - limit - total - hasMore - nextOffset - maxLimit - defaultLimit '401': description: Unauthorized - Invalid or missing Bearer token '403': description: Forbidden - Token not authorized for this organization '500': description: Internal Server Error 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.