Zum Inhalt springen

Offene Schnittstelle

Tour und Aufträge

Jede Buchung mit Lieferung hat zwei Aufträge: die Lieferung am ersten Miettag und die Abholung am Abreisetag. Die Tour eines Tages ist die Liste dieser Aufträge.

GET/api/ext/v1/days/{date}

Recht day.viewErfolg 200

Eine flache Liste in der Reihenfolge der Tour. Kein Lieferfenster: es gibt keine Uhrzeit, zu der geliefert wird, und deshalb auch kein Feld dafür.

Im Pfad

ParameterTypBedeutung
datestringEin Tag als JJJJ-MM-TT.
Felder der Antwort
FeldTypBedeutung
datestringDer abgefragte Tag.
jobsobject[]Aufträge: Lieferung und Abholung.
jobs[].idintegerNummer des Auftrags. Mit ihr melden Sie ihn als erledigt.ab -9007199254740991
jobs[].kindstringdelivery für die Lieferung, pickup für die Abholung.Erlaubt: delivery, pickup
jobs[].onDatestringGeplanter Tag.
jobs[].sortOrderinteger | nullPlatz in der Tour, gezählt ab 1. null, solange niemand die Tour geordnet hat.ab -9007199254740991
jobs[].statusstringopen, done oder skipped. Ein übersprungener Auftrag gilt nicht als erledigt.Erlaubt: open, done, skipped
jobs[].accommodationobjectWohin der Auftrag geht.
jobs[].accommodation.idinteger | nullab -9007199254740991
jobs[].accommodation.namestringName der Unterkunft.
jobs[].accommodation.streetstringStraße und Hausnummer.
jobs[].accommodation.zipstringPostleitzahl.
jobs[].accommodation.citystringOrt.
jobs[].bookingobjectDie Buchung hinter dem Auftrag.
jobs[].booking.refstringBuchungsnummer in der Form SB-JJMMTT-XXXX.
jobs[].booking.statusstringZustand der Buchung, siehe Zustände.
jobs[].booking.guestNamestringVor- und Nachname der buchenden Person. Nach dem Löschlauf steht hier nur noch die Kurzform, etwa „Martin B.“.
jobs[].booking.phonestring,nullTelefonnummer des Gastes für Rückfragen des Fahrers.
jobs[].booking.roomsstring[]Zimmernummern. Stehen auf dem Tagesauftrag des Fahrers.
jobs[].booking.personsintegerAnzahl der Personen mit Leihausrüstung.ab -9007199254740991
jobs[].booking.pickupAtDepotbooleantrue: der Gast holt im Shop ab, es gibt keine Lieferung.
jobs[].notestring,nullNotiz zum Auftrag.
jobs[].skipReasonstring,nullGrund, wenn der Auftrag übersprungen wurde.
jobs[].doneAtstring,nullZeitpunkt, zu dem der Auftrag erledigt oder übersprungen wurde.
jobs[].doneBystring,nullWer ihn gemeldet hat: der Name des Mitarbeiters oder des Schlüssels.
jobs[].doneOnDatestring,nullDer Tourtag, an dem erledigt wurde. Den setzt der Server.
jobs[].earlyDonebooleantrue, wenn vor dem geplanten Tag erledigt wurde, etwa am Abend davor. Solche Aufträge gehören nicht mehr in die Tour des Tages.
countsobjectZählung über alle Aufträge des Tages.
counts.deliveryintegerAnzahl Lieferungen.ab -9007199254740991
counts.pickupintegerAnzahl Abholungen.ab -9007199254740991
counts.openintegerNoch offen.ab -9007199254740991
counts.doneintegerErledigt.ab -9007199254740991
counts.skippedintegerÜbersprungen.ab -9007199254740991
Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/days/2026-12-27" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

