Customer API

Storefront, cart, orders, reviews (66 endpoints)

12 Modules

Account & Profile

Login & Register

9 endpoints
POST GET PUT DELETE

Register, login, OTP, password, logout, account
Hide endpoints
POST/register
GET/account
PUT/account
PUT/password
POST/login
DEL/logout
POST/reset-password
POST/send-otp
POST/deactivate

Profile Management

8 endpoints
POST GET PUT DELETE

Netflix-style multi-profile, select, default
Hide endpoints
POST/profiles
GET/profiles
GET/profiles/:id
PUT/profiles/:id
DEL/profiles/:id
GET/profiles/default
POST/profiles/select
GET/profiles/active

Address

6 endpoints
GET POST PUT PATCH DELETE

CRUD addresses, set default
Hide endpoints
GET/addresses
GET/addresses/:id
POST/addresses
PUT/addresses/:id
DEL/addresses/:id
PATCH/addresses/:id/set-default

Shopping Experience

Catalog

6 endpoints
POST GET

Search products/categories, filters, recently viewed
Hide endpoints
POST/categories/search
GET/categories/:id
GET/categories/filter
POST/products/search
GET/products/:id
GET/products/recent-view

Wishlist

2 endpoints
POST GET

Toggle wishlist, get saved products
Hide endpoints
POST/wishlist/toggle
GET/wishlist

Cart & Checkout

9 endpoints
POST GET PUT DELETE

Cart items, options, buy now, place order, suggestions
Hide endpoints
POST/cart/items
PUT/cart
GET/cart
GET/cart?compute=false
DEL/cart
POST/buy-now
POST/cart/place-order
GET/cart/suggestions

Serviceability

3 endpoints
POST

Check delivery, slots, shipping rates
Hide endpoints
POST/addresses/serviceability (by address)
POST/addresses/serviceability (by pincode)
POST/addresses/serviceability (by coords)

Enquiry

8 endpoints
POST GET DELETE

Enquiry basket, items, submit, history
Hide endpoints
POST/enquiry-basket/items
GET/enquiry-basket
POST/enquiry-basket/submit
DEL/enquiry-basket
POST/enquiries
GET/enquiries/:id
POST/enquiries/:id/invoices
GET/enquiries/:id/invoices/:id

Stores

1 endpoint
POST

Search stores with multiple scenarios
Show scenarios
POST/stores/search
• all-store • serviceable-stores
• fulfillment-store • pickup-available
• default-store

Orders & Post-Purchase

Order

4 endpoints
POST GET DELETE

List orders, details, tracking, delete
Hide endpoints
POST/orders
GET/orders/:id
GET/orders/:id/fulfillments/:id/track
DELETE/orders/:id

Post Fulfillment

5 endpoints
POST GET

Returns, exchanges, cancellations, eligibility
Hide endpoints
GET/orders/:order_id/eligibility
GET/orders/:order_id/items/:item_id/eligibility
POST/order-actions (return/exchange/cancel)
GET/orders/:order_id/actions
GET/order-actions/:action_id

Rating & Review

5 endpoints
POST GET PUT DELETE

Create, list, update, delete reviews
Hide endpoints
POST/reviews (product/order)
GET/reviews/my-reviews
GET/reviews?type=&id=
PUT/reviews/:review_id
DELETE/reviews/:review_id

Seller API

Merchant dashboard, products, orders, settings

22 Modules

Account & Authentication

Account Onboarding

4 endpoints
POST GET PATCH DELETE

Register, get, update, delete seller account
Hide endpoints
POST/merchant/api/v1/account
GET/merchant/api/v1/account
PATCH/merchant/api/v1/account
DELETE/merchant/api/v1/account

Authentication

9 endpoints
POST GET PATCH DELETE

Login, logout, session, password reset
Hide endpoints
POST/merchant/api/v1/auth
GET/merchant/api/v1/auth
DELETE/merchant/api/v1/auth
POST/merchant/api/v1/forgot-password
PATCH/merchant/api/v1/forgot-password
PATCH/merchant/api/v1/auth/password
GET/merchant/api/v1/auth/sessions
DELETE/merchant/api/v1/auth/sessions/:session_id

Profile

1 endpoint
PUT

Update user profile
Hide endpoints
PUT/merchant/api/v1/profile

Security

1 endpoint
PUT

Change password
Hide endpoints
PUT/merchant/api/v1/security

