LuxeMart API Documentation

Integrate seamlessly with LuxeMart's e-commerce platform. Manage products, process orders, and automate workflows with our RESTful API.

Note: This API is versioned. All endpoints require `v1` prefix. Rate limits: 1000 requests/minute for standard accounts.

Quick Start

Retrieve a list of products with a simple GET request:

# Base URL
https://api.luxemart.com/v1

# Example Request
GET /v1/products?limit=50&status=active

Authentication

The API uses Bearer token authentication for all protected endpoints. Include your secret API key in the `Authorization` header.

curl -X GET https://api.luxemart.com/v1/products \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json"

fetch('https://api.luxemart.com/v1/products', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_SECRET_KEY',
    'Content-Type': 'application/json'
  }
})
.then(res => res.json())
.then(data => console.log(data));

import requests

url = "https://api.luxemart.com/v1/products"
headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

Products

GET /v1/products

Retrieve a paginated list of products. Supports filtering, sorting, and search.

Query Parameters

Parameter	Type	Description
`limit`	integer	Number of items to return (max 100). Default: 20.
`offset`	integer	Pagination offset. Default: 0.
`status`	string	Filter by `active`, `draft`, or `archived`.
`min_price`	number	Filter products above this price.

Response Example

{
  "data: [
    {
      "id: "prod_8x9y2z3a4b",
      "name: "Premium Leather Jacket",
      "price: 299.99,
      "currency: "USD"
    }
  ],
  "meta: {
    "total: 142,
    "has_more: true
  }
}

Orders

POST /v1/orders

Create a new customer order. Requires a valid customer ID and at least one line item.

Request Body

{
  "customer_id: "cust_123abc",
  "currency: "USD"
},
"shipping_address: {
  "line1: "123 Main St"
},
"payment_method_id: "pm_card_visa"
}

Warning: Orders created via API bypass standard cart validation. Ensure inventory checks are handled on your end.

Error Codes

The API uses standard HTTP status codes to indicate success or failure.

400 Bad Request

Invalid parameters or missing required fields.

401 Unauthorized

Missing or invalid API key. Check your `Authorization` header.

404 Not Found

The requested resource does not exist.

500 Server Error

Internal LuxeMart error. Please retry or contact support.

All error responses follow a standard format:

{
  "error: {
    "code: "invalid_request",
    "message: "Missing required field: customer_id",
    "request_id: "req_9f8e7d6c5b4a3
  }
}

SDKs & Tools

Official libraries available for popular languages. Community packages are also supported.

Language	Package	Version
Node.js	`@luxemart/node`	^2.4.0
Python	`luxemart-py`	^1.8.2
Ruby	`luxe-ruby`	^0.9.1
Go	`github.com/luxemart/go-sdk`	^1.2.0