LuxMart API Documentation

Welcome to the LuxMart API Documentation. This comprehensive guide provides detailed information about all available endpoints, request/response formats, authentication, and error handling.

Overview

LuxMart is an e-commerce platform API built with Go (Echo framework) that provides:

User & Store Management: Registration, authentication, profile management
Product Management: Categories, brands, products, variants, and attributes
Intelligent Search: Elasticsearch-powered multilingual, typo-tolerant product search
Shopping Features: Basket, wishlist, orders, and payments
Real-time Chat: WebSocket-based communication between stores and admins
Email Service: Reliable email delivery with queuing, retries, and templates
Multi-language Support: Automatic translation for product names, descriptions, and emails
Admin & Store Dashboards: Management interfaces for different user roles

Base URL

Production: https://api.luxmart.site
Staging: https://api-staging.luxmart.site

All API endpoints are prefixed with /v1/.

API Version

Current version: v1

Authentication

Most endpoints require authentication using a Bearer token in the Authorization header:

Authorization: Token <your_token>

See Authentication Guide for detailed information.

Rate Limiting

API requests are rate-limited to ensure fair usage. Contact support if you need higher limits.

Support

For API support, please contact: support@luxmart.site

Quick Start

Register a User or Register a Store
Verify OTP
Login to get your access token
Use the token to access protected endpoints

API Structure

The API is organized into six main modules:

Accounts API: User and store management, authentication, addresses
Products API: Products, categories, brands, orders, payments, audit
Chat API: Real-time WebSocket chat between stores and admins
Contacts API: Contact forms and email subscriptions
Audit API: Financial reporting and analytics (Admin only)
Email Service: Standalone email service with queuing and retries