Introduction
The Linra Omni partner API. Every path in this document is a live route on the partner
The Linra Omni partner API. Every path in this document is a live route on the partner
Gateway (https://api-omni.linra.net, staging https://api-omni-stg.linra.net), under the
/api/v1 prefix. Admin and internal endpoints are not part of this API.
Base URL
Section titled “Base URL”| Environment | URL |
|---|---|
| Production (live) | https://api-omni.linra.net |
| Staging (live) | https://api-omni-stg.linra.net |
| Local development (Gateway default port) | http://localhost:5298 |
Authentication
Section titled “Authentication”A partner access token from POST /api/v1/auth/token (audience partner-api, 5-minute lifetime).
See the Authentication guide for the full exchange flow.
Rate limits & errors
Section titled “Rate limits & errors”Resources
Section titled “Resources”Platform
Section titled “Platform”| Resource | Description |
|---|---|
| Authentication | Credential exchange for a short-lived partner access token. |
| Wallet | Self-only balance and transaction reads. |
| Billing | Persisted billing statements and an on-demand provisional report. |
| Commission Periods | Commission operating-cycle periods (one per period of your statement cadence) — read, and object to a provisional one. |
| Resource | Description |
|---|---|
| Scent Orders | Create, list, read, and track your scent orders — the product-first order surface every Scent partner resource shares (/api/v1/scent/**). A future product gets its own equivalent Orders resource under its own segment. |
| Webhooks | Manage webhook subscriptions and inspect delivery history. Scent’s own event vocabulary today — each product gets its own webhook registration surface (see the Webhooks guide). |
| Reports | Your own sales figures and cart-behavior analytics — your own orders only, never a fleet-wide aggregate. |
| Catalog | Browse the scent catalog (scents, brands, variants) with delta-sync support. |
| Cart | Manage the caller’s own cart, price a checkout, and optionally lock prices. |
| Wishlist | A per-customer favorites list of variants, rendered as full mini-cards. |
| Stock Notify | Register/unregister/list back-in-stock notifications for an out-of-stock variant. |
| Returns | Partner self-serve return requests against a delivered scent order. |
| Unfulfillable Notices | Recovery path for a missed order.line-unfulfillable webhook — list, read, and respond to your own open 72-hour unfulfillable-line notices without waiting on redelivery. |
| Discount Codes | Define and manage your own discount codes, and check one against your cart. |