Skip to content
/
List the existing depot s...

Planning API (1.5.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

Location Workload Levelling

Endpoints used for managing location workload levelling sets.

Operations

Order-Order Restrictions

Endpoints used for managing order-order restriction sets.

Operations

Depot Sets [EXPERIMENTAL]

Endpoints used for managing depot sets.

Operations

List the existing depot sets

Request

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

Default 100
Example: limit=250

Responses

OK

Bodyapplication/json
dataArray of objects(DepotSetListSummary)

The set of results for the current page.

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

Get depot set

Request

Retrieves detailed information on the given depot 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_idstringread-only

The unique identifier for the depot set.

Example: "cb1fb12c-0abc-413c-a69d-63c62566685f"
namestring[ 1 .. 200 ] charactersrequired

The name of the depot set

Example: "Belgian Depots"
depotsArray of objects(Depot)[ 1 .. 50 ] itemsrequired

List of depots in this set

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

Identifier of a depot unique within the set

Example: "depot-ghent"
namestring[ 1 .. 200 ] charactersrequired

Name of the depot

Example: "Depot Ghent"
addressobject(DepotAddress)required

Address information for the depot. When geo_point is provided, address fields (address_line, city, zip_code, country_code) are optional. When geo_point is omitted, address fields must be provided so that the address can be geo-coded.

address_linestring[ 1 .. 500 ] characters

The part of the address that includes the street name, house number, bus number etc. Required when omitting geo_point.

Example: "Voordries 41"
citystring[ 1 .. 200 ] characters

City name. Required when omitting geo_point.

Example: "Oosterzele"
zip_codestring[ 1 .. 20 ] characters

Postal code. Required when omitting geo_point.

Example: "9860"
country_codestring(CountryCode)^[A-Z]{2}$

represents the ISO3166-1 alpha-2 two letter country codes

geo_pointobject(GeoPointWithResolvedInfo)
stop_timestring(duration)

Stop time at the depot in ISO-8601 duration format

Default "PT0M"
Example: "PT5M"
Response
application/json
{
  "business_id": "cb1fb12c-0abc-413c-a69d-63c62566685f",
  "name": "Belgian Depots",
  "depots": [
    { … }
  ]
}

Upsert depot set

Request

Create or update a depot set. A unique ID (business_id) is required to identify the depot set. Calling this endpoint with an existing business_id will update the depot 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 .. 200 ] charactersrequired

The name of the depot set

Example: "Belgian Depots"
depotsArray of objects(Depot)[ 1 .. 50 ] itemsrequired

List of depots in this set

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

Identifier of a depot unique within the set

Example: "depot-ghent"
namestring[ 1 .. 200 ] charactersrequired

Name of the depot

Example: "Depot Ghent"
addressobject(DepotAddress)required

Address information for the depot. When geo_point is provided, address fields (address_line, city, zip_code, country_code) are optional. When geo_point is omitted, address fields must be provided so that the address can be geo-coded.

address_linestring[ 1 .. 500 ] characters

The part of the address that includes the street name, house number, bus number etc. Required when omitting geo_point.

Example: "Voordries 41"
citystring[ 1 .. 200 ] characters

City name. Required when omitting geo_point.

Example: "Oosterzele"
zip_codestring[ 1 .. 20 ] characters

Postal code. Required when omitting geo_point.

Example: "9860"
country_codestring(CountryCode)^[A-Z]{2}$

represents the ISO3166-1 alpha-2 two letter country codes

geo_pointobject(GeoPointWithResolvedInfo)
stop_timestring(duration)

Stop time at the depot in ISO-8601 duration format

Default "PT0M"
Example: "PT5M"

Responses

depot 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
Company
PTV Logistics
Copyright © Conundra BV - PTV Logistics GmbH. All right reserved.