The Orderfy API and webhooks
API and webhooks.
Connect an online store, a reporting tool or your own software to a business's Orderfy data, with their permission and within the scopes they choose.
At a glance
The basics.
A conventional, predictable API. If you have used a REST API before, you already know how this one works.
- Style
- REST, with JSON in and out
- Version
- /v1. Fields can be added within a version, but none are renamed or removed
- Authentication
- A bearer API key for each integration, created by an admin in Settings → API
- Scopes
- Each key is limited to what its integration needs, and optionally to your own IP addresses
- Reference
- An OpenAPI 3.1 description, served by the API itself
- Limits
- 600 requests a minute, and a monthly allowance, both shown in the response headers
- Errors
- A consistent error object with a code and a message, and a request ID on every response
- Resources
- Products, customers, suppliers, sales orders, invoices and purchase orders
- Sandbox
- A copy of your account to build and test against
Keys you control
Create, suspend and revoke keys yourself. A key is shown once, and stored only as a hash.
Webhooks
Orderfy calls your system when an order, an invoice or a delivery changes, so you never have to poll for it.
Safe by default
The API is for servers, not browsers. Every call is authenticated, scoped, rate-limited and logged.
Which plan includes the Orderfy API?
The public API, webhooks and a sandbox are part of the Max plan.
Is there an OpenAPI specification?
Yes. The API serves an OpenAPI 3.1 description of itself, built from its own routes, so it is always current.
How do I get API access?
An admin in your business creates a key in Settings → API. If you are a developer building for an Orderfy customer, ask them for a key, or contact partners@orderfy.com.au about a partner sandbox.
Building something?
Tell us what you want to connect and we will point you at the right endpoints.