Wie plant man Aufträge per API?

Durch die Nutzung unserer API zur Planung von Lieferungen können Sie Ihren Kunden ermöglichen, eine Lieferung während des Abschlusses eines Kaufs auf Ihrer Website zu planen. Dies reduziert die Anzahl der Interaktionen mit Ihren Kunden und bietet ein angenehmes und integriertes Erlebnis.

Übersicht

1. Einrichtung in Urbantz
2. API-Dokumentation
3. Prozess

1. Einrichtung in Urbantz

Die Planung von Lieferungen per API erfordert das Vorhandensein eines Ablaufs vom Typ Planung. Detaillierte Informationen finden Sie in diesem Artikel.

2. API-Dokumentation

Unsere API-Dokumentation ist hier verfügbar und enthält vier Abschnitte mit den Namen "Get time slots" und "Reserve a time slot", "Confirm a reservation" und "Cancel a reservation", die für die Planung per API relevant sind. Bitte beachten Sie die API-Dokumentation für technische Aspekte.

3. Prozess

Die folgende Abbildung zeigt den allgemeinen Prozess der Planung per API.

Ihr Dienst kann, zum Beispiel als Teil des Checkouts, eine Anfrage für ein Zeitfenster ("Get time slot") zur Verfügbarkeit an Urbantz senden. Diese Anfrage muss bestimmte Parameter enthalten, wie in unserer API-Dokumentation angegeben. Urbantz gibt eine Liste verfügbarer Zeitfenster mit einer Reihe von Informationen zurück, darunter eine Zeitfenster-ID und -Konfiguration sowie die Eigenschaften hub, start und stop, die später für die Buchung eines Zeitfensters benötigt werden, sowie Informationen zur bereits genutzten Kapazität.

Die Buchung eines Zeitfensters ("Reserve a time slot") ist der nächste Schritt. In dieser Phase wird Kapazität reserviert, aber es wird kein Auftrag erstellt. Urbantz gibt unter anderem eine "Buchungs-ID" (timeslotReservationId) zurück, die dem gewählten Zeitfenster entspricht und für die Initiierung der Auftragserstellung verwendet werden muss.

ℹ️ Buchungen werden in Urbantz nicht angezeigt; Informationen sind nur über API-Anfragen verfügbar.

Sobald Ihr Kunde den Kauf auf Ihrer Website abgeschlossen hat, können Sie mit einer regulären Auftragsankündigung ("Confirm a reservation") fortfahren, wobei die "Buchungs-ID" eine zusätzliche Information ist, die angegeben werden muss. Die Buchung wird in einen tatsächlichen Auftrag umgewandelt, und die üblichen Methoden zur Änderung von Auftragseigenschaften gelten ab diesem Zeitpunkt (Verwerfen, Aktualisieren...).

❗️ Wenn der Kaufprozess von Ihrem Kunden abgebrochen wird, müssen Zeitfenster aktiv freigegeben werden ("Cancel a reservation") unter Verwendung der Buchungs-ID, andernfalls wird die Kapazität blockiert. Es gibt keinen automatischen Freigabeprozess.

ℹ️ Falls gewünscht, kann eine Reservierung erzwungen werden, um ein Zeitfenster zu überlasten – zum Beispiel, wenn mehrere Kunden versuchen, dasselbe Zeitfenster zu reservieren, aber nur Kapazität für einen vorhanden ist. Dieser Parameter ist standardmäßig false; ändern Sie ihn auf true, wenn Sie betrieblich gesehen die Kapazität haben, Zeitfenster zu überlasten.

Siehe auch unsere API-Dokumentation zur Zeitfenster-Buchung hier Artikel.