Antwort anzeigen 75 Zeilen
{
"date": "2026-12-27",
"jobs": [
{
"id": 3,
"kind": "delivery",
"onDate": "2026-12-27",
"sortOrder": null,
"status": "open",
"accommodation": {
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf"
},
"booking": {
"ref": "SB-261114-WWNP",
"status": "confirmed",
"guestName": "Martin Berger",
"phone": "+49 000 0000002",
"rooms": [
"204",
"205"
],
"persons": 3,
"pickupAtDepot": false
},
"note": null,
"skipReason": null,
"doneAt": null,
"doneBy": null,
"doneOnDate": null,
"earlyDone": false
},
{
"id": 5,
"kind": "delivery",
"onDate": "2026-12-27",
"sortOrder": null,
"status": "open",
"accommodation": {
"id": 3,
"name": "Pension Sonnblick",
"street": "Sonnweg 4",
"zip": "5999",
"city": "Bergdorf"
},
"booking": {
"ref": "SB-261227-ZA22",
"status": "confirmed",
"guestName": "Sophie Lang",
"phone": "+43 000 000003",
"rooms": [
"3"
],
"persons": 2,
"pickupAtDepot": false
},
"note": null,
"skipReason": null,
"doneAt": null,
"doneBy": null,
"doneOnDate": null,
"earlyDone": false
}
],
"counts": {
"delivery": 2,
"pickup": 0,
"open": 2,
"done": 0,
"skipped": 0
}
}

Die Antwort ist eine flache Liste in der Reihenfolge der Tour, keine Gruppierung nach Haus. Wer nach Haus gruppieren will, nimmt accommodation.id.

  • Für ein Hotel ist das der Zustellstatus: die Einträge mit der eigenen accommodation.id, je mit Gast, Zimmern und status.
  • sortOrder ist null, solange niemand die Tour geordnet hat.
  • earlyDone ist true, wenn ein Auftrag vor seinem geplanten Tag erledigt wurde, etwa am Abend davor. Ein Programm, das die Tour des Tages zeichnet, lässt diese Aufträge weg. An welchem Tag wirklich erledigt wurde, nennt doneOnDate.

So sieht derselbe Tag aus, nachdem eine Lieferung erledigt und eine übersprungen wurde:

Antwort200OK

Antwort anzeigen 75 Zeilen
{
"date": "2026-12-27",
"jobs": [
{
"id": 3,
"kind": "delivery",
"onDate": "2026-12-27",
"sortOrder": null,
"status": "done",
"accommodation": {
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf"
},
"booking": {
"ref": "SB-261114-WWNP",
"status": "delivered",
"guestName": "Martin Berger",
"phone": "+49 000 0000002",
"rooms": [
"204",
"205"
],
"persons": 3,
"pickupAtDepot": false
},
"note": "Im Skiraum abgestellt, Fach 204.",
"skipReason": null,
"doneAt": "2026-12-27T08:12:46.278Z",
"doneBy": "Kassensystem",
"doneOnDate": "2026-12-27",
"earlyDone": false
},
{
"id": 5,
"kind": "delivery",
"onDate": "2026-12-27",
"sortOrder": null,
"status": "skipped",
"accommodation": {
"id": 3,
"name": "Pension Sonnblick",
"street": "Sonnweg 4",
"zip": "5999",
"city": "Bergdorf"
},
"booking": {
"ref": "SB-261227-ZA22",
"status": "confirmed",
"guestName": "Sophie Lang",
"phone": "+43 000 000003",
"rooms": [
"3"
],
"persons": 2,
"pickupAtDepot": false
},
"note": "Zweiter Versuch nach 17 Uhr.",
"skipReason": "Niemand angetroffen, Rezeption nicht besetzt.",
"doneAt": "2026-12-27T08:41:18.040Z",
"doneBy": "Kassensystem",
"doneOnDate": "2026-12-27",
"earlyDone": false
}
],
"counts": {
"delivery": 2,
"pickup": 0,
"open": 0,
"done": 1,
"skipped": 1
}
}

Die Buchung hinter dem erledigten Auftrag steht jetzt auf delivered.