Sessions

4 endpoints
GET DELETE

List and revoke sessions
Hide endpoints
GET/merchant/api/v1/sessions
DELETE/merchant/api/v1/sessions/:session_id
GET/merchant/api/v1/domains/:domain_id/sessions
DELETE/merchant/api/v1/domains/:domain_id/sessions/:session_id

Catalog & Inventory

Products

6 endpoints
POST GET PATCH DELETE

CRUD products, bulk operations
Hide endpoints
POST/merchant/api/v1/domains/:domain_id/products
GET/merchant/api/v1/domains/:domain_id/products
GET/merchant/api/v1/domains/:domain_id/products/:id
PATCH/merchant/api/v1/domains/:domain_id/products/:id
DELETE/merchant/api/v1/domains/:domain_id/products/:id
PATCH/merchant/api/v1/domains/:domain_id/products/bulk

Categories

5 endpoints
POST GET PATCH DELETE

Category tree management
Hide endpoints
POST/merchant/api/v1/domains/:domain_id/categories
GET/merchant/api/v1/domains/:domain_id/categories
GET/merchant/api/v1/domains/:domain_id/categories/:id
PATCH/merchant/api/v1/domains/:domain_id/categories/:id
DELETE/merchant/api/v1/domains/:domain_id/categories/:id

Coupons & Promotions

5 endpoints
POST GET PATCH DELETE

Discount codes and promotions
Hide endpoints
POST/merchant/api/v1/domains/:domain_id/coupons
GET/merchant/api/v1/domains/:domain_id/coupons
GET/merchant/api/v1/domains/:domain_id/coupons/:id
PATCH/merchant/api/v1/domains/:domain_id/coupons/:id
DELETE/merchant/api/v1/domains/:domain_id/coupons/:id

Orders & Customers

Orders & Fulfillment

6 endpoints
GET PATCH POST

List orders, update status, fulfillment
Hide endpoints
GET/merchant/api/v1/domains/:domain_id/orders
GET/merchant/api/v1/domains/:domain_id/orders/:order_id
PATCH/merchant/api/v1/domains/:domain_id/orders/:order_id/status
POST/merchant/api/v1/domains/:domain_id/orders/:order_id/fulfillments
POST/merchant/api/v1/domains/:domain_id/orders/:order_id/cancel
PATCH/merchant/api/v1/domains/:domain_id/orders/bulk

Customer Users

6 endpoints
GET POST PUT DELETE

Manage customers, export CSV
Hide endpoints
GET/merchant/api/v1/domains/:domain_id/customers
GET/merchant/api/v1/domains/:domain_id/customers/:customer_id
POST/merchant/api/v1/domains/:domain_id/customers
PUT/merchant/api/v1/domains/:domain_id/customers/:customer_id
DELETE/merchant/api/v1/domains/:domain_id/customers/:customer_id
GET/merchant/api/v1/domains/:domain_id/customers/export

Store & Domain Management

Domain Management

8 endpoints
POST GET DELETE

Domains, custom URLs, DNS
Hide endpoints
POST/merchant/api/v1/domains
GET/merchant/api/v1/domains
GET/merchant/api/v1/domains/:domain_id
DELETE/merchant/api/v1/domains/:domain_id
GET/merchant/api/v1/domains/:domain_id/domain_url
POST/merchant/api/v1/domains/:domain_id/domain_url
DELETE/merchant/api/v1/domains/:domain_id/domain_url
POST/merchant/api/v1/domains/:domain_id/domain_url/search

Stores

5 endpoints
POST GET PATCH DELETE

Multi-store management
Hide endpoints
POST/merchant/api/v1/domains/:domain_id/stores
GET/merchant/api/v1/domains/:domain_id/stores
GET/merchant/api/v1/domains/:domain_id/stores/:id
PATCH/merchant/api/v1/domains/:domain_id/stores/:id
DELETE/merchant/api/v1/domains/:domain_id/stores/:id

Store Settings

97 endpoints
GET PUT

27 setting categories: branding, SEO, payments, shipping...
Hide categories (27 GET/PUT pairs)
• general_settings• billing_address • store_detail• seo_settings • social_media• delivery_settings • tax_settings• payment_settings • notification• checkout_settings • order_settings• product_settings • customer_settings• inventory_settings • shipping_settings• return_settings • loyalty_settings• analytics_settings • integration• security_settings • email_settings• sms_settings • webhook_settings• api_settings • localization• maintenance • advanced_settings

Subscriptions & Billing

9 endpoints
GET POST PUT

Plans, subscriptions, pause/resume/cancel
Hide endpoints
GET/merchant/api/v1/subscription_plans
GET/merchant/api/v1/subscription_plan_features
POST/merchant/api/v1/domains/:id/subscriptions
GET/merchant/api/v1/domains/:id/subscriptions
GET/merchant/api/v1/domains/:id/subscriptions/active
GET/merchant/api/v1/domains/:id/subscriptions_transactions/:id
PUT/merchant/api/v1/domains/:id/subscriptions/:id/pause
PUT/merchant/api/v1/domains/:id/subscriptions/:id/resume
PUT/merchant/api/v1/domains/:id/subscriptions/:id/cancel

Team & Permissions

Staff & Invites

9 endpoints
POST GET PUT DELETE

Team members, invitations
Hide endpoints
POST/merchant/api/v1/domains/:domain_id/invite
GET/staff/api/v1/invite/:invite_id
PUT/staff/api/v1/invite/:invite_id
DELETE/merchant/api/v1/domains/:domain_id/invite/:invite_id
POST/merchant/api/v1/domains/:domain_id/staff
GET/merchant/api/v1/domains/:domain_id/staff
GET/merchant/api/v1/domains/:domain_id/staff/:staff_id
PUT/merchant/api/v1/domains/:domain_id/staff/:staff_id
DELETE/merchant/api/v1/domains/:domain_id/staff/:staff_id

Roles & Permissions

6 endpoints
POST GET PUT DELETE

RBAC configuration
Hide endpoints
POST/merchant/api/v1/domains/:domain_id/roles
GET/merchant/api/v1/domains/:domain_id/roles
GET/merchant/api/v1/domains/:domain_id/roles/:role_id
PUT/merchant/api/v1/domains/:domain_id/roles/:role_id
DELETE/merchant/api/v1/domains/:domain_id/roles/:role_id
GET/merchant/api/v1/permissions

Content & Storefront

Theme

9 endpoints
GET POST PUT DELETE

Master themes, storefront themes, purchases
Hide endpoints
GET/merchant/api/v1/themes
GET/merchant/api/v1/themes/:theme_id
GET/merchant/api/v1/domains/:id/themes
POST/merchant/api/v1/domains/:id/themes
POST/merchant/api/v1/domains/:id/themes/purchase
PUT/merchant/api/v1/domains/:id/themes/:theme_id
PUT/merchant/api/v1/domains/:id/themes/:theme_id/default
DEL/merchant/api/v1/domains/:id/themes/:theme_id
GET/merchant/api/v1/domains/:id/theme_transactions/:id

Blogs

5 endpoints
POST GET PATCH DELETE

Blog posts, scheduling, SEO
Hide endpoints
POST/merchant/api/v1/domains/:id/blogs
GET/merchant/api/v1/domains/:id/blogs
GET/merchant/api/v1/domains/:id/blogs/:id
PATCH/merchant/api/v1/domains/:id/blogs/:id
DEL/merchant/api/v1/domains/:id/blogs/:id

Pages

7 endpoints
GET POST PUT DELETE

Static pages, CMS, global admin
Hide endpoints
GET/merchant/api/v1/domains/:id/pages
POST/merchant/api/v1/domains/:id/pages
GET/merchant/api/v1/domains/:id/pages/:id
PUT/merchant/api/v1/domains/:id/pages/:id
DEL/merchant/api/v1/domains/:id/pages/:id
GET/merchant/api/v1/pages
GET/merchant/api/v1/pages/:id

Navigation Menu

4 endpoints
GET POST PATCH DELETE

Menu structure management
Hide endpoints
GET/merchant/api/v1/domains/:domain_id/menus
POST/merchant/api/v1/domains/:domain_id/menus
PATCH/merchant/api/v1/domains/:domain_id/menus/:id
DELETE/merchant/api/v1/domains/:domain_id/menus/:id

Utilities & Media

Media & Files

5 endpoints
POST GET DELETE

Upload, folders, media library
Hide endpoints
POST/merchant/api/v1/files
POST/merchant/api/v1/domains/:domain_id/media/upload
GET/merchant/api/v1/domains/:domain_id/media/folders
POST/merchant/api/v1/domains/:domain_id/media/folders
DELETE/merchant/api/v1/domains/:domain_id/media/:id

Plugins

4 endpoints
GET POST PATCH DELETE

Install, configure, uninstall
Hide endpoints
GET/merchant/api/v1/domains/:domain_id/plugins
POST/merchant/api/v1/domains/:domain_id/plugins/:id/install
PATCH/merchant/api/v1/domains/:domain_id/plugins/:id/configure
DELETE/merchant/api/v1/domains/:domain_id/plugins/:id

POS API

Point of Sale terminal integration

6 Modules

Authentication

API Key Auth

1 endpoints
GET

API keys & Token verification

Show endpoints
GET/pos/api/v1/auth/verify

Store & Terminal

Store Settings

5 endpoints
GET PUT

Store config, timings, POS settings

Show endpoints
GET/pos/api/v1/store
GET/pos/api/v1/store/settings
PUT/pos/api/v1/store/settings
GET/pos/api/v1/store/timings
PUT/pos/api/v1/store/timings
PATCH/pos/api/v1/store/toggle-active

Terminals

5 endpoints
GET POST PUT DELETE

Terminal registration & management

Show endpoints
GET/pos/api/v1/terminals
POST/pos/api/v1/terminals
GET/pos/api/v1/terminals/:terminal_id
PUT/pos/api/v1/terminals/:terminal_id
DELETE/pos/api/v1/terminals/:terminal_id

Products, Categories & Inventory

Products

7 endpoints
GET POST PUT PATCH DELETE

Full CRUD, stock status, category assignment

Show endpoints
POST/pos/api/v1/products
GET/pos/api/v1/products/:product_id
PUT/pos/api/v1/products/:product_id
PATCH/pos/api/v1/products/:product_id/stock
DELETE/pos/api/v1/products/:product_id
GET/pos/api/v1/products/search
PATCH/pos/api/v1/products/:product_id/category

Categories

7 endpoints
GET POST PUT DELETE

Full CRUD, product organization

Show endpoints
GET/pos/api/v1/categories/search
POST/pos/api/v1/categories
GET/pos/api/v1/categories/:category_id
PUT/pos/api/v1/categories/:category_id
DELETE/pos/api/v1/categories/:category_id
GET/pos/api/v1/categories/:category_id/products
POST/pos/api/v1/categories/:category_id/products

Inventory

3 endpoints
GET PATCH

Stock levels, adjustments

Show endpoints
GET/pos/api/v1/inventory
GET/pos/api/v1/inventory/:product_id
PATCH/pos/api/v1/inventory/:product_id

Orders & Transactions

Orders

5 endpoints
GET POST PATCH

Order creation, status, holds

Show endpoints
POST/pos/api/v1/orders
GET/pos/api/v1/orders
GET/pos/api/v1/orders/:order_id
PATCH/pos/api/v1/orders/:order_id
GET/pos/api/v1/orders/:order_id/invoice

Payments

3 endpoints
POST GET

Payment processing, refunds

Show endpoints
POST/pos/api/v1/orders/:order_id/payments
GET/pos/api/v1/orders/:order_id/payments
GET/pos/api/v1/orders/:order_id/payments/:payment_id

Customers & Reports

Customers

5 endpoints
GET POST PATCH

Customer lookup, loyalty

Show endpoints
GET/pos/api/v1/customers/search
POST/pos/api/v1/customers
PATCH/pos/api/v1/customers/:customer_id
DELETE/pos/api/v1/customers/:customer_id

Reports

1 endpoints
GET

Sales reports, shift summaries

Show endpoints
GET/pos/api/v1/reports/sales

ONDC Seller API (BPP)

Open Network for Digital Commerce - Seller App Protocol

5 Modules

Discovery

Search

1 endpoint
POST

Receive search intent, respond with catalog

Hide endpoints
POST/search → /on_search

Quotation

Select & Init

2 endpoints
POST

Quote items, initialize order with terms

Hide endpoints
POST/select → /on_select
POST/init → /on_init

Order Lifecycle

Confirm, Status & Update

3 endpoints
POST

Confirm order, provide status, handle updates

Hide endpoints
POST/confirm → /on_confirm
POST/status → /on_status
POST/update → /on_update

Fulfillment

Track

1 endpoint
POST

Provide tracking URL and delivery status

Hide endpoints
POST/track → /on_track

Post-Order

Cancel, Rating & Support

3 endpoints
POST

Handle cancellation, ratings, support requests

Hide endpoints
POST/cancel → /on_cancel
POST/rating → /on_rating
POST/support → /on_support

Superadmin API

Platform administration & configuration

9 Modules

Provider Management

Providers

5 endpoints
GET POST PUT DELETE

SMS, Email, Payment gateway providers

Show endpoints
GET/admin/api/v1/providers
GET/admin/api/v1/providers/:provider_id
POST/admin/api/v1/providers
PUT/admin/api/v1/providers/:provider_id
DELETE/admin/api/v1/providers/:provider_id

Tenant & Domain Management

Domains

5 endpoints
GET PATCH DELETE

Domain configuration & status

Show endpoints
GET/admin/api/v1/domains
GET/admin/api/v1/domains/:domain_id
PATCH/admin/api/v1/domains/:domain_id
PATCH/admin/api/v1/domains/:domain_id/suspend
DELETE/admin/api/v1/domains/:domain_id

Subscription & Plans

Subscription Plans

5 endpoints
GET POST PUT DELETE

Plan tiers & pricing

Show endpoints
GET/admin/api/v1/subscription_plans
GET/admin/api/v1/subscription_plans/:plan_id
POST/admin/api/v1/subscription_plans
PUT/admin/api/v1/subscription_plans/:plan_id
DELETE/admin/api/v1/subscription_plans/:plan_id

Plan Features

4 endpoints
GET POST PUT

Feature flags & limits

Show endpoints
GET/admin/api/v1/subscription_plan_features
POST/admin/api/v1/subscription_plan_features
PUT/admin/api/v1/subscription_plan_features/:feature_id
GET/admin/api/v1/subscription_plan_features/compare

Theme Marketplace

Master Themes

6 endpoints
GET POST PUT DELETE

Global theme templates

Show endpoints
GET/admin/api/v1/themes
GET/admin/api/v1/themes/:theme_id
POST/admin/api/v1/themes
PUT/admin/api/v1/themes/:theme_id
PUT/admin/api/v1/themes/:theme_id/publish
DELETE/admin/api/v1/themes/:theme_id

Platform Analytics

Reports

3 endpoints
GET

Platform-wide metrics & reports

Show endpoints
GET/admin/api/v1/reports/overview
GET/admin/api/v1/reports/domains
GET/admin/api/v1/reports/subscriptions

Audit Logs

3 endpoints
GET

Activity logs & audit trail

Show endpoints
GET/admin/api/v1/audit-logs
GET/admin/api/v1/audit-logs/:log_id
GET/admin/api/v1/audit-logs/export

System Configuration

Platform Settings

2 endpoints
GET PUT

Global platform configuration

Show endpoints
GET/admin/api/v1/settings
PUT/admin/api/v1/settings

Enums

6 endpoints
GET POST PUT DELETE

Manage system enums & lookup values

Show endpoints
GET/admin/api/v1/enums
POST/admin/api/v1/enums
GET/admin/api/v1/enums/:enum_type
PUT/admin/api/v1/enums/:enum_type
DELETE/admin/api/v1/enums/:enum_type
GET/admin/api/v1/enums/:enum_type/values

Currencies

6 endpoints
GET POST PUT PATCH DELETE

Manage supported currencies

Show endpoints
GET/admin/api/v1/currencies
POST/admin/api/v1/currencies
GET/admin/api/v1/currencies/:currency_code
PUT/admin/api/v1/currencies/:currency_code
PATCH/admin/api/v1/currencies/:currency_code/status
DELETE/admin/api/v1/currencies/:currency_code

Countries

6 endpoints
GET POST PUT PATCH DELETE

Manage supported countries & regions

Show endpoints
GET/admin/api/v1/countries
POST/admin/api/v1/countries
GET/admin/api/v1/countries/:country_code
PUT/admin/api/v1/countries/:country_code
PATCH/admin/api/v1/countries/:country_code/status
DELETE/admin/api/v1/countries/:country_code

Cache & Utilities

3 endpoints
GET DELETE

Cache management & health checks

Show endpoints
GET/admin/api/v1/cache/stats
DELETE/admin/api/v1/cache/invalidate
GET/admin/api/v1/health

HTTP Methods Legend

GET Read / Retrieve
POST Create
PUT Replace
PATCH Update
DELETE Remove