Quickstart

Use REST, MCP, CLI, and webhooks to create enriched catalog data, evaluate agentic readiness, sync commercial fields, and monitor AI Shelf Share.

Prerequisites

An OmniCommerce organization
An API key from organization settings (omni_sk_...)
Base URL https://omnicommerce.sg (or your local/dev host)

Authenticate

Authorization: Bearer $OMNI_API_KEY
Content-Type: application/json

API keys are bound to a single organization. You do not need to send organizationId for API-key requests. Session-authenticated browser calls must include organizationId in the query or body. Full details: Authentication.

Core workflow

1. Create or upsert a product

curl -X POST "https://omnicommerce.sg/api/v1/products" \
  -H "Authorization: Bearer $OMNI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "SKU-100",
    "title": "Sample product",
    "price": 29.9,
    "currency": "SGD"
  }'

2. Poll async jobs

Many write paths return a job ID. Poll:

GET /api/v1/jobs/{jobId}

Cancel with:

POST /api/v1/jobs/{jobId}/cancel

3. Publish and sync

POST /api/v1/products/{productId}/publish
POST /api/v1/sync

API products

Product	What it does	Start here
Products	Create/upsert, variants, bulk import, publish	API · Bulk import guide
Orders	List workspace orders; create/patch agentic orders	Orders guide
Promotions	Central promos, product assignment, marketplace sync	Promotions guide
Price books	Channel list-price markup without changing canonical prices	Price books guide
Looks	AI-styled product sets and preview jobs	API reference
Evaluate	Score SKU readiness for agentic commerce	`POST /api/v1/evaluate`
Ghost mannequin	Remove mannequins from product photos	Guide
Agentic checkout	Merchant-fulfilled checkout sessions	`POST /api/v1/checkout-sessions`
UCP	Universal Commerce Protocol shopping	`POST /ucp/v1/checkout-sessions`
Monitor	AI Shelf Share monitoring and replay	`POST /api/v1/monitor`
Webhooks	Product, sync, and visibility events	`GET/POST /api/v1/webhooks`

MCP tools

Public catalog discovery tools for tool-calling agents:

omni_search_catalog
omni_match_intent
omni_discover_geo

Seller evaluate/sync/monitor stay on authenticated REST. See MCP.

CLI

yarn omni evaluate --product-id PRODUCT_ID

Next steps

Interactive API reference

Try endpoints with the Mintlify playground.

Orders guide

Filters, agentic create, and pricing fields.

MCP reference

JSON-RPC methods and tool contracts.

Authentication

Scopes, OAuth, and session rules.

Get started

Guides

MCP

Prerequisites

Authenticate

Core workflow

1. Create or upsert a product

2. Poll async jobs

3. Publish and sync

API products

MCP tools

CLI

Next steps

Interactive API reference

Orders guide

MCP reference

Authentication

​Prerequisites

​Authenticate

​Core workflow

​1. Create or upsert a product

​2. Poll async jobs

​3. Publish and sync

​API products

​MCP tools

​CLI

​Next steps

Interactive API reference

Orders guide

MCP reference

Authentication

Prerequisites

Authenticate

Core workflow

1. Create or upsert a product

2. Poll async jobs

3. Publish and sync

API products

MCP tools

CLI

Next steps