> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnicommerce.sg/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI reference

> Every Omni CLI command generated from the public OpenAPI spec.

The command tree is generated from `docs/openapi.json`. Run `omni --help` or `omni <resource> --help` locally for the same list.

## agents

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni agents general invoke` | `POST /api/v1/agents/general/invoke` | Invoke the Omni agent | , `--json` |
| `omni agents general start` | `POST /api/v1/agents/general/runs` | Start an Omni agent run | , `--json` |
| `omni agents general get-run` | `GET /api/v1/agents/general/runs/{runId}` | Get an Omni agent run | `--run-id`, `--organization-id?` |

## analytics

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni analytics get-ads` | `GET /api/v1/analytics/ads` | Get Ads Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-ai-traffic` | `GET /api/v1/analytics/ai-traffic` | Get AI Traffic Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--source?`, `--traffic-type?`, `--route?`, `--country?` |
| `omni analytics get-content` | `GET /api/v1/analytics/content` | Get Video and LIVE Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-orders` | `GET /api/v1/analytics/orders` | Get Order Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-overview` | `GET /api/v1/analytics/overview` | Get Growth Overview | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-pricing` | `GET /api/v1/analytics/pricing` | Get Pricing Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-products` | `GET /api/v1/analytics/products` | Get Product Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?`, `--q?`, `--product-id?`, `--limit?` |
| `omni analytics get-profit` | `GET /api/v1/analytics/profit` | Get Profit Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?`, `--sku?` |
| `omni analytics get-reports` | `GET /api/v1/analytics/reports` | Get Business Report | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-stores` | `GET /api/v1/analytics/stores` | Get Store Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |
| `omni analytics get-traffic` | `GET /api/v1/analytics/traffic` | Get Traffic Analytics | `--organization-id?`, `--from?`, `--to?`, `--time-zone?`, `--marketplace?`, `--country?`, `--store?`, `--currency?` |

## aop

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni aop get-config` | `GET /api/v1/aop/{aopId}/config` | Get AOP configuration | `--aop-id`, `--organization-id?` |
| `omni aop update-config` | `PUT /api/v1/aop/{aopId}/config` | Overwrite AOP configuration | `--aop-id`, `--json` |
| `omni aop execute` | `POST /api/v1/aop/{aopId}/execute` | Execute an AOP | `--aop-id`, `--json` |
| `omni aop create` | `POST /api/v1/aop/create` | Create AOP | , `--json` |
| `omni aop retry` | `POST /api/v1/aop/retry` | Retry a failed AOP execution | , `--json` |

## brandsgateway

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni brandsgateway import-products` | `POST /api/v1/brandsgateway/import` | Import BrandsGateway Products | , `--json` |

## campaigns

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni campaigns list` | `GET /api/v1/campaigns` | List Campaigns | `--organization-id?`, `--q?`, `--stage?`, `--offset?`, `--limit?`, `--sort-by?`, `--sort-dir?` |
| `omni campaigns create` | `POST /api/v1/campaigns` | Create Campaign | , `--json` |
| `omni campaigns get` | `GET /api/v1/campaigns/{campaignId}` | Get Campaign | `--campaign-id`, `--organization-id?` |
| `omni campaigns replace` | `PUT /api/v1/campaigns/{campaignId}` | Update Campaign | `--campaign-id`, `--json` |
| `omni campaigns actions` | `POST /api/v1/campaigns/{campaignId}/actions` | Act on Campaign | `--campaign-id`, `--json` |
| `omni campaigns archive` | `POST /api/v1/campaigns/archive` | Archive Campaigns | , `--json` |
| `omni campaigns delete` | `POST /api/v1/campaigns/delete` | Delete Campaigns | , `--json` |
| `omni campaigns get-options` | `GET /api/v1/campaigns/options` | Get Campaign Options | `--organization-id?` |

## catalog

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni catalog list-items` | `GET /api/v1/catalog/items` | Export Catalog Items | `--organization-id?`, `--updated-since?`, `--cursor?`, `--limit?`, `--format?` |

## checkout-sessions

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni checkout-sessions create` | `POST /api/v1/checkout-sessions` | Create Agentic Checkout Session | , `--json` |
| `omni checkout-sessions get` | `GET /api/v1/checkout-sessions/{sessionId}` | Get Agentic Checkout Session | `--session-id`, `--organization-id?` |
| `omni checkout-sessions update` | `PATCH /api/v1/checkout-sessions/{sessionId}` | Update Agentic Checkout Session | `--session-id`, `--organization-id?`, `--json` |
| `omni checkout-sessions replace` | `PUT /api/v1/checkout-sessions/{sessionId}` | Replace Agentic Checkout Session Fields | `--session-id`, `--organization-id?`, `--json` |
| `omni checkout-sessions cancel` | `POST /api/v1/checkout-sessions/{sessionId}/cancel` | Cancel Agentic Checkout Session | `--session-id`, `--organization-id?`, `--json` |
| `omni checkout-sessions complete` | `POST /api/v1/checkout-sessions/{sessionId}/complete` | Complete Agentic Checkout Session | `--session-id`, `--organization-id?`, `--json` |

