Order-Vehicle Restrictions

Endpoints used for managing order-vehicle restriction sets.

Order-vehicle restrictions define constraints between orders and vehicles based on labels. Each restriction rule links an order label to a vehicle label with a specific relationship type and an enforcement that is either hard (the combination is strictly enforced) or soft (a violation cost is applied when the restriction is violated during planning).

Restriction types:

FORBIDDEN_COMBINATION — Orders with the specified label must not be assigned to vehicles with the specified label.
ORDER_REQUIRES_VEHICLE — Orders with the specified label require vehicles with the specified label.
VEHICLE_REQUIRES_ORDER — Vehicles with the specified label require orders with the specified label.

Operations

List the existing order-vehicle restriction sets

Request

Retrieve order-vehicle restriction 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 restriction sets that should be returned in the response

Default:100

Example:limit=100

Payload

// No request payload

Responses

Bodyapplication/json

dataArray of objects(OrderVehicleRestrictionSetListSummary)required

Subset of order-vehicle restriction 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"
  }
}