Help centre / For developers
API & webhooks
Connect other software to your store with API keys, webhooks and OAuth apps.
API keys
API keys → Create key. Copy it when shown — it starts with bzk_ and is displayed once. Send it on every call:
curl https://<your-store-address>/api/public/products \
-H "Authorization: Bearer bzk_your_key"
Main endpoints under /api/public:
| Endpoint | What it does |
|---|---|
GET /products |
List products. |
POST /products |
Create a product. |
GET /orders?status= |
List orders, optionally by status. |
GET /catalog?format= |
Catalogue export (CSV / feed formats). |
GET /webhooks, POST /webhooks, DELETE /webhooks/{id} |
Manage webhooks. |
Treat keys like passwords; delete a key in API keys to stop it working.
Every endpoint, field and response is in the API reference at /api/reference on your store's address (or the BazaarSaaS address), where you can also try calls with your key.
Webhooks
Webhooks → Add endpoint with your URL and the events you want (order.confirmed, order.shipped). BazaarSaaS
POSTs a JSON body to your URL, signed with your endpoint's secret in the X-BazaarSaaS-Signature header — check it
before trusting the call. Failed deliveries are retried; use Send test (a ping event) to try your endpoint.
Apps (OAuth)
Software that works for many stores connects through OAuth instead of a key: the merchant approves the scopes
the app asks for, and the app gets a bzoauth_ token limited to those scopes. Register apps in Apps.
Still stuck? Talk to us — we'll help you set it up. Talk to us