Recipes

Don't study the API. Cook with it.

Task-oriented walkthroughs, each one extracted from an integration that runs in production at Storekeeper today. Every recipe lists the calls in order, the responses you will actually get, and the gotchas we hit so you don't have to.

Finance

Accounting export & reconciliation

Pull a complete, VAT-correct financial period into your bookkeeping: revenue, VAT breakdown, payments, and turnover per group, per location.

/api/financial-report/api/turnover-groups/api/tax-rates +2
Finance

Daily close (Z-report) dashboard

Reconcile one day of trading: the Z-report and the payment breakdown come from the same pipeline, so they always match to the cent.

/api/reports/daily-close/api/reports/payments/api/payment-methods
Orders

Sync orders to your ERP

Drain a date range of orders with line items and addresses into your ERP, resolving every id the API emits along the way.

/api/orders/api/orders/{id}/api/orders/{id}/items +1
Reports

Best sellers & product performance

Rank products by revenue or quantity for any period, per location, straight from invoice rows.

/api/reports/product-sales
Inventory

Stock level monitor

Watch stock per product per location, and understand the difference between a location and a shop before it bites.

/api/stock/api/products/api/locations
CRM

Customer sync for marketing

Export customers and their segments to a mail or loyalty platform, incrementally and without duplicates.

/api/customers/api/customers/{id}/api/customer-segments
Orders

Discount audit

Find every order that carried a discount in a period: who gave it, on what, and how much margin it cost.

/api/discount-orders/api/orders/{id}/items
Catalog

Price list export

Export the catalog with current base prices: search or drain products, then join the price rows.

/api/products/api/product-prices/api/tax-rates
Foundations

Integration patterns

The cross-cutting habits every solid integration shares: token lifecycle, pagination drains, error handling, money and date conventions, id resolution.

/api/auth/login/api/me

New here? Start with Integration patterns, then pick the recipe that matches your job. The full endpoint reference lives at /api/doc.