Developers

API documentation portal

Public OpenAPI reference is rolling out. Until interactive docs ship, use this portal for auth model, security requirements, and links to seller/system guides.

Status: Interactive API reference (OpenAPI) is on the roadmap. Authenticated /api/v1/* routes already power seller, supplier, warehouse, and admin clients. Security rules are documented now at API Security.

Authentication

Login issues a JWT access token. Send Authorization: Bearer <token> on authenticated routes. Role claims gate seller vs supplier vs warehouse vs admin APIs. Never put tokens in query strings or public repos.

Marketplace OAuth

Amazon, Flipkart, and Meesho connections use server-side OAuth / partner flows. Long-lived marketplace refresh tokens stay encrypted in our database — browsers never receive them. See each integration page for scopes and data access.

Versioning & rate limits

Paths are versioned under /api/v1/. Clients must respect HTTP 429 rate limits. Abuse is covered by the Acceptable Use Policy.

Webhooks (roadmap)

Signed webhooks for order and sync events are planned for Enterprise. Verify signatures before trusting payloads; require HTTPS endpoints.

Documentation portal