Order-Vehicle Preferences

Endpoints used for managing order-vehicle preference sets.

Order-vehicle preferences define soft constraints between orders and vehicles based on labels. Each preference rule links an order label to a vehicle label with a specific relationship type and a fine (penalty cost) that is applied when the preference is violated during planning.

Preference types:

FORBIDDEN_COMBINATION — Orders with the specified label are penalized when assigned to vehicles with the specified label.
ORDER_REQUIRES_VEHICLE — Orders with the specified label prefer vehicles with the specified label; a fine is applied if assigned to a different vehicle.
VEHICLE_REQUIRES_ORDER — Vehicles with the specified label prefer orders with the specified label; a fine is applied if assigned different orders.

Operations

List the existing order-vehicle preference sets

Request

Retrieve order-vehicle preference sets using cursor-based paging (see the Cursor-based pagination documentation on the PTV Developer Portal for more details).

Security

clientCredentials

Query

cursorstring

The cursor of the page to retrieve. No cursor is needed to retrieve the first page.

limitinteger, (int32), [ 1 .. 1000 ]

The maximum amount of order-vehicle preference sets that should be returned in the response

Default:100

Example:limit=100

curl -i -X GET \
  'https://developer.conundra.eu/_mock/apis/plannings/planning-api/settings/order-vehicle-preference-sets?cursor=string&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

dataArray of objects(OrderVehiclePreferenceSetListSummary)required

Subset of order-vehicle preference sets matching the provided query, limited to the limit specified in the request.

cursorsobject(CursorsWithOnlyNext)required

Cursor that only supports next cursor navigation.

Response

{
  "data": [
    { … }
  ],
  "cursors": {
    "next": "bmV4dF9fcGFnZQ"
  }
}