Home

Developer Platform

Build on OmniCommerce marketplace-PIM rails

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

Auth

Use the API key from settings directly as a bearer token.

Authorization: Bearer omni_sk_...

MCP

Agent-callable tools share the same auth and API contracts.

CLI

Run developer workflows from local scripts and pipelines.

yarn omni evaluate --product-id PRODUCT_ID

API Products

Orders

GET

List workspace orders, create/upsert native agentic orders (including multi-SKU marketplace carts via externalOrderId + line externalOrderItemId), and patch agentic order status, currency, totals, and line price/costPrice.

GET /api/v1/orders · POST /api/v1/orders · PATCH /api/v1/orders/{orderId}

Promotions

GET

Create central promotions, assign products, and queue marketplace sync (Shopee, Lazada, TikTok, Shopify).

GET /api/v1/promotions

Price Books

GET

Manage marketplace channel list-price markup rules by platform, store, and country without changing canonical product prices.

GET /api/v1/price-books

Products

POST

Create or upsert a product by SKU, mirror images, pass LLM instructions, create variants, and queue enrichment.

POST /api/v1/products

Looks

POST

Create AI-styled product sets from catalog items, queue fast preview image generation, and poll the returned job ID.

POST /api/v1/looks

Category Recommendations

POST

Suggest marketplace categories and category attribute values for a persisted product.

POST /api/v1/manage-product-category/recommend

Connected Marketplaces

GET

List connected marketplace stores for the authenticated organization.

GET /api/v1/marketplaces/connected

Publish

POST

Publish a product to the marketplaces already enabled on that product.

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

Evaluate

POST

Score SKU readiness for agentic commerce engines.

POST /api/v1/evaluate

Agentic Checkout

POST

Create merchant-fulfilled checkout sessions, reserve inventory, and complete native agentic orders. Live settlement requires ACP or x402 configuration.

POST /api/v1/checkout-sessions

UCP Checkout

POST

Expose Universal Commerce Protocol shopping checkout and order endpoints for standards-aware agents.

POST /ucp/v1/checkout-sessions

UCP Profile

GET

Advertise Universal Commerce Protocol shopping capabilities for sitemap-first agents.

GET /.well-known/ucp

Sync

POST

Update price, sale price, and stock, then queue sync workers.

POST /api/v1/sync

Monitor

POST

Run AI Shelf Share monitoring and replay workflows.

POST /api/v1/monitor

MCP Tools

Public catalog discovery tools for tool-calling agents. Seller evaluate/sync/monitor stay on authenticated REST.

  • omni_search_catalog
  • omni_match_intent
  • omni_discover_geo

Webhooks

Subscribe to product, sync, and visibility events.

GET /api/v1/webhooksPOST /api/v1/webhooks