Skip to main content

API Surface

Key endpoints per module, exposed through the BFF/API gateway. Commerce endpoints proxy Medusa's Store/Admin APIs; domain endpoints hit NestJS services. All are tenant-scoped and (where applicable) RBAC + data-scope enforced.

Conventions​

  • Base: https://api.<tenant-domain>/ (per-tenant).
  • Auth: Authorization: Bearer <jwt>; scope derived from token, never from query params.
  • Versioning: /v1/...; events versioned separately.
  • Errors: RFC 7807 problem+json.
  • Idempotency: Idempotency-Key header on POSTs that create money/jobs.

Commerce (proxied to Medusa)​

MethodPathNotes
GET/v1/store/productschannel + locale aware
POST/v1/store/carts / …/line-items / …/completecheckout
POST/v1/leadsquote/enquiry → CRM/DMS
GET/POST/v1/admin/products…Medusa Admin (RBAC)

Orders & Fulfillment​

MethodPath
POST/v1/fulfillment/quote · /v1/fulfillment/ship · GET /v1/fulfillment/:id/track
POST/v1/orders/:id/returns

FSM / Service​

MethodPath
POST/v1/service/tickets · GET /v1/service/tickets (scoped)
POST/v1/service/tickets/:id/assign · /v1/service/jobs/:id/close
POST/v1/amc/contracts · /v1/amc/contracts/:id/renew · GET /v1/amc/due
POST/v1/service/external-assets

Warranty​

MethodPath
POST/v1/warranty/register · GET /v1/warranty/lookup?serial=
GET/v1/me/products
POST/v1/warranty/claims · /v1/warranty/claims/:id/decision
GET/v1/warranty/decision?assetId=&issue=

DMS​

MethodPath
POST/GET/v1/dms/partners (GET scoped) · POST /v1/dms/partners/:id/kyc
GET/v1/dms/partners/:id/ledger · /v1/dms/targets (scoped)
GET/v1/dms/locator?pincode= · POST /v1/dms/schemes

CRM & Loyalty​

MethodPath
GET/v1/me · /v1/me/loyalty · POST /v1/loyalty/redeem
POST/v1/affiliate/links · GET /v1/affiliate/:code/stats

Marketing / CMS​

MethodPath
GET/v1/content/:slug (localized) · /v1/faq
POST/v1/testimonials
PayloadREST/GraphQL for authoring (admin)

Finance​

MethodPath
POST/v1/finance/invoices · GET /v1/finance/invoices/:id/einvoice
POST/v1/finance/ewaybill · /v1/finance/payouts
GET/v1/finance/ledgers/:partnerId (scoped)

Admin / Platform / Automation​

MethodPath
GET/v1/admin/dashboards/:team (scoped) · /v1/admin/audit (scoped)
POST/v1/admin/automation/subscriptions (event → Zapier/Pabbly URL)
POST/v1/admin/apikeys · GET /v1/admin/export/:dataset
PATCH/v1/admin/tenant-config

Webhooks (inbound)​

SourcePath
Hyperswitch/v1/webhooks/hyperswitch
Shiprocket/v1/webhooks/shiprocket
Amazon/Flipkart/v1/webhooks/marketplace/:channel

All inbound webhooks are signature-verified; see Security.

Event catalog​

The canonical event list lives in Eventing & Integration; events are the integration contract between modules.