Let your own software talk to your store

There are ready endpoints for products, categories, brands, orders, stock and shipping. Each key gets only the permission it needs, plus a rate limit and an IP limit.

Open Your Free Store See the Plans

Key

Scope Read / write
Rate limit Requests/minute
IP limit You give a list

What you get on the API side

Four headings: which endpoints exist, how a key is protected, what can be written and which events notify you.

Endpoints

Ready endpoints, no setup to wait for

Endpoints for products, categories, brands, orders, stock and shipping arrive ready. Your own software reads from them without commissioning development.

Endpoints that come ready

products categories brands orders stock products/price orders/shipment webhooks

There are ready endpoints for products, categories, brands, orders, stock and shipping. Your own software reads from them, and can write to stock, price, order status and shipping.

Security

A key does not carry unlimited power

You grant each key only what it needs. You also set how many requests a minute it may make, when it expires and which IPs may use it.

Key security

Permissions Read and write apart
Rate limit Requests/minute
Expiry You set a date
IP limit You give a list

Each key gets only the permission it needs. You also set how many requests a minute it may make, when it expires and which IP addresses may use it.

Writing

Write access is granted apart from read

You can give a key stock updates only and keep it away from prices. Chargeable actions such as creating a shipment sit behind their own permission.

Write permissions

Update stock levels
Update product price
Change order status
Create a shipment

Write permissions are granted apart from read. You can give a key stock updates only and keep it away from prices.

Events

You get told instead of asking repeatedly

When an order is created, its status changes, stock or price changes or a shipment opens, a notification goes to your address. You can subscribe to five events.

Outgoing events

order.created order.status_changed stock.changed product.price_changed shipment.created

No need to keep polling: when something happens, a message goes to your address. You can subscribe to five events.

Connecting your own system is always left for later

Integration looks like a separate project, so it never starts.

No endpoints, so development is needed

Even reading stock becomes a custom job.

Sharing a key feels risky

When one key can do everything, nobody wants to hand it over.

Everything is polled

A request goes out every minute just to catch a change.

Frequently asked

Does the API need extra development?

The endpoints arrive ready. You need something on your side that reads and writes through them; no development happens on the store side.

Can I limit what a key may do?

Yes. Read and write permissions are granted separately, and you also set a rate limit, an expiry date and a list of allowed IPs.

Which events fire a webhook?

Order created, order status changed, stock changed, product price changed and shipment created.

Can I revoke a key?

Yes. Keys are created, updated and revoked from the panel.

Related features

XML Integrations

If you would rather work with files than a live link.

Explore

Accounting / ERP

Connect your own ERP over the API.

Explore

Product and Stock Management

Where the stock write endpoints land.

Explore

Build the connection today.

Create the key in the panel, grant its scope and start trying it.

Open Your Free Store