Offene Schnittstelle
Zustände und Begriffe
Buchung
Abschnitt betitelt „Buchung“status |
Bedeutung |
|---|---|
pending_payment |
An der Kasse der Website angelegt, die Zahlung steht aus. |
paid |
Die Zahlung ist geprüft. |
confirmed |
Bestätigt. Lieferung und Abholung stehen als Aufträge. Eine Buchung über die Schnittstelle beginnt hier. |
delivered |
Die Lieferung ist erledigt. |
collected |
Die Abholung ist erledigt, die Lieferung noch nicht. |
closed |
Lieferung und Abholung sind erledigt. |
cancelled |
Storniert. Aus jedem Zustand möglich. |
payment_failed |
Die Zahlung ist gescheitert. |
needs_review |
Bezahlt, aber danach ist etwas schiefgegangen. Das Büro klärt es im Portal. |
expired |
Nach 24 Stunden ohne Zahlung verfallen. |
delivered, collected und closed folgen den Aufträgen von selbst, siehe Tour und Aufträge.
„Gast nicht angereist“ ist kein Zustand, sondern ein Vermerk: das Feld absentAt an der Buchung.
Als Filter der Liste gehen alle zehn Werte, auch mehrere durch Komma getrennt.
Auftrag
Abschnitt betitelt „Auftrag“kind |
Bedeutung |
|---|---|
delivery |
Lieferung in die Unterkunft am ersten Miettag |
pickup |
Abholung am Abreisetag |
status |
Bedeutung |
|---|---|
open |
steht aus |
done |
erledigt |
skipped |
übersprungen, mit Grund. Gilt nicht als erledigt. |
Einen Tausch am Lift kennt das Produkt als dritte Art. Die Tour der offenen Schnittstelle zeigt ihn in der Fassung v1 nicht.
Positionen
Abschnitt betitelt „Positionen“Das Feld kind einer Position in lines sagt, wofür der Betrag steht.
kind |
Bedeutung |
|---|---|
equipment |
ein Stück Leihausrüstung |
poles |
Skistöcke. Zu Ski sind sie gratis. |
waiver |
Haftungsreduktion, ein Prozentsatz vom Mietpreis |
late_return |
Gebühr für die Rückgabe am nächsten Morgen |
deposit |
Kaution, ein durchlaufender Posten ohne Umsatzsteuer |
discount |
Nachlass, ein negativer Betrag |
course |
vermittelter Kurs, ohne Umsatzsteuersatz |
delivery |
Liefergebühr nach Zone, eine je Buchung, kann null sein |
article |
Artikel aus dem Shop, ein Kauf |
Herkunft
Abschnitt betitelt „Herkunft“source |
Bedeutung |
|---|---|
web |
auf der Website gebucht |
agent |
auf der Website gebucht, vorbereitet von einem KI-Assistenten über einen Entwurf |
admin |
vom Büro angelegt, im Portal oder über die Schnittstelle |
phone |
am Telefon aufgenommen |
Beim Anlegen über die Schnittstelle wählen Sie zwischen admin und phone.
Buchungsnummer
Abschnitt betitelt „Buchungsnummer“Eine Nummer wie SB-261114-WWNP hat drei Teile: das Kürzel SB, den Tag des Anlegens als JJMMTT und vier zufällige Zeichen. Das Alphabet lässt 0, O, 1, I und L aus, weil sie sich leicht verwechseln.
Die Nummer ist innerhalb eines Betriebs eindeutig. Ein Schlüssel findet nur Buchungen seines Betriebs.
Prüfcode
Abschnitt betitelt „Prüfcode“sealCode ist ein Fingerabdruck der Buchung zum Zeitpunkt der Bestätigung: Aufenthalt, Unterkunft, Positionen und Beträge. Er trägt keine Angaben zur Person. Der Gast findet ihn auf seiner Bestätigung, in der Schreibweise XXXXX-XXXXX.
Ob ein Code zu einer Buchung gehört, prüft ein offener Endpunkt auf der Domain des Betriebs, ohne Schlüssel:
curl "https://skiverleih-talstation.example/api/public/verify?ref=SB-261114-WWNP&code=WJ58JVBE38"const res = await fetch("https://skiverleih-talstation.example/api/public/verify?ref=SB-261114-WWNP&code=WJ58JVBE38");
const data = await res.json();if (!res.ok) throw new Error(`${data.error.code}: ${data.error.hint}`);console.log(data);import requests
res = requests.get( "https://skiverleih-talstation.example/api/public/verify", params={"ref": "SB-261114-WWNP", "code": "WJ58JVBE38"}, timeout=10,)data = res.json()if not res.ok: raise RuntimeError(f"{data['error']['code']}: {data['error']['hint']}")print(data)<?php
$ch = curl_init('https://skiverleih-talstation.example/api/public/verify?ref=SB-261114-WWNP&code=WJ58JVBE38');curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 10,]);$body = curl_exec($ch);$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$data = json_decode($body, true);if ($status >= 400) { throw new RuntimeException($data['error']['code'] . ': ' . $data['error']['hint']);}print_r($data);Antwort200OK
{ "status": "gueltig", "sealedAt": "2026-11-14T18:22:44.270Z"}status |
Bedeutung |
|---|---|
gueltig |
Der Code gehört zu dieser Buchung im heutigen Stand. |
ueberholt |
Der Code war gültig, die Buchung wurde seither geändert. replacedAt nennt den Zeitpunkt. |
unbekannt |
Die Buchung gibt es nicht oder der Code ist falsch. Beides sieht gleich aus. |
Die Antwort nennt nie Daten der Buchung. Je Adresse gehen 20 Prüfungen in der Minute.
Löschfrist
Abschnitt betitelt „Löschfrist“Jeder Betrieb löscht Gastdaten nach einer Frist, die er selbst festlegt. Danach bleiben Buchung, Positionen und Beträge stehen, Namen und Kontaktdaten nicht mehr. In der Schnittstelle erkennen Sie das an purged: true, an customer: null und daran, dass guestName nur noch eine Kurzform wie „Martin B.“ trägt.