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

# Queue Product Enrichment

> Requires catalog:enrich. Queue content enrichment for 1–1,000 existing Omni product IDs across all supported marketplaces. Returns 202 after queue submission without awaiting AI completion or publishing.

### Enrichment options

Fields, instructions and auto-apply settings use the canonical enrichment service. Exclude name from selectedFields to preserve titles. Weight and dimensions are always included; image and taxonomy workflows are not queued here.

autoApplyHighConfidence defaults to false. When enabled, the supplied threshold (0.62–1) or organization threshold applies; low-confidence or blocked proposals remain in Review. AI usage is billed to the authenticated organization. Open links.review to inspect results.



## OpenAPI

````yaml /openapi.json post /api/v1/products/enrich
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: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: commerce
    description: Root commerce discovery
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - 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, and publish
    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: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/products/enrich:
    post:
      tags:
        - developer-platform
      summary: Queue Product Enrichment
      description: >-
        Requires catalog:enrich. Queue content enrichment for 1–1,000 existing
        Omni product IDs across all supported marketplaces. Returns 202 after
        queue submission without awaiting AI completion or publishing.


        ### Enrichment options


        Fields, instructions and auto-apply settings use the canonical
        enrichment service. Exclude name from selectedFields to preserve titles.
        Weight and dimensions are always included; image and taxonomy workflows
        are not queued here.


        autoApplyHighConfidence defaults to false. When enabled, the supplied
        threshold (0.62–1) or organization threshold applies; low-confidence or
        blocked proposals remain in Review. AI usage is billed to the
        authenticated organization. Open links.review to inspect results.
      operationId: post_v1_products_enrich
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                organizationId:
                  description: >-
                    Required for session auth; derived from the credential for
                    bearer auth.
                  type: string
                  minLength: 1
                  maxLength: 255
                productIds:
                  minItems: 1
                  maxItems: 1000
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 255
                  description: >-
                    Existing Omni product IDs. Trimmed and deduplicated in
                    requested order; at most 1,000 entries.
                selectedFields:
                  description: >-
                    Fields to enrich. Omit for all content fields. Weight and
                    dimensions are always included by the enrichment service.
                    Exclude name to preserve the product title.
                  minItems: 1
                  maxItems: 7
                  type: array
                  items:
                    type: string
                    enum:
                      - name
                      - description
                      - highlights
                      - seoTitle
                      - seoDescription
                      - weight
                      - dimensions
                instructions:
                  type: string
                  maxLength: 2000
                title:
                  type: string
                  maxLength: 120
                autoApplyHighConfidence:
                  type: boolean
                  default: false
                enrichmentAutoApplyThreshold:
                  description: >-
                    Confidence threshold for automatic application when enabled.
                    Omit to use the organization's threshold.
                  type: number
                  minimum: 0.62
                  maximum: 1
              required:
                - productIds
              additionalProperties: false
            example:
              productIds:
                - omni-product-id
              selectedFields:
                - description
              instructions: >-
                Do not change the title. Do not add warranty or return
                information.
              autoApplyHighConfidence: true
              enrichmentAutoApplyThreshold: 0.7
      responses:
        '202':
          description: Jobs accepted for background processing.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - status
                  - jobId
                  - data
                  - links
                properties:
                  ok:
                    type: boolean
                  apiVersion:
                    type: string
                  operationId:
                    type: string
                  status:
                    type: string
                    enum:
                      - accepted
                  jobId:
                    type: string
                  links:
                    type: object
                    additionalProperties:
                      type: string
                  warnings:
                    type: array
                    items:
                      type: string
                  recommendations:
                    type: array
                    items:
                      type: string
                  data:
                    type: object
                    required:
                      - success
                      - queued
                      - productIds
                      - jobIds
                      - succeededCount
                      - failedCount
                      - results
                    properties:
                      success:
                        type: boolean
                        description: >-
                          True when all requested targets were accepted for
                          processing. Does not mean processing completed.
                      queued:
                        type: boolean
                      productIds:
                        type: array
                        items:
                          type: string
                      jobIds:
                        type: array
                        items:
                          type: string
                      succeededCount:
                        type: integer
                        minimum: 0
                      failedCount:
                        type: integer
                        minimum: 0
                      batchJobId:
                        type: string
                      enrichmentBatchId:
                        type: string
                      results:
                        type: array
                        items:
                          type: object
                          required:
                            - productId
                            - success
                            - jobId
                          properties:
                            productId:
                              type: string
                            success:
                              type: boolean
                            jobId:
                              type: string
        '400':
          description: >-
            Invalid request or queue preparation failed. Inspect the error
            before resubmitting.
        '401':
          description: Missing or invalid credentials.
        '403':
          description: >-
            Missing scope, insufficient permission, organization mismatch, or
            inactive organization.
        '404':
          description: Target not found in the authenticated organization.
        '409':
          description: An import or enrichment job is already active for the target.
        '429':
          description: Rate limit exceeded.
      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.

````