Public API

API service for Elementary POS

Read receipts, bills, orders and the cash journal, manage your items, stock and customers, and get notified in real time. Build your system as a kit — and plug the cash register in.

API documentation Get your API key

Elementary POS API overview

Everything you need to get started.

Download Elementary POS app Free cash register POS system API documentation Interactive Swagger reference POS webhook settings Connect your own endpoint Get your API key Elementary POS Office

Need to extend the API? Let us know, we’ll be happy to do it — api@elementarypos.com

Elementary POS architecture

Build your system as a kit.

POS REST API

Thanks to the API, you can get information about receipts, bills, orders and the cash journal. You can easily extend your system with a POS cash register.

Receipt API Get list of receipts, receipt data and PDF receipts.
Bill API Get list of open bills and bill data.
Order API Create orders and get order status.
Cash register API Get the cash journal — cash added to and removed from the drawer.
Item API Add, edit and remove your sales items.
Category API Get your categories.
Stock API Read actual stock data, stock changes and update stock.
Supplier API Create, edit and remove suppliers.
Customer API Create, edit and remove customers.
Tax API Read your tax settings.
Webhook API Activate and deactivate webhook, get webhook status.

Are you missing a feature in the API? Email us at api@elementarypos.com, or get more information in the Elementary POS API documentation.

Elementary POS webhook

A webhook is called in case of an event in Elementary POS, so your system can react immediately — for example when a receipt has been created.

Your endpoint must return HTTP status 200. In case of an error the call is repeated. If there are too many errors, the webhook is disconnected automatically.

The URL is called with type and id query parameters (HTTP GET):

https://YOUR_WEBHOOK_URI?type=receipt_created&id=RECEIPT_UUID

`receipt_created`	A new receipt is created. May be delayed if the cash register is offline.
`receipt_updated`	The receipt is updated. May be delayed if the cash register is offline.
`receipt_deleted`	The receipt is deleted. May be delayed if the cash register is offline.
`report_created`	The Excel sales report is created.
`order_created`	A new order is created — new items added to the bill.
`order_updated`	The order is updated — deliver status is changed.
`cash_journal_record_created`	A new cash journal record is created — cash added to or removed from the drawer. Cash record ID is sent.
`shift_logout`	The user finished the shift. Cash register ID is sent.
`stock_updated`	Stock is updated.
`susp_detected`	Suspicious behaviour is detected. Event ID is sent.
`test`	App URI test.

Set webhook configuration in Elementary POS Office.

WooCommerce plugin

Connects Elementary POS with your WooCommerce e-shop.

Elementary POS for WooCommerce wordpress.org plugin directory

Menu plugin

A simple WordPress plugin — open source, built on the public API.

Elementary POS WP plugin wordpress.org plugin directory