Upsert order-vehicle preference set

Request

Create or update an order-vehicle preference set. A unique ID is required to identify the order-vehicle preference set. Calling this endpoint with an existing ID will update the order-vehicle preference set.

Security

clientCredentials

Path

idstring^[a-zA-Z0-9.~\-_]{1,200}$required

The unique identifier of an entity

If-Matchstring

Weak Etag used for optimistic locking.

Example:W/"24"

Bodyapplication/jsonrequired

namestring, [ 1 .. 250 ] charactersrequired

The name of the order-vehicle preference set

Example:"Heavy goods require large trucks"

order_vehicle_preferencesArray of objects, non-empty(OrderVehiclePreference)required

List of order-vehicle preferences in this set

curl -i -X PUT \
  'https://developer.conundra.eu/_mock/apis/plannings/planning-api/settings/order-vehicle-preference-sets/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: W/"24"' \
  -d '{
    "id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
    "name": "Heavy goods require large trucks",
    "order_vehicle_preferences": [
      {
        "order_label": "fragile",
        "vehicle_label": "careful-truck",
        "order": {
          "label": "fragile",
          "operator": "INCLUDING"
        },
        "vehicle": {
          "label": "fragile",
          "operator": "INCLUDING"
        },
        "type": "ORDER_REQUIRES_VEHICLE",
        "fine": 42.5
      }
    ]
  }'

Responses

order-vehicle preference set created successfully

Headers

ETagstring

A weak Etag (ex W/"<etag_value>") which contains the current version of the entity

Example:"W/\"25\""

Response

No content