Skip to content

PTV OptiFlow Planning API (1.10.0)

The planning API provides information about plannings and their lifecycle.

You can find out more in our developer portal.

Download OpenAPI description
planning-api.json
planning-api.yaml
Overview
URL
https://servicedesk.conundra.eu
Servers
Mock server
https://developer.conundra.eu/_mock/apis/plannings/planning-api
Production Api
https://api.conundra.eu/planning/v1

Health

Validate connection and accessibility of the API.

Operations

Plannings

Endpoints used for retrieving information about plannings and its releases.

Operations

Plan Profiles [EXPERIMENTAL]

Endpoints used for managing plan profiles.

Operations

Location Workload Levelling

Endpoints used for managing location workload levelling sets.

Operations

Order-Order Restrictions

Endpoints used for managing order-order restriction sets.

Operations

List the existing order-order restriction sets

Request

Retrieves detailed information on all order-order restriction sets, limited to at most 100 items.

Security
clientCredentials
Query
cursorstring

Cursor of the page to retrieve.

limitinteger(int32)[ 1 .. 100 ]

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

Default 100
Example: limit=100

Responses

OK

Bodyapplication/json
dataArray of objects(OrderOrderRestrictionSetResponse)required

Subset of Order-Order Restriction Sets matching the provided query, limited to the limit specified in the request.

business_idstring(BusinessId)^[a-zA-Z0-9.~\-_]{1,512}$

The identifier for this order-order restriction set

namestring[ 1 .. 250 ] characters

The name of the order-order restriction set

Example: "Ambient goods not with chilled goods"
etagstring(Etag)
cursorobject(Cursors)required
selfstring

The cursor for this page. Not present when the result contains no data.

Example: "c2VsZl9fcGFnZQ"
prevstring

The cursor for the previous page. Not present when fetching data for the first page.

Example: "cHJldmlvdXNfX3BhZ2U"
nextstring

The cursor for the next page. Not present when fetching data for the last page.

Example: "bmV4dF9fcGFnZQ"
Response
application/json
{
  "data": [
    { … }
  ],
  "cursor": {
    "self": "c2VsZl9fcGFnZQ",
    "prev": "cHJldmlvdXNfX3BhZ2U",
    "next": "bmV4dF9fcGFnZQ"
  }
}

Get order-order restriction set

Request

Retrieves detailed information on the given order-order restriction set.

Security
clientCredentials
Path
business_idstring^[a-zA-Z0-9.~\-_]+$required

The unique identifier of an entity

Responses

OK

Headers
ETagstring

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

Example: "W/\"25\""
Bodyapplication/json
business_idstring(BusinessId)^[a-zA-Z0-9.~\-_]{1,512}$

The identifier for this order-order restriction set

namestring[ 1 .. 250 ] characters

The name of the order-order restriction set

Example: "Ambient goods not with chilled goods"
restrictionsArray of objects(OrderOrderRestriction)

List of order-order restrictions in this set

Response
application/json
{
  "business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
  "name": "Ambient goods not with chilled goods",
  "restrictions": [
    { … }
  ]
}

Upsert order-order restriction set

Request

Create or update an order-order restriction set. A unique ID (business_id) is required to identify the order-order restriction set. Calling this endpoint with an existing business_id will update the order-order restriction set.

Security
clientCredentials
Path
business_idstring^[a-zA-Z0-9.~\-_]+$required

The unique identifier of an entity

Headers
If-Matchstring

Weak Etag used for optimistic locking.

Example: W/"24"
Bodyapplication/jsonrequired
namestring[ 1 .. 250 ] charactersrequired

The name of the order-order restriction set

Example: "Ambient goods not with chilled goods"
restrictionsArray of objects(OrderOrderRestriction)non-emptyrequired

List of order-order restrictions in this set

order_label_1stringnon-emptyrequired

First label

Example: "ambient"
typestring(OrderOrderRestrictionType)required

Type of restriction

Enum"NOT_TOGETHER_IN_VEHICLE_WITH""NOT_LOADED_OR_UNLOADED_WHILE_VEHICLE_CONTAINS""NOT_AFTER""NOT_IMMEDIATELY_AFTER""NOT_BEFORE""NOT_LOADED_WHILE_VEHICLE_CONTAINS""NOT_UNLOADED_WHILE_VEHICLE_CONTAINS"
order_label_2stringnon-emptyrequired

Second label

Example: "chilled"
vehicle_labelstring or null

Vehicle label

Example: "cooler truck"
One of:

Vehicle label

non-empty
stringnon-empty

Responses

order-order restriction set created successful

Headers
ETagstring

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

Example: "W/\"25\""
Locationstring

The URL of the newly created resource

Example: "/settings/order-order-restriction-sets/a-business-id"
Response
No content

Break Rules [EXPERIMENTAL]

Endpoints used for managing break rule sets.

Operations

Depot Sets [EXPERIMENTAL]

Endpoints used for managing depot sets.

Operations

Charging Location Sets [EXPERIMENTAL]

Endpoints used for managing charging location sets.

Operations
Company
PTV Logistics
Copyright © Conundra BV - PTV Logistics GmbH. All right reserved.