Skip to main content

API Surface (Reference)

This page is a module map of the Supplier API host. It is reference material for OKNowShop-coordinated work and for understanding what the portal calls—not a self-serve unattended ERP program.

Supported data exchange: portal CSV feeds and signed webhooks (Feeds and webhooks). Day-to-day fulfilment: Supplier Portal (Order Operations).

Host

  • API: https://supplier-api.oziosko.com.au/api/v1
  • OpenAPI (static release snapshot): https://supply.oziosko.com.au/api/openapi.json (no runtime Swagger/ReDoc)

Modules (summary)

AreaPrefixNotes
Auth / profile/api/v1/auth*, /api/v1/profile*Portal sign-in and profile; not a machine-credential product
Catalog / inventory/api/v1/catalog*, /api/v1/inventory*Also driven from portal
Feeds/api/v1/feeds*Supported bulk pathFeeds
Orders (dropship / wholesale)/api/v1/orders*, /api/v1/wholesale/orders*Primary use: portal
Returns/api/v1/returns*Portal RMA: accept / receive / credit / reject
Settlements/api/v1/settlements*Payables ledger + wholesale remittance mark-paid (export caps)
Documents/api/v1/documents*Issued trade documents (read)
Connections/api/v1/connections*Portal sellers / credit
Webhooks/api/v1/webhooks*Supported event pushWebhooks
Dashboard / analytics / scorecard/api/v1/dashboard, analytics, scorecardDashboard for ops; analytics pages may be hidden

Tenant isolation

Protected routes are scoped to the authenticated supplier. Concurrent order updates are serialised so the same work item is not double-committed by racing actions.