API service for Elementary POS
Read receipts, orders and shifts, manage your items and get notified in real time. Build your system as a kit — and plug the cash register in.
Elementary POS API overview
Everything you need to get started.
Elementary POS architecture
Build your system as a kit.
POS REST API
Thanks to the API, you can get information about receipts, orders and shifts. You can easily extend your system with a POS cash register.
- Receipt API Get list of receipts, receipt data and PDF receipts.
- Webhook API Activate and deactivate webhook, get webhook status.
- Items API Add and remove your sales items.
- Category API Add and remove your categories.
- Tax API Control your taxes.
- Order API Get order status.
- Shift API Get shift list.
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. |
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. |
WooCommerce plugin
Connects Elementary POS with your WooCommerce e-shop.
Menu plugin
A simple WordPress plugin — open source, built on the public API.