The POSEngine API
Build on top of your store data — sync catalogs, create customers, pull sales and stock over plain REST/JSON. Read access ships with Professional; read + write with Enterprise.
Scoped API keys
Mint keys per store from Settings → API Keys. Read on Professional, read + write on Enterprise. Revoke anytime.
Secure by design
Keys are shown once and stored hashed. Every call is scoped to your store — never another tenant’s data.
Predictable limits
120 requests/minute per key, with X-RateLimit-* headers on every response so you can back off gracefully.
Quick start
# 1. Create a key in the dashboard: Settings → API Keys
# 2. Call the API with it (either header works):
curl https://api.posengine.in/api/POSEngine/v1/ping \
-H "X-API-Key: psk_live_xxxxxxxx_..."
# Create a product (Enterprise / write scope):
curl -X POST https://api.posengine.in/api/POSEngine/v1/products \
-H "X-API-Key: psk_live_xxxxxxxx_..." \
-H "Content-Type: application/json" \
-d '{ "name": "Basmati Rice 5kg", "sellingPrice": 520, "gstRate": 5 }'Base URL https://api.posengine.in/api/POSEngine/v1. Authenticate with X-API-Key or Authorization: Bearer. List responses carry a pagination block (limit, offset, hasMore).
Endpoints
Showing 11 of 11/pingVerify a key; returns its store + scopesread/productsList products (paginated, ?search=)read/products/:idGet one productread/productsCreate a productwrite/products/:idUpdate a productwrite/customersList customersread/customersCreate a customerwrite/customers/:idUpdate a customerwrite/invoicesList invoices (?status=, ?dateFrom=)read/invoices/:idGet one invoice with line itemsread/inventoryOn-hand stock per product per branchreadInteractive reference (OpenAPI) is available in-product at /api/POSEngine/docs.
Ready to build?
The API is live on Professional and Enterprise. Open your dashboard, go to Settings → API Keys, and mint your first key.
New to POSEngine? Start with the features guide.