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

# API Reference

> Interactive OpenAPI reference for OmniCommerce public and authenticated developer APIs.

Use the playground on each endpoint page to send real requests. Authenticate with:

```http theme={null}
Authorization: Bearer $OMNI_API_KEY
```

## Spec

* Download: [openapi.json](https://docs.omnicommerce.sg/openapi.json)
* Live app host: `https://omnicommerce.sg`
* Local: `http://localhost:3000`

## Groups

REST endpoints remain under **Endpoints**, grouped by OpenAPI tag. AOP
operations (`/api/v1/aop/*` and thread status) appear under **AOPs**. All 18
outbound event operations are in the separate **Webhooks** section, grouped
into Product, Orders, Returns, Settlements, and Looks.

## Guides

For narrative docs beyond the generated reference:

* [Catalog updates](https://docs.omnicommerce.sg/guides/catalog-updates.md)
* [Orders](https://docs.omnicommerce.sg/guides/orders.md)
* [Settlements](https://docs.omnicommerce.sg/guides/settlements.md)
* [Promotions](https://docs.omnicommerce.sg/guides/promotions.md)
* [Campaigns](https://docs.omnicommerce.sg/guides/campaigns.md)
* [Price books](https://docs.omnicommerce.sg/guides/price-books.md)
* [Bulk product import](https://docs.omnicommerce.sg/guides/bulk-product-import.md)
* [Ghost mannequin](https://docs.omnicommerce.sg/guides/ghost-mannequin.md)
* [AOPs](https://docs.omnicommerce.sg/guides/aops.md)
* [Omni agent](https://docs.omnicommerce.sg/guides/agent.md)
* [Webhooks](https://docs.omnicommerce.sg/webhooks/overview.md)
* [Return webhooks](https://docs.omnicommerce.sg/webhooks/returns.md)
* [Webhook event catalog](https://docs.omnicommerce.sg/webhooks/event-catalog.md)
* [Authentication](https://docs.omnicommerce.sg/authentication.md)
* [MCP](https://docs.omnicommerce.sg/guides/mcp.md)


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