PATCH/api/ext/v1/jobs/{id}

Recht job.completeErfolg 200

Bei skipped ist skipReason Pflicht. Der Buchungsstatus folgt: geliefert, abgeholt, und erst wenn beide Aufträge erledigt sind, geschlossen.

Im Pfad

ParameterTypBedeutung
idstringDie Nummer des Auftrags aus jobs[].id.

Im Rumpf

FeldTypBedeutung
statusstringdone erledigt, skipped übersprungen, open nimmt beides zurück.Erlaubt: open, done, skipped
skipReasonstringPflicht bei skipped, etwa „niemand angetroffen“.max. 400 Zeichen
notestringNotiz zum Auftrag. Geht auch ohne Statuswechsel.max. 800 Zeichen

Die Antwort nennt den neuen Stand des Auftrags: jobId, status, doneAt, doneBy, doneOnDate, earlyDone, skipReason und note.

Terminal-Fenster
curl -X PATCH "https://skirent.sumware.at/api/ext/v1/jobs/3" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "done",
"note": "Im Skiraum abgestellt, Fach 204."
}'

Antwort200OK

{
"jobId": 3,
"status": "done",
"doneAt": "2026-12-27T08:12:46.278Z",
"doneBy": "Kassensystem",
"doneOnDate": "2026-12-27",
"earlyDone": false,
"skipReason": null,
"swapStatus": null,
"note": "Im Skiraum abgestellt, Fach 204."
}

doneBy ist der Name des Schlüssels. Den Tourtag in doneOnDate setzt der Server; er lässt sich nicht mitgeben.

Bei skipped ist ein Grund Pflicht. „Nicht angetroffen“ ohne Grund ist am nächsten Morgen nicht mehr zu klären.

Terminal-Fenster
curl -X PATCH "https://skirent.sumware.at/api/ext/v1/jobs/5" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "skipped",
"skipReason": "Niemand angetroffen, Rezeption nicht besetzt."
}'

Antwort200OK

{
"jobId": 5,
"status": "skipped",
"doneAt": "2026-12-27T08:41:18.040Z",
"doneBy": "Kassensystem",
"doneOnDate": "2026-12-27",
"earlyDone": false,
"skipReason": "Niemand angetroffen, Rezeption nicht besetzt.",
"swapStatus": null,
"note": null
}

Ohne Grund lehnt der Server ab:

Antwort400Bad Request

{
"error": {
"code": "invalid_request",
"message": "Ein übersprungener Auftrag braucht einen Grund.",
"status": 400,
"hint": "Feld skipReason mitsenden, etwa \"niemand angetroffen\".",
"documentation_url": "https://skirent.sumware.at/api/"
}
}

Ein übersprungener Auftrag gilt nicht als erledigt. Er ist der Grund für die zweite Fahrt.

Eine Notiz geht auch ohne Statuswechsel.

Terminal-Fenster
curl -X PATCH "https://skirent.sumware.at/api/ext/v1/jobs/5" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"note": "Zweiter Versuch nach 17 Uhr."
}'

Antwort200OK

{
"jobId": 5,
"note": "Zweiter Versuch nach 17 Uhr."
}

open nimmt done und skipped zurück.

Terminal-Fenster
curl -X PATCH "https://skirent.sumware.at/api/ext/v1/jobs/5" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "open"
}'

Antwort200OK

{
"jobId": 5,
"status": "open",
"doneAt": null,
"doneBy": null,
"doneOnDate": null,
"earlyDone": false,
"skipReason": null,
"swapStatus": null,
"note": null
}

Der Zustand der Buchung folgt den Aufträgen, wie im Portal:

Aufträge Buchung
Lieferung erledigt delivered
Abholung erledigt, Lieferung noch nicht collected
beide erledigt closed
ein Auftrag zurückgenommen einen Schritt zurück, bis confirmed

Sie setzen den Zustand der Buchung also nie selbst. Sie melden, was am Haus geschehen ist.