## compare

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni compare get` | `GET /api/v1/compare` | Compare Public Products | `--products`, `--language?` |

## directory

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni directory list` | `GET /api/v1/directory` | List Public Merchants | |

## documents

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni documents upload` | `POST /api/v1/documents` | Upload Document | , `--file`, `--json` |
| `omni documents get` | `GET /api/v1/documents/{documentId}` | Get Document | `--document-id`, `--organization-id?` |

## evaluate

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni evaluate run` | `POST /api/v1/evaluate` | Evaluate SKU Readiness | , `--json` |

## feed

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni feed get-llms-txt` | `GET /api/v1/feed/{domain}/llms.txt` | Get Merchant LLM Feed | `--domain`, `--limit?` |

## images

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni images ghost-mannequin` | `POST /api/v1/images/ghost-mannequin` | Generate Ghost Mannequin Image | , `--json` |

## jobs

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni jobs get` | `GET /api/v1/jobs/{jobId}` | Get Developer Job Status | `--job-id`, `--organization-id?` |
| `omni jobs cancel` | `POST /api/v1/jobs/{jobId}/cancel` | Cancel Developer Job | `--job-id`, `--json` |
| `omni jobs wait` | `GET /api/v1/jobs/{jobId}` | Poll a developer job until the nested status is terminal | `--job-id`, `--organization-id?` |

## looks

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni looks list` | `GET /api/v1/looks` | List Looks | `--q?`, `--status?`, `--limit?`, `--offset?` |
| `omni looks create` | `POST /api/v1/looks` | Create Look | , `--json` |
| `omni looks get` | `GET /api/v1/looks/{lookId}` | Get Look | `--look-id` |

## marketplaces

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni marketplaces list-connected` | `GET /api/v1/marketplaces/connected` | List Connected Marketplaces | `--organization-id?`, `--marketplace?`, `--country?` |

## merchants

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni merchants get-manifest` | `GET /api/v1/merchants/{merchantId}/manifest` | Get Public Merchant Manifest | `--merchant-id` |
| `omni merchants list-products` | `GET /api/v1/merchants/{merchantId}/products` | List Public Merchant Products | `--merchant-id`, `--platform?`, `--country?`, `--language?`, `--limit?`, `--offset?` |
| `omni merchants search` | `GET /api/v1/merchants/{merchantId}/search` | Search Within Public Merchant Catalog | `--merchant-id`, `--currency?`, `--min-rating?`, `--min-review-count?`, `--added-after?`, `--variant-options?`, `--q?`, `--category?`, `--brand?`, `--min-price?`, `--max-price?`, `--in-stock?`, `--sort?`, `--platform?`, `--country?`, `--language?`, `--include-intent?`, `--limit?`, `--offset?` |

## monitor

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni monitor run` | `POST /api/v1/monitor` | Run AI Shelf Share Monitor | , `--json` |

## oauth

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni oauth revoke` | `POST /api/v1/oauth/revoke` | Revoke Access Token | , `--json` |
| `omni oauth token` | `POST /api/v1/oauth/token` | Get Access Token | , `--json` |

## orders

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni orders list` | `GET /api/v1/orders` | List Orders | `--organization-id?`, `--q?`, `--status?`, `--marketplace?`, `--country?`, `--store?`, `--bundle-type?`, `--sort-by?`, `--date-from?`, `--date-to?`, `--limit?`, `--offset?` |
| `omni orders create` | `POST /api/v1/orders` | Create Order | , `--json` |
| `omni orders get` | `GET /api/v1/orders/{orderId}` | Get Order | `--order-id`, `--organization-id?` |
| `omni orders update` | `PATCH /api/v1/orders/{orderId}` | Update Order | `--order-id`, `--json` |
| `omni orders get-action-options` | `GET /api/v1/orders/{orderId}/action-options` | Get Order Action Options | `--order-id`, `--organization-id?`, `--action` |
| `omni orders list-actions` | `GET /api/v1/orders/{orderId}/actions` | List Order Actions | `--order-id`, `--organization-id?` |
| `omni orders queue-action` | `POST /api/v1/orders/{orderId}/actions` | Queue Order Action | `--order-id`, `--json` |

## organizations

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni organizations create` | `POST /api/v1/organizations` | Create Organization | , `--json` |

