Integrations
Distribu exposes three integration surfaces so you can connect it to the rest of your stack:
- REST API — pull data out, manage orders, customers, webhooks, and reports.
- Webhooks — receive push notifications when orders, customers, products, returns, or refunds change.
- CSV import / export — bulk-load or extract products and customers from a spreadsheet.
This page is a quick map of which surface to use for which job, with links to the full reference for each.
Pick the right tool
| You want to… | Use |
|---|---|
| Keep your ERP or accounting system in sync with new orders | Webhooks + the REST API |
| Pull a point-in-time export of orders, customers, or products | CSV export (dashboard) or REST API |
| Load an existing product catalog or customer list into Distribu | CSV import |
| Create orders from an external storefront or cart | REST API (POST /api/v1/orders) |
| Mark orders shipped from your warehouse / fulfillment tool | REST API (PATCH /api/v1/orders/{id}) |
| Populate a BI dashboard with real-time data | REST API (scheduled pull) |
| Trigger a Slack / pager alert when an order comes in | Webhooks — fire into your own workflow tool |
REST API
A simple JSON-over-HTTPS API covering products (read), orders (read, create, update), customers (read, create, update), reports (sales, customer-spend, inventory), and webhooks (full CRUD). API keys are created in Settings → API keys with per-scope permissions so a read-only BI integration can't accidentally create orders.
Start here:
- API overview — base URL, request format, rate limits.
- Authentication — creating and using API keys.
- Scopes — the nine scope values and which endpoints each one gates.
- Products, Orders, Customers, Reports, and Webhooks — per-resource reference.
Webhooks
Distribu can push you events the moment they happen, so you don't
have to poll. Twelve events today, spanning orders (order.created,
order.status_changed, order.shipped, order.cancelled),
customers (customer.created, customer.updated), products
(product.updated, product.low_stock), returns and refunds
(return.created, return.approved, refund.processed), and
billing (invoice.paid).
Each webhook is signed with your own secret so you can verify the request came from Distribu. Signing secrets can be rotated with a zero-downtime grace window.
Start here:
- Webhooks overview — how to register an endpoint and manage delivery.
- Event types — payload schemas.
- Signature verification — sample code in several languages.
- Retries & delivery — what happens when your endpoint is down.
CSV import / export
The spreadsheet-friendly path. Good for one-off migrations, bulk edits, and handing data to someone who doesn't write code.
- Products and customers support both import and export — the export file format matches the import format, so you can edit in Excel / Google Sheets and re-upload.
- Orders can be exported to CSV via the Reports section; there's no CSV import for orders (use the REST API to create them).
Start here:
- CSV formats overview — shared conventions.
- Products format
- Customers format
- Orders export format
Building a two-way ERP sync
The most common end-to-end integration — keeping Distribu and an ERP like NetSuite / QuickBooks / Xero in step — usually combines all three surfaces:
- One-time CSV import to seed customers and the product catalog.
- Webhooks for real-time: subscribe to
order.created,order.status_changed,order.shipped,order.cancelled, andrefund.processed, writing each event into your ERP as it arrives. - Daily reconciliation via the REST API — paginate
GET /api/v1/orders?since=<yesterday>and upsert in your ERP to catch anything a webhook missed. See Retries & delivery for why reconciliation is worth it. - Write-back with
PATCH /api/v1/orders/{id}from your warehouse / fulfillment tool to mark ordersSHIPPEDorDELIVERED.
Need something that isn't here?
If you want an integration we haven't built yet — SMS / Slack push, a native Shopify app, a connector for a specific ERP, bulk API writes for products — email support@distribu.app. We prioritize the roadmap based partly on what customers are asking for.
Next: FAQ & troubleshooting.
