Skip to content

PTV OptiFlow Order Book API (1.8.1)

Order Book provides ready-to-run domain-specific logistic data governance for your route optimization.

Download OpenAPI description
order-book-api.json
order-book-api.yaml
Overview
URL
https://servicedesk.conundra.eu
Servers
Mock server
https://developer.conundra.eu/_mock/apis/order-book/order-book-api
Order Book API Production
https://api.conundra.eu/orderbook/v1

Health check

Miscellaneous endpoints for general API functionality

Operations

Orders

Endpoints for querying orders across all order types.

Operations

Get a cursor-paged list of orders

Request

Retrieve a cursor-paged list of all orders across all order types.

You can find out more about how to use cursors in our developer portal.

Security
clientCredentials
Query
cursorstring

Cursor of the page to retrieve. Can be left blank initially to retrieve the first page. Paging through the results requires passing in the cursor from a previous response.

limitinteger(int32)[ 1 .. 1000 ]

Number of results per page.

Default 100

Responses

A cursor-based paged set of orders. The set might be empty if no orders are present.

Bodyapplication/json
dataArray of objects(OrderSummary)required

Subset of orders matching the provided query, limited to the size specified in the request.

business_idstringrequired

The unique business identifier of the order.

Example: "orderA"
cursorobject(Cursor)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"
  }
}

Pickup Orders

Pickup orders represent an order where the executor needs to pick up cargo at a certain stop.

Operations

Delivery Orders

Delivery orders represent an order where the executor needs to drop off cargo at a certain stop.

Operations

PickupDelivery Orders

PickupDelivery orders represent an order where the executor needs to pick up cargo at a certain stop and deliver it at another stop.

Operations

Consolidated Orders

Orders are being consolidated by the application to enrich them with captured domain knowledge through Conditionals and/or Locations. These endpoints provide insights into and discoverability of the results of this consolidation.

Operations

Category Management

[EXPERIMENTAL] Endpoints for managing Categories.

Experimental Status: These endpoints have an experimental status since their complexity was impacted by a removed feature. We intend at the very least to vastly simplify these endpoints by removing the code-subresource.

Operations

Transport Requests

Transport Requests can be used to group Orders that share some administrative context. They can serve as a way of targeting Orders through conditionals, by providing context on the client companies for which those orders are being executed.

Operations

Companies

Companies can be managed in Order Book and used as clients for Transport Requests. This allows you to target Conditionals to Orders contained within Transport Requests for select clients.

Operations

Locations

Locations can be managed separately in Order Book, which allows the user to capture their related business rules in a reusable manner. This is especially valuable in business cases where a select set of Locations is reused across many orders.

Typical use cases include capturing regular opening hours or requirements tied to a specific Location.

Operations

Conditionals

Conditionals allow you to capture business rules in Order Book. You can target Orders based on several attributes or create time-based rules, and apply mutations to this order set enriching for your optimization.

Operations

Partial Routes [EXPERIMENTAL]

[EXPERIMENTAL] [UNDER DEVELOPMENT] Endpoints for managing preplanned PartialRoutes.

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