## price-books

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni price-books list` | `GET /api/v1/price-books` | List Price Book Rules | `--organization-id?`, `--platform?`, `--enabled-only?` |
| `omni price-books create` | `POST /api/v1/price-books` | Create Price Book Rule | , `--json` |
| `omni price-books delete` | `DELETE /api/v1/price-books/{ruleId}` | Delete Price Book Rule | `--rule-id`, `--organization-id?` |
| `omni price-books get` | `GET /api/v1/price-books/{ruleId}` | Get Price Book Rule | `--rule-id`, `--organization-id?` |
| `omni price-books update` | `PATCH /api/v1/price-books/{ruleId}` | Update Price Book Rule | `--rule-id`, `--organization-id?`, `--json` |
| `omni price-books preview` | `POST /api/v1/price-books/preview` | Preview Channel List Price | , `--json` |

## product-categories

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni product-categories recommend` | `POST /api/v1/manage-product-category/recommend` | Recommend Marketplace Product Categories | , `--json` |

## products

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni products list` | `GET /api/v1/products` | List Products | `--status?`, `--marketplace?`, `--country?`, `--q?`, `--sku?`, `--min-price?`, `--max-price?`, `--sort-by?`, `--limit?`, `--offset?` |
| `omni products create` | `POST /api/v1/products` | Create Product | , `--json` |
| `omni products delete` | `DELETE /api/v1/products/{productId}` | Delete Product | `--product-id` |
| `omni products get` | `GET /api/v1/products/{productId}` | Get Product | `--product-id` |
| `omni products update` | `PATCH /api/v1/products/{productId}` | Update Product | `--product-id`, `--json` |
| `omni products update-cost` | `PATCH /api/v1/products/{productId}/cost` | Update Product Cost | `--product-id`, `--json` |
| `omni products delist` | `POST /api/v1/products/{productId}/delist` | Delist Product | `--product-id`, `--json` |
| `omni products upload-image` | `POST /api/v1/products/{productId}/images` | Upload Product Image | `--product-id`, `--file`, `--json` |
| `omni products update-inventory` | `PATCH /api/v1/products/{productId}/inventory` | Update Product Inventory | `--product-id`, `--json` |
| `omni products get-listings` | `GET /api/v1/products/{productId}/listings` | Get Product Listings | `--product-id`, `--organization-id?` |
| `omni products update-price` | `PATCH /api/v1/products/{productId}/price` | Update Product Price | `--product-id`, `--json` |
| `omni products publish` | `POST /api/v1/products/{productId}/publish` | Publish Product | `--product-id`, `--json` |
| `omni products bulk-import` | `POST /api/v1/products/bulk-import` | Bulk Import Products from JSON or CSV | , `--json` |
| `omni products compare-prices` | `POST /api/v1/products/compare-prices` | Compare Product Market Prices | , `--json` |
| `omni products get-price-comparison` | `GET /api/v1/products/compare-prices/jobs/{jobId}` | Get Product Price Comparison | `--job-id`, `--organization-id?` |
| `omni products update-costs` | `POST /api/v1/products/cost` | Batch Update Product Cost | , `--json` |
| `omni products enrich` | `POST /api/v1/products/enrich` | Queue Product Enrichment | , `--json` |

## promotions

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni promotions list` | `GET /api/v1/promotions` | List Promotions | `--organization-id?`, `--q?`, `--status?`, `--marketplace?`, `--store?`, `--sort-by?`, `--sort-dir?`, `--limit?`, `--offset?` |
| `omni promotions create` | `POST /api/v1/promotions` | Create Promotion | , `--json` |
| `omni promotions delete` | `DELETE /api/v1/promotions/{promotionId}` | Delete Promotion | `--promotion-id`, `--organization-id?` |
| `omni promotions get` | `GET /api/v1/promotions/{promotionId}` | Get Promotion | `--promotion-id`, `--organization-id?` |
| `omni promotions update` | `PATCH /api/v1/promotions/{promotionId}` | Update Promotion | `--promotion-id`, `--organization-id?`, `--json` |
| `omni promotions remove-products` | `DELETE /api/v1/promotions/{promotionId}/products` | Unassign Products from Promotion | `--promotion-id`, `--organization-id?`, `--json` |
| `omni promotions list-products` | `GET /api/v1/promotions/{promotionId}/products` | List Promotion Assignments | `--promotion-id`, `--organization-id?` |
| `omni promotions add-products` | `POST /api/v1/promotions/{promotionId}/products` | Assign Products to Promotion | `--promotion-id`, `--organization-id?`, `--json` |
| `omni promotions retry` | `POST /api/v1/promotions/{promotionId}/retry` | Retry Marketplace Delivery | `--promotion-id`, `--organization-id?`, `--json` |

