API docs by Redocly

Order Import API (1.0.0)

Download OpenAPI specification:

API for external companies to submit tour plans containing orders. Delivery times use the Europe/Berlin timezone, including daylight saving time.

Submit orders

Submit a tour plan and its associated orders as JSON.

Authorizations:
bearerAuth
Request Body schema: application/json
required
tourplan_nr
required
string

Tour plan identifier.

required
Array of objects (Order) non-empty

Orders associated with the tour plan.

Responses

Request samples

Content type
application/json
{
  • "tourplan_nr": "31288",
  • "auftraege": [
    ]
}

Response samples

Content type
application/json
{}

Retrieve a calculated tour plan

Returns the saved routes, including manual changes, for a tour plan belonging to the authenticated company. Values that are unavailable or no longer valid after manual changes are returned as null. Timings, distances, and geometry describe the current route only when they have been calculated for that route.

Authorizations:
bearerAuth
path Parameters
tourplan_nr
required
string
Example: 31288

Responses

Response samples

Content type
application/json
{
  • "tourplan_nr": "31288",
  • "unternehmen_id": "0e05e017-bfb7-486b-ba7b-650f5187dbd8",
  • "datum": "2019-08-24",
  • "erstellt_am": "2019-08-24T14:15:22Z",
  • "status": "berechnet",
  • "routen": [
    ],
  • "nicht_zugewiesene_auftraege": [
    ]
}