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

# Verify Commerce State

> Perform fresh marketplace verification using the canonical services for every supported marketplace. For products provide productIds plus expected, or targets[{productId,expected}] for mixed values. For order, return and price-book operations provide their returned order_action/return_action/price_book_sync correlations; product and fulfillment checks may share one request. Maximum 50000 entries per target array, with bounded concurrency. Catalog verification requires catalog:read; fulfillment verification requires orders:read; mixed batches require both. Session callers include organizationId. Missing, unauthorized, unsupported and unconfirmed targets fail explicitly. A return decision can be confirmed while later lifecycle steps remain pending. Labels confirm generated artifacts, not physical printing. Provider acceptance alone does not establish a changed state; tracking omitted by the provider remains unconfirmed. This read never resubmits a marketplace action.



## OpenAPI

````yaml /openapi.json post /api/v1/commerce/state/verify
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: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - 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: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/commerce/state/verify:
    post:
      tags:
        - commerce
      summary: Verify Commerce State
      description: >-
        Perform fresh marketplace verification using the canonical services for
        every supported marketplace. For products provide productIds plus
        expected, or targets[{productId,expected}] for mixed values. For order,
        return and price-book operations provide their returned
        order_action/return_action/price_book_sync correlations; product and
        fulfillment checks may share one request. Maximum 50000 entries per
        target array, with bounded concurrency. Catalog verification requires
        catalog:read; fulfillment verification requires orders:read; mixed
        batches require both. Session callers include organizationId. Missing,
        unauthorized, unsupported and unconfirmed targets fail explicitly. A
        return decision can be confirmed while later lifecycle steps remain
        pending. Labels confirm generated artifacts, not physical printing.
        Provider acceptance alone does not establish a changed state; tracking
        omitted by the provider remains unconfirmed. This read never resubmits a
        marketplace action.
      operationId: post_v1_commerce_state_verify
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                correlations:
                  description: >-
                    Order, return or price-book sync correlations. May accompany
                    product targets.
                  minItems: 1
                  maxItems: 50000
                  type: array
                  items:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - order_action
                          - return_action
                          - price_book_sync
                      id:
                        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)$
                      platform:
                        type: string
                        minLength: 1
                      storeId:
                        type: string
                        minLength: 1
                      productId:
                        type: string
                        minLength: 1
                      productIds:
                        maxItems: 500
                        type: array
                        items:
                          type: string
                          minLength: 1
                      externalIds:
                        maxItems: 500
                        type: array
                        items:
                          type: string
                          minLength: 1
                    required:
                      - kind
                      - id
                productIds:
                  description: >-
                    Product or variant ids to verify together. Use every
                    distinct productId returned by the completed commerce jobs
                    (max 50000, bounded concurrency).
                  minItems: 1
                  maxItems: 50000
                  type: array
                  items:
                    type: string
                    minLength: 1
                expected:
                  description: >-
                    Expected commerce state after a write (price, quantity,
                    listingStatus, etc).
                  type: object
                  properties:
                    price:
                      type: number
                    salePrice:
                      anyOf:
                        - type: number
                        - type: 'null'
                    currency:
                      type: string
                      pattern: ^[A-Za-z]{3}$
                    quantity:
                      type: integer
                      minimum: 0
                      maximum: 9007199254740991
                    listingStatus:
                      type: string
                      enum:
                        - active
                        - draft
                        - unlisted
                        - deleted
                    platforms:
                      type: array
                      items:
                        type: string
                        minLength: 1
                targets:
                  description: >-
                    Per-product expected states for a mixed-value batch. Use
                    every successful item's productId and
                    commerceReceipt.expected together. Do not combine with
                    productIds or shared expected. Identical duplicates are
                    deduplicated; conflicting expectations are rejected.
                  minItems: 1
                  maxItems: 50000
                  type: array
                  items:
                    type: object
                    properties:
                      productId:
                        type: string
                        minLength: 1
                        maxLength: 255
                      expected:
                        type: object
                        properties:
                          price:
                            type: number
                          salePrice:
                            anyOf:
                              - type: number
                              - type: 'null'
                          currency:
                            type: string
                            pattern: ^[A-Za-z]{3}$
                          quantity:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          listingStatus:
                            type: string
                            enum:
                              - active
                              - draft
                              - unlisted
                              - deleted
                          platforms:
                            type: array
                            items:
                              type: string
                              minLength: 1
                    required:
                      - productId
                      - expected
                    additionalProperties: false
                action:
                  description: >-
                    Lifecycle action being verified. Use delete for Omni-only
                    delete checks.
                  type: string
                  enum:
                    - price
                    - inventory
                    - publish
                    - update
                    - delist
                    - delete
                platforms:
                  description: >-
                    Optional marketplace filter: shopee, lazada, tiktok,
                    shopify, whatsapp, zalora, amazon, ebay.
                  type: array
                  items:
                    type: string
                    minLength: 1
                includeOmni:
                  description: Also assert Omni DB fields (default true).
                  type: boolean
                organizationId:
                  type: string
                  minLength: 1
                  maxLength: 120
              additionalProperties: false
      responses:
        '200':
          description: >-
            Request completed. Inspect data.success, per-target results and
            pendingCount for processing progress.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - apiVersion
                  - operationId
                  - status
                  - data
                  - links
                  - warnings
                  - recommendations
                properties:
                  ok:
                    type: boolean
                  apiVersion:
                    type: string
                  operationId:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - completed
                  data:
                    type: object
                    properties:
                      success:
                        type: boolean
                      succeededCount:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      failedCount:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      productIds:
                        type: array
                        items:
                          type: string
                      orderIds:
                        type: array
                        items:
                          type: string
                      returnIds:
                        type: array
                        items:
                          type: string
                      correlations:
                        type: array
                        items:
                          type: object
                          properties:
                            kind:
                              type: string
                              enum:
                                - inventory_job
                                - price_event
                                - price_book_sync
                                - publish_job
                                - delist_batch
                                - store_switch
                                - omni_delete
                                - zalora_import
                                - enrichment_batch
                                - order_action
                                - return_action
                            id:
                              type: string
                              minLength: 1
                              maxLength: 200
                            platform:
                              type: string
                              minLength: 1
                            storeId:
                              type: string
                              minLength: 1
                            productId:
                              type: string
                              minLength: 1
                            productIds:
                              maxItems: 500
                              type: array
                              items:
                                type: string
                                minLength: 1
                            externalIds:
                              maxItems: 500
                              type: array
                              items:
                                type: string
                                minLength: 1
                          required:
                            - kind
                            - id
                      message:
                        type: string
                      results:
                        type: array
                        items:
                          type: object
                          properties:
                            success:
                              type: boolean
                            productId:
                              type: string
                            rootProductId:
                              type: string
                            verification:
                              type: array
                              items:
                                type: object
                                properties:
                                  ok:
                                    type: boolean
                                  target:
                                    type: string
                                  evidence:
                                    type: string
                                  action:
                                    type: string
                                  platform:
                                    type: string
                                  storeId:
                                    type: string
                                  productId:
                                    type: string
                                  expected:
                                    type: string
                                  actual:
                                    type: string
                                required:
                                  - ok
                                  - target
                                  - evidence
                            listings:
                              type: array
                              items:
                                type: object
                                propertyNames:
                                  type: string
                                additionalProperties: {}
                            omni:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                            message:
                              type: string
                          required:
                            - success
                            - productId
                            - verification
                            - listings
                            - message
                      jobs:
                        type: array
                        items:
                          type: object
                          properties:
                            kind:
                              type: string
                              enum:
                                - order_action
                                - return_action
                                - price_book_sync
                            id:
                              type: string
                            success:
                              type: boolean
                            orderId:
                              type: string
                            returnId:
                              type: string
                            productIds:
                              type: array
                              items:
                                type: string
                            results:
                              type: array
                              items:
                                type: object
                                properties:
                                  productId:
                                    type: string
                                  targetId:
                                    type: string
                                  platform:
                                    type: string
                                  storeId:
                                    type: string
                                  success:
                                    type: boolean
                                  evidence:
                                    type: string
                                  checks:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        country:
                                          anyOf:
                                            - type: string
                                            - type: 'null'
                                        currency:
                                          anyOf:
                                            - type: string
                                            - type: 'null'
                                        expectedPrice:
                                          anyOf:
                                            - type: number
                                            - type: 'null'
                                        actualPrice:
                                          anyOf:
                                            - type: number
                                            - type: 'null'
                                        success:
                                          type: boolean
                                      required:
                                        - country
                                        - currency
                                        - expectedPrice
                                        - actualPrice
                                        - success
                                required:
                                  - productId
                                  - targetId
                                  - success
                                  - evidence
                            action:
                              type: string
                            platform:
                              type: string
                            evidence:
                              type: string
                            status:
                              type: string
                            statusBefore:
                              anyOf:
                                - type: string
                                - type: 'null'
                            statusAfter:
                              anyOf:
                                - type: string
                                - type: 'null'
                            labels:
                              type: array
                              items:
                                type: object
                                properties:
                                  url:
                                    type: string
                                    format: uri
                                  name:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                  mimeType:
                                    anyOf:
                                      - type: string
                                      - type: 'null'
                                required:
                                  - url
                                  - name
                                  - mimeType
                          required:
                            - kind
                            - id
                            - success
                            - evidence
                    required:
                      - success
                      - succeededCount
                      - failedCount
                      - correlations
                      - message
                      - results
                      - jobs
                  links:
                    type: object
                    additionalProperties:
                      type: string
                  warnings:
                    type: array
                    items:
                      type: string
                  recommendations:
                    type: array
                    items:
                      type: string
        '400':
          description: >-
            Invalid request, conflicting operations, singular arguments or a
            batch exceeding the endpoint limit.
        '401':
          description: Missing or invalid credentials.
        '403':
          description: >-
            Missing scope, organization mismatch, or a target outside the
            caller's assigned stores and markets.
        '429':
          description: Rate limit exceeded.
        '503':
          description: >-
            Service unavailable. Retry a submission with the same requestId and
            unchanged operations.
      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.