## returns

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni returns list` | `GET /api/v1/returns` | List Returns | `--organization-id?`, `--marketplace?`, `--account-id?`, `--external-order-id?`, `--updated-since?`, `--cursor?`, `--limit?` |
| `omni returns get` | `GET /api/v1/returns/{returnId}` | Get Return | `--return-id`, `--organization-id?` |

## reviews

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni reviews list` | `GET /api/v1/reviews` | List Reviews | `--organization-id?`, `--q?`, `--marketplace?`, `--status?`, `--priority?`, `--store?`, `--product-id?`, `--sort-by?`, `--limit?`, `--offset?` |
| `omni reviews get` | `GET /api/v1/reviews/{reviewId}` | Get Review | `--review-id`, `--organization-id?` |
| `omni reviews reply` | `POST /api/v1/reviews/{reviewId}/reply` | Reply to Review | `--review-id`, `--json` |

## search

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni search list` | `GET /api/v1/search` | Search Public Merchant Products | `--currency?`, `--min-rating?`, `--min-review-count?`, `--added-after?`, `--variant-options?`, `--q?`, `--category?`, `--brand?`, `--min-price?`, `--max-price?`, `--in-stock?`, `--merchant-ids?`, `--sort?`, `--platform?`, `--country?`, `--language?`, `--include-intent?`, `--limit?`, `--offset?` |
| `omni search query` | `POST /api/v1/search` | Search Public Merchant Products | `--currency?`, `--min-rating?`, `--min-review-count?`, `--added-after?`, `--variant-options?`, `--q?`, `--category?`, `--brand?`, `--min-price?`, `--max-price?`, `--in-stock?`, `--merchant-ids?`, `--sort?`, `--platform?`, `--country?`, `--language?`, `--include-intent?`, `--limit?`, `--offset?`, `--json` |

## settlements

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni settlements list` | `GET /api/v1/settlements` | List Settlements | `--organization-id?`, `--marketplace?`, `--account-id?`, `--order-id?`, `--external-order-id?`, `--updated-since?`, `--cursor?`, `--limit?` |
| `omni settlements create` | `POST /api/v1/settlements` | Apply Settlements | , `--json` |
| `omni settlements get` | `GET /api/v1/settlements/{settlementId}` | Get Settlement | `--settlement-id`, `--organization-id?` |

## sync

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni sync run` | `POST /api/v1/sync` | Sync Product Commercial Fields | , `--json` |

## threads

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni threads get-status` | `GET /api/v1/threads/{thread_id}/status` | Get Thread Status | `--thread-id`, `--include-messages?`, `--organization-id?` |

## ucp

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni ucp checkout-sessions create` | `POST /ucp/v1/checkout-sessions` | Create UCP Checkout Session | , `--json` |
| `omni ucp checkout-sessions get` | `GET /ucp/v1/checkout-sessions/{sessionId}` | Get UCP Checkout Session | `--session-id`, `--organization-id?` |
| `omni ucp checkout-sessions update` | `PATCH /ucp/v1/checkout-sessions/{sessionId}` | Update UCP Checkout Session | `--session-id`, `--organization-id?`, `--json` |
| `omni ucp checkout-sessions replace` | `PUT /ucp/v1/checkout-sessions/{sessionId}` | Replace UCP Checkout Session Fields | `--session-id`, `--organization-id?`, `--json` |
| `omni ucp checkout-sessions cancel` | `POST /ucp/v1/checkout-sessions/{sessionId}/cancel` | Cancel UCP Checkout Session | `--session-id`, `--organization-id?`, `--json` |
| `omni ucp checkout-sessions complete` | `POST /ucp/v1/checkout-sessions/{sessionId}/complete` | Complete UCP Checkout Session | `--session-id`, `--organization-id?`, `--json` |
| `omni ucp orders get` | `GET /ucp/v1/orders/{orderId}` | Get UCP Order | `--order-id`, `--organization-id?` |

## webhook-events

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni webhook-events list` | `GET /api/v1/webhook-events` | List Webhook Events | `--organization-id?`, `--event-type?`, `--occurred-since?`, `--cursor?`, `--limit?` |

## webhooks

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni webhooks list` | `GET /api/v1/webhooks` | List Developer Webhooks | |
| `omni webhooks create` | `POST /api/v1/webhooks` | Create Developer Webhook | , `--json` |

## zalora

| Command | Endpoint | Summary | Flags |
| - | - | - | - |
| `omni zalora get-import` | `GET /api/v1/zalora/import` | Get Selected Zalora Import Status | `--organization-id?`, `--job-id`, `--store-id`, `--product-set-ids` |
| `omni zalora import-products` | `POST /api/v1/zalora/import` | Import Selected Zalora Products | , `--json` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.