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 orders for one company-owned daily plan. The bearer token identifies the company. All orders must have the same non-empty delivery date. The delivery date must be today or later in Europe/Berlin. Past dates return 423 without saving orders. Past company plans cannot be edited, shared, or finalized; their saved results remain readable. Finalized plans remain locked. Repeating a submission replaces all orders and invalidates the shared result, including when the payload is identical. Private drafts remain private. A plan number cannot change dates, and a date cannot be reassigned from another plan number or an existing Excel plan. These conflicts return 409.

Authorizations:
bearerAuth
Request Body schema: application/json
required
tourplan_nr
required
string [ 1 .. 128 ] characters

Stable tour plan identifier, unique within the authenticated company.

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 latest company-shared saved routes, including manual changes. Private drafts are never returned. Replaced input has no result until a new calculation is shared. Finalized results remain readable.

Authorizations:
bearerAuth
path Parameters
tourplan_nr
required
string
Example: 31288

Responses

Response samples

Content type
application/json
{
  • "all_in": {
    },
  • "tourplan_nr": "31288",
  • "datum": "2019-08-24",
  • "erstellt_am": "2019-08-24T14:15:22Z",
  • "status": "berechnet",
  • "routen": [
    ],
  • "nicht_zugewiesene_auftraege": [
    ]
}