Integration API (V1)
Simplified REST API for third-party integrations with order management and dispatching
Overview
The Integration API (V1) provides a simplified set of endpoints for third-party systems (ERP, CRM, etc.) to create orders, retrieve order details, manage tags, and dispatch orders to contractors. These endpoints use API token authentication and are designed for server-to-server integrations.
The Integration API is a subset of the full API, optimized for common integration workflows. For advanced use cases, see the full API Reference.
Authentication
All Integration API endpoints require a Bearer token. See Authentication for how to create API tokens.
Endpoints
Orders
| Endpoint | Description |
|---|---|
| Create Order | Create a new order from your external system |
| Create Webform Order | Create an order via a webform |
| Dispatch Order | Dispatch an order to a contractor |
| Cancel Order | Cancel an existing order |
Files
| Endpoint | Description |
|---|---|
| Upload File | Upload a file to attach to an order |
Order Tags
| Endpoint | Description |
|---|---|
| List Order Tags | Retrieve all order tags |
| Create Order Tags | Create new order tags |
| Assign Tag to Order | Assign a tag to an order |
| Remove Tag from Order | Remove a tag from an order |
Installers
| Endpoint | Description |
|---|---|
| List Installers | List available installer partners |
Webforms
| Endpoint | Description |
|---|---|
| Get Webform | Retrieve webform configuration |
Typical Integration Flow
A common ERP integration follows this pattern:
1. ERP creates order → Create Order
2. ERP assigns tag → Assign Tag to Order
3. ERP dispatches → Dispatch Order
4. Webhook notifies → order.completed
5. ERP fetches result → (via webhook payload)Use webhooks to receive real-time notifications when order status changes, rather than polling.
Error Handling
| Status | Description | Action |
|---|---|---|
200 | Success | Process the response |
400 | Bad request | Check request payload |
401 | Unauthorized | Verify API token |
404 | Not found | Check resource IDs |
422 | Validation error | Check required fields |
The Integration API uses the same rate limits as the main API. Implement retry logic with exponential backoff for production integrations.