Skip to Content
Mashroo3 docs are live. More guides are added weekly.
API & SDKHTTP 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.
Last updated on