Skip to content

Conundra Order Book API (1.6.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

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

[EXPERIMENTAL] Get list of all categories of an entity

Request

[EXPERIMENTAL] This endpoint allows you to retrieve list of categories of an entity.

Security
clientCredentials
Path
entitystringrequired

The unique entity for a type

Enum"order""location""transport-request"
Query
pageinteger(int32)>= 1

Number of the page to retrieve, see also Paging section.

Default 1
page_sizeinteger(int32)[ 1 .. 100 ]

Number of results by page, see also Paging section.

Default 10

Responses

OK

Bodyapplication/json
dataArray of objects(EntityCategory)[ 0 .. 100 ] itemsunique
pageobject(Paging)
Response
application/json
{
  "data": [
    { … }
  ],
  "page": {
    "total_items": 100,
    "total_pages": 10,
    "page_size": 10,
    "current_page": 1
  }
}

[EXPERIMENTAL] Get a category of an entity with specified code

Request

[EXPERIMENTAL] This endpoint allows you to get the category of an entity with a given code, including the ETag header for optimistic locking purpose

Security
clientCredentials
Path
entitystringrequired

The unique entity for a type

Enum"order""location""transport-request"
codestringrequired

The unique identifier for a type

Responses

OK

Headers
ETagstring

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

Bodyapplication/json
entitystringread-only

The entity type for which this category is valid.

Enum"order""location""transport-request"
Example: "location"
codestringread-onlyrequired

A unique code for this category, within the entity's categories.

Example: "codeA"
labelsobject(MultiLanguages)required

Descriptive labels for this category.

languagesobject

Key must be a valid ISO 639-1 language code.

default_labelstringrequired

label for the default language to fall back on

Example: "low emission zone"
Response
application/json
{
  "entity": "location",
  "code": "codeA",
  "labels": {
    "default_label": "low emission zone",
    "languages": { … }
  }
}

[EXPERIMENTAL] Create or Update a category of an entity with specified code

Request

[EXPERIMENTAL] This endpoint allows you to create or update an existing category of an entity.

When the code does not exist, a new category will be created for the entity. No ETag header is required yet. For a given code, the properties will be overwritten and then an ETag header is required. Do remark that the code in the body of the request, must correspond with the code in the path identifier

Security
clientCredentials
Path
entitystringrequired

The unique entity for a type

Enum"order""location""transport-request"
codestringrequired

The unique identifier for a type

Headers
If-Matchstring

weak Etag as optimistic locking check

Bodyapplication/jsonrequired

Update category of an entity request body

labelsobject(MultiLanguages)required

Descriptive labels for this category.

languagesobject

Key must be a valid ISO 639-1 language code.

default_labelstringrequired

label for the default language to fall back on

Example: "low emission zone"

Responses

Update successful

Headers
ETagstring

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

Response
No content

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.