Scope reference
Scopes are assigned per Integration Client. A request must have the required scope for the endpoint. Missing scopes return HTTP 403.
| Scope | Purpose |
|---|---|
integration.health.read | Check whether authentication works |
inbound.targets.write | Create or update single inbound targets |
inbound.targets.batch.write | Create or update multiple inbound targets in a batch |
customers.map | Map imported records to existing customer, location and contact references |
customers.write | Create or update customers, locations and contacts during import |
customers.read | Return detailed customer mapping objects and Ordinavo IDs in API responses |
import_jobs.read | Read import job status and item results |
route_suggestions.create | Create draft route suggestions from imported targets |
route_suggestions.read | Read route suggestion metadata |
webhooks.read | Read webhook subscriptions |
webhooks.manage | Create, update and disable webhook subscriptions |
webhook_deliveries.read | Read webhook delivery status |
Customer mapping scopes
inbound.targets.write is required to import targets. Add customers.map to link incoming records to existing Ordinavo customer references. Add customers.write only when the integration is allowed to auto-create or update customers, locations and contacts. Add customers.read when the API response should include detailed mapping IDs.
Recommended default
Use stable external IDs and the customers.map scope first. Enable customers.write only for integrations that are trusted to maintain customer master data.
Missing scope response
{
"error": {
"code": "missing_scope",
"message": "The integration client does not have the required scope.",
"requiredScope": "inbound.targets.write",
"correlationId": "7d97b0f5..."
}
}