Merchant API
Catalogue: products, prices, stock. Orders. Users. An OpenAPI specification.
For developers
Merchant API and webhooks for deep customisation
Manage catalogue, orders and users programmatically, and plug your own logic in through webhooks — up to and including external loyalty calculation.
API
What you can do
Webhooks
Real-time order events and external loyalty calculation.
What to build
An external loyalty calculator, catalogue syncing, and order processing in your own system.
Why it matters
Either you ask the app, or the app tells you
A ready-made app covers the standard retail jobs out of the box. Programmatic access is for the cases where the logic is not standard: your own loyalty engine, an external delivery calculator, a back office with no off-the-shelf connector. Data moves in both directions, and each direction has its own tool.
Merchant API
-
Catalogue: creating and updating products, prices and stock
-
Orders: reading, changing status, exporting into your own system
-
Users: profiles and points balances
-
An OpenAPI specification — the client is generated, not hand-written
Webhooks
-
The app notifies your service of an event in real time
-
A new order kicks off your processing: CRM, warehouse, courier service
-
order.bonus.calculate — loyalty calculation stays on your side
-
No polling the API on a schedule waiting for something to change
Scenarios
What people build with it
Nobody reaches for an API for its own sake. Here are the three jobs it is used for most often — none of which can be solved with settings in the panel.
Your own loyalty mechanics
The webhook hands the order to an external calculator, which returns the points to award under your rules — however complex, down to segments and partner programmes.
External delivery calculation
Cost and timing are worked out by your service or your courier partner, and the app shows the finished answer right in the checkout.
ERP syncing
Stock and orders move both ways even where no ready connector exists for your system — the exchange is written on top of the Merchant API.
Try the ready-made route first
All integrations
If a connector already exists
Before writing code, check the list of ready integrations: standard exchange of catalogue, prices, stock and orders is configured without development — and costs less than maintaining an exchange of your own.
FAQ
Common questions about the Merchant API
What does the Merchant API let us do?
Manage the catalogue (products, prices, stock), orders and app users programmatically. It is the way to sync the app with any back office.
How are webhooks different from the API?
You call the API yourself when you need to read or change data. Webhooks work the other way round: the app sends them to you automatically when an event happens — a new order, for instance — so your processing can run in real time.
Do we need the API if a catalogue export is enough?
If you run WooCommerce, or a scheduled YML/CSV export keeps up with your stock, you do not. The Merchant API is for non-standard logic, and for stock that changes faster than an export can be refreshed.
What can realistically be built on the API and webhooks?
An external delivery calculator, your own loyalty mechanics, two-way syncing of orders and stock with an ERP or CRM, and event forwarding to third-party services.
Is the API available on every plan?
Deep customisation and full control over your data are primarily Enterprise-plan capabilities. Check the exact scope with your account manager when choosing a plan.
We will show you your app tomorrow
Send us a request and we will build a demo on your catalogue
in one day, with no access to your website.