SDK/API

HTTP API

This reference documents the tenant-aware public API used by POS and external integrations. Base URL https://mashroo3.net Authentication Supported headers: Authorization: Bearer YOUR_API_KEY X-API-Key: YOUR_API_KEY Response format Success: { "ok": true, "data": {} } Error: { "ok": false, "error": "Error message" } Core endpoints - GET /api/catalog - GET /api/customers - POST /api/customers - GET /api/orders (latest 10) - GET /api/orders/{id} - POST /api/orders - POST /api/orders/{id}/refund Catalog notes - Returns stock-aware availability. - Untracked products return very high available_qty. - Includes is_unit_specific, sell_unit_code, sell_qty_step. Orders notes - Validates product status and quantity rules. - Creates initial payment history when paid > 0. - Updates stock for linked product-item mappings. - Refunds restore stock and adjust owed calculations.

JavaScript SDK

Install npm install mashroo3 Quick start CommonJS const { Mashroo3 } = require("mashroo3"); const client = new Mashroo3("YOUR_API_KEY"); const catalog = await client.catalog.list(); ESM import Mashroo3 from "mashroo3"; const client = new Mashroo3("YOUR_API_KEY"); const orders = await client.orders.list(); Main methods await client.catalog.list(); await client.customers.list(); await client.customers.create({ name: "John Doe" }); await client.orders.list(); await client.orders.get(44); await client.orders.create({ customer_id: 12, items: [{ product_id: 1, qty: 2 }] }); await client.orders.refund(44, { items: [{ order_item_id: 101, qty: 1 }] }); Constructor options - baseUrl (default https://mashroo3.net) - timeoutMs (default 30000) - fetch custom fetch implementation Error handling SDK throws Mashroo3Error with message, status, and data.