Interactive API Reference (Swagger)

Bazaara provides a fully interactive Swagger UI API Console allowing developers to visualize and interact with the storefront APIs directly in their browser.

🚀 Accessing the API Console

The Swagger API Console is hosted separately to keep production builds lean. To launch the interactive console:

Open Interactive API Console →

Note: Ensure the local Swagger UI server is running (default port 5001).

📂 Categorized E-Commerce Domains

The storefront APIs are organized into clear modules to make integration straightforward:

1. Catalog

Store Details: Get onboarding settings, branding assets, and metadata configurations.
Product Search: Fetch catalog details, price range filters, paginated listing queries, and autocomplete tags suggestions.

2. Cart

Shopper Cart CRUD: Initialize guest or customer cart states, add new items, modify line quantities, delete specific products, or clear the entire cart.

3. Checkout

Checkout Order Placement: Place orders with shipping details, preferred payment gateways (COD, Stripe, Razorpay), promo coupons, and customer notes.

4. Authentication

Customer Onboarding: Register new accounts, grant access tokens, manage passwords (forgot/reset notifications), and retrieve profile metadata.

5. Customer Profile

Personalized Hub: Track invoice orders history, wishlist favorites (add/remove CRUD), and address book card listings.

6. Reviews

Shopper Feedback: Submit ratings/comments on products and read reviews lists featuring verified buyer labels.

7. Marketing & Newsletter

Promotional Tools: Validate discount coupon thresholds and register email newsletter subscribers list.