Order Skills API
v1Read the skills an order requires or prohibits, the driver it is locked to, and the drivers prohibited from taking it.
Skills constrain which driver can take an order. This endpoint returns the skills an order requires and prohibits, where each requirement comes from, the driver the order is locked to, and any drivers prohibited from taking it.
The endpoint is read-only.
Endpoints Overview
| Endpoint | Required access |
|---|---|
GET/v1/orders/{orderId}/skillsReturns all required and prohibited skills for an order, along with driver lock and prohibited drivers | Orders · View |
The badge is the access group and level an API client needs for the call. See access groups and levels.
Interactive API Explorer
Loading API Documentation...
Reading an order’s skills
GET /v1/orders/{orderId}/skills
{
"requiredSkills": [{ "skillName": "ADR", "sources": [...] }],
"prohibitedSkills": [],
"driverLock": { "driverId": 11, "driverName": "Anna Hansen" },
"prohibitedDrivers": []
}Each skill lists its sources (where the requirement comes from — e.g. a product or order type). driverLock is set when the order is locked to a specific driver; when absent, any driver with matching skills and availability can take it. prohibitedDrivers lists drivers who must not be given the order, each with driverId and driverName.
Related documentation
- Orders - Cancel, replan, book and read orders
- Driver Availability - Which drivers an order can be dispatched or locked to
- Authentication - API keys and access groups