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

# Await Commerce Jobs

> Wait for a mixed batch of returned commerce correlations: inventory_job, price_event, price_book_sync, publish_job, delist_batch, store_switch, omni_delete, zalora_import, enrichment_batch, order_action and return_action. Maximum 50000 entries; IDs are trimmed and duplicates collapse by kind/id in first-requested order. timeoutMs=0 reads once; bounded waits allow up to 120000ms. Catalog jobs require catalog:read; order/return jobs require orders:read; mixed batches require both. Session callers include organizationId. Every job retains its target identity, status, errors and available label artifacts. Missing or inaccessible fulfillment jobs fail explicitly. needs_review is an uncertain outcome, never automatic success or authorization to resubmit. data.success describes completion; use state verification before claiming a marketplace effect. Scheduled future actions are verified after execution, not when scheduled.



## OpenAPI

````yaml /openapi.json post /api/v1/commerce/jobs/await
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/jobs/await:
    post:
      tags:
        - commerce
      summary: Await Commerce Jobs
      description: >-
        Wait for a mixed batch of returned commerce correlations: inventory_job,
        price_event, price_book_sync, publish_job, delist_batch, store_switch,
        omni_delete, zalora_import, enrichment_batch, order_action and
        return_action. Maximum 50000 entries; IDs are trimmed and duplicates
        collapse by kind/id in first-requested order. timeoutMs=0 reads once;
        bounded waits allow up to 120000ms. Catalog jobs require catalog:read;
        order/return jobs require orders:read; mixed batches require both.
        Session callers include organizationId. Every job retains its target
        identity, status, errors and available label artifacts. Missing or
        inaccessible fulfillment jobs fail explicitly. needs_review is an
        uncertain outcome, never automatic success or authorization to resubmit.
        data.success describes completion; use state verification before
        claiming a marketplace effect. Scheduled future actions are verified
        after execution, not when scheduled.
      operationId: post_v1_commerce_jobs_await
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                correlations:
                  description: >-
                    Every returned commerce job correlation, including orders
                    and returns. Maximum 50000; trimmed and deduplicated in
                    first-requested order.
                  maxItems: 50000
                  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
                timeoutMs:
                  description: >-
                    Wait budget in milliseconds; 0 is one status read. Maximum
                    120000.
                  type: integer
                  minimum: 0
                  maximum: 120000
                organizationId:
                  type: string
                  minLength: 1
                  maxLength: 120
              required:
                - correlations
              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
                      allTerminal:
                        type: boolean
                      timedOut:
                        type: boolean
                      jobs:
                        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
                            status:
                              type: string
                              enum:
                                - pending
                                - running
                                - success
                                - error
                                - superseded
                                - skipped
                                - unknown
                            terminal:
                              type: boolean
                            orderId:
                              type: string
                            returnId:
                              type: string
                            productId:
                              type: string
                            productIds:
                              type: array
                              items:
                                type: string
                            platform:
                              type: string
                            storeId:
                              type: string
                            action:
                              type: string
                            sourceStatus:
                              type: string
                            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
                            error:
                              type: string
                            message:
                              type: string
                            updatedAt:
                              type: string
                            externalIds:
                              type: array
                              items:
                                type: string
                            missingExternalIds:
                              type: array
                              items:
                                type: string
                            evidence:
                              type: object
                              properties:
                                accepted:
                                  type: boolean
                                verified:
                                  type: boolean
                                statusBefore:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                                statusAfter:
                                  anyOf:
                                    - type: string
                                    - type: 'null'
                            verification:
                              type: object
                              properties:
                                ok:
                                  type: boolean
                                verified:
                                  type: boolean
                                skipped:
                                  type: boolean
                                reason:
                                  type: string
                                expectedQuantity:
                                  type: number
                                actualQuantity:
                                  anyOf:
                                    - type: number
                                    - type: 'null'
                                evidence:
                                  type: string
                                verifiedAt:
                                  type: string
                              required:
                                - ok
                                - verified
                                - skipped
                            operations:
                              type: object
                              properties:
                                delist:
                                  type: object
                                  properties:
                                    status:
                                      type: string
                                    result:
                                      anyOf:
                                        - type: object
                                          propertyNames:
                                            type: string
                                          additionalProperties: {}
                                        - type: 'null'
                                  required:
                                    - status
                                    - result
                                publish:
                                  type: object
                                  properties:
                                    status:
                                      type: string
                                    result:
                                      anyOf:
                                        - type: object
                                          propertyNames:
                                            type: string
                                          additionalProperties: {}
                                        - type: 'null'
                                  required:
                                    - status
                                    - result
                              required:
                                - delist
                                - publish
                          required:
                            - kind
                            - id
                            - status
                            - terminal
                      pendingCount:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                    required:
                      - success
                      - succeededCount
                      - failedCount
                      - correlations
                      - message
                      - allTerminal
                      - timedOut
                      - jobs
                      - pendingCount
                  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.