Platform overview

What is Linra Omni

Linra Omni is a B2B commerce platform: Linra sources product from suppliers (vendors) like you and resells it to its reselling partners. Omni is built to carry more than one product line — Scent (perfume and fragrance) is the first, and this site currently documents the Scent product’s own supply-side API surface end to end. Everything under API Reference → Platform — authentication, your profile, your API credentials — is product-agnostic: it stays the same shape regardless of how many product lines you eventually supply through. Everything under API Reference → Scent (offers, cost, stock, orders, returns, Scent’s own webhook events) is specific to the Scent product; a future product would get its own equivalent surface, documented separately, once it exists — see URL conventions for how that split shows up in the URLs.

This is also a wholly separate property from the Linra Omni partner developer docs — you are a supplier Linra sources product from, not a reselling partner, and the two audiences never share a surface, credential, or vocabulary.

graph TB
    subgraph Platform["Linra Omni platform (product-agnostic)"]
        Auth["Vendor auth /api/v1/auth/token<br/>capability-scoped tokens"]
        Profile["Profile /api/v1/profile"]
        Creds["Credentials /api/v1/credentials"]
    end

    subgraph Scent["Scent product /api/v1/scent/** (live today)"]
        Offers["Offers"]
        Stock["Cost & stock"]
        Orders["Orders & fulfilment"]
        Returns["Returns"]
        Webhooks["Webhooks"]
    end

    Future["A future product /api/v1/{product}/**<br/>(not built yet)"]

    You["You — the vendor"] -->|one credential, one auth model| Auth
    Auth --> Profile
    Auth --> Creds
    Auth -.capability check per call.-> Offers
    Auth -.capability check per call.-> Stock
    Auth -.capability check per call.-> Orders
    Auth -.capability check per call.-> Returns
    Orders --> Returns
    Auth -.same model extends.-> Future

    style Future stroke-dasharray: 5 5

One account, one credential model, one Gateway — the product segment in the URL is what changes as Linra Omni adds product lines, not your identity or how you authenticate.

API versioning

The entire vendor-facing surface lives under one version prefix, /api/v1, on this Gateway’s own domain (separate from the partner Gateway). A breaking change would ship as /api/v2 for the whole facade, announced in the Changelog ahead of time.

The response envelope

Every response is wrapped in the same three-key envelope, { state, payload, details } — see Rate limits & errors for the full shape and the error codes you’ll actually encounter.

Pagination

List endpoints accept page (1-based) and pageSize, returning a pagination object of this exact shape:

{
  "items": [ "..." ],
  "pagination": { "page": 1, "pageSize": 20, "totalCount": 34, "totalPages": 2 }
}

totalCount is the full count across every page; totalPages is derived. Some list endpoints (e.g. webhook subscriptions) deliberately skip pagination because their result set is naturally small — see that endpoint’s own reference page.

Where to go next

• URL conventions — the platform-vs-product URL rule.
• Authentication & capabilities — how to actually call any of this.
• Scent — this product’s own endpoints and state catalogue.