Developer API
The v1 REST API gives apps access to an organization's data: a merchant's own ERP, WMS or script, or a partner's software installed by many merchants. Read orders, create and cancel shipping labels (AWB), issue invoices and receive webhooks when something changes.
Every request goes to the same base URL:
https://api.connectato.com/v1Requests and responses are JSON. The API uses no sessions or cookies: every request authenticates on its own.
One way in: apps
Section titled "One way in: apps"Every caller is an app, made in the partner portal and installed in an organization. Who will use what you build?
- One organization (your ERP, your warehouse system, a script, or a client's integration): a private app. Installed through its link, no store listing, no review; your server takes its tokens with OAuth client credentials. Private apps.
- Many merchants, each installing it in their own organization: a public app, listed in the app store once reviewed and installed through OAuth authorization code. Your app.
| Private app | Public app | |
|---|---|---|
| Who uses it | One organization, chosen at creation | Every merchant who installs it |
| Installed from | Its install link | The app store, through OAuth |
| Tokens | Client credentials, then Authorization: Bearer <access token> |
Authorization code with PKCE, then Authorization: Bearer <access token> |
| Review | None | Before each version reaches the store |
| Webhooks | Yes | Yes |
The API, the scopes and the responses are the same for both. An installation belongs to the organization, never to the person who approved it: an integration keeps working after that person leaves. Every call is recorded and visible to the merchant, per app. In detail, with the words these docs use: Choose your path.
What v1 covers
Section titled "What v1 covers"| Resource | Endpoints | Scopes |
|---|---|---|
| Orders | GET /orders, GET /orders/{id}, POST /orders and POST /orders/batch (a store app's own orders) |
read_orders, write_orders |
| Shipments (AWB) | GET /shipments, GET /shipments/{id}, POST /shipments, POST /shipments/{id}/cancel |
read_shipments, write_shipments |
| Invoices | GET /invoices, GET /invoices/{id}, POST /invoices |
read_invoices, write_invoices |
| Integrations | GET /integrations, GET /integrations/{id} |
read_integrations |
| Organization and caller | GET /organization |
none |
A write through the API does exactly what the button in the dashboard does: the same checks, the same locks, the same rules. The API has no rules of its own.
Start here
Section titled "Start here"Partners' use of the API is governed by the Partner agreement.