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

# Publish Product

> ### Publishing

Queue durable marketplace publish/update jobs for a product. Omit marketplaces to use every enabled or already listed marketplace, or name the marketplaces to target. Omit updateFields for a full publish with live/draft visibility. Set updateFields to update only saved values for those fields on existing listings with assigned stores; other fields and listing visibility stay unchanged. No new listing is created by a selected-field update.

### Marketplace capabilities

SEO is Shopify-only; highlights support Lazada, TikTok and Amazon; attributes exclude WhatsApp. Category-only updates require a full publish on TikTok and Amazon. Unsupported combinations and missing listings/stores return explicit per-marketplace failures while valid targets continue.

### Completion

Accepted means queued; inspect every result and await every jobId and inventory correlation with jobs.wait, then verify the listings.



## OpenAPI

````yaml /openapi.json post /api/v1/products/{productId}/publish
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/{productId}/publish:
    post:
      tags:
        - products
      summary: Publish Product
      description: >-
        ### Publishing


        Queue durable marketplace publish/update jobs for a product. Omit
        marketplaces to use every enabled or already listed marketplace, or name
        the marketplaces to target. Omit updateFields for a full publish with
        live/draft visibility. Set updateFields to update only saved values for
        those fields on existing listings with assigned stores; other fields and
        listing visibility stay unchanged. No new listing is created by a
        selected-field update.


        ### Marketplace capabilities


        SEO is Shopify-only; highlights support Lazada, TikTok and Amazon;
        attributes exclude WhatsApp. Category-only updates require a full
        publish on TikTok and Amazon. Unsupported combinations and missing
        listings/stores return explicit per-marketplace failures while valid
        targets continue.


        ### Completion


        Accepted means queued; inspect every result and await every jobId and
        inventory correlation with jobs.wait, then verify the listings.
      operationId: post_v1_products_by_productid_publish
      parameters:
        - name: productId
          in: path
          required: true
          description: OmniCommerce product ID to publish.
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                organizationId:
                  type: string
                  description: >-
                    Optional for API-key requests; required for
                    session-authenticated requests across multiple
                    organizations.
                marketplaces:
                  type: array
                  minItems: 1
                  maxItems: 8
                  items:
                    type: string
                    enum:
                      - lazada
                      - shopee
                      - tiktok
                      - shopify
                      - whatsapp
                      - zalora
                      - amazon
                      - ebay
                  description: >-
                    Optional marketplaces to publish/update. Omit to target
                    every enabled or already listed marketplace. Duplicates are
                    removed in first-requested order.
                updateFields:
                  type: array
                  minItems: 1
                  maxItems: 9
                  items:
                    type: string
                    enum:
                      - name
                      - description
                      - images
                      - category
                      - attributes
                      - highlights
                      - seo
                      - price
                      - inventory
                  description: >-
                    Optional fields to publish from saved product data to
                    existing listings only. Omit for all fields. Other fields
                    and listing visibility remain unchanged. Empty/unknown
                    fields are rejected; duplicates are removed. Platform
                    capability limits appear in per-target results.
                visibility:
                  type: string
                  enum:
                    - live
                    - draft
                  default: live
                  description: Publish visibility mode.
            example:
              marketplaces:
                - shopee
                - lazada
              updateFields:
                - name
                - description
                - images
      responses:
        '202':
          description: Publish jobs queued.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  apiVersion:
                    type: string
                    default: developer_v1
                  operationId:
                    type: string
                  status:
                    type: string
                    enum:
                      - accepted
                  productId:
                    type: string
                  jobId:
                    type: string
                  data:
                    type: object
                    properties:
                      queued:
                        type: boolean
                      jobBatchId:
                        type: string
                      results:
                        type: array
                        items:
                          type: object
                          required:
                            - ok
                            - productId
                          additionalProperties: true
                          properties:
                            ok:
                              type: boolean
                            queued:
                              type: boolean
                            productId:
                              type: string
                            sourceProductId:
                              type: string
                            productName:
                              type: string
                            marketplace:
                              type: string
                              enum:
                                - lazada
                                - shopee
                                - tiktok
                                - shopify
                                - whatsapp
                                - zalora
                                - amazon
                                - ebay
                            action:
                              type: string
                              enum:
                                - created
                                - updated
                            visibility:
                              type: string
                              enum:
                                - live
                                - draft
                              description: >-
                                Requested visibility; selected-field updates
                                preserve existing listing visibility.
                            updateFields:
                              type: array
                              items:
                                type: string
                                enum:
                                  - name
                                  - description
                                  - images
                                  - category
                                  - attributes
                                  - highlights
                                  - seo
                                  - price
                                  - inventory
                            jobId:
                              type: string
                              description: Await this durable job with jobs.wait.
                            error:
                              type: string
                            status:
                              type: integer
                            message:
                              type: string
                            correlations:
                              type: array
                              items:
                                type: object
                                required:
                                  - kind
                                  - id
                                properties:
                                  kind:
                                    type: string
                                    enum:
                                      - inventory_job
                                  id:
                                    type: string
                                    description: >-
                                      Inventory job ID; await every returned
                                      correlation with jobs.wait.
                                  platform:
                                    type: string
                                    enum:
                                      - lazada
                                      - shopee
                                      - tiktok
                                      - shopify
                                      - whatsapp
                                      - zalora
                                      - amazon
                                      - ebay
                                  storeId:
                                    type: string
                                  productId:
                                    type: string
        '400':
          description: >-
            Bad Request - invalid payload, marketplace not enabled, or store
            selection required
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Product Not Found
        '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.