Eingehende Bestellungen über Webhooks empfangen, über die SalesOrder API herunterladen und verarbeiten.
Wenn ein Kunde eine Bestellung an Ihre Organisation über Peppol sendet, empfangen Sie diese als Kundenauftrag im PSB. Ein Webhook benachrichtigt Sie sofort, danach können Sie die Bestellung herunterladen und verarbeiten.
Registrieren Sie einen Webhook für das Topic OrderReceived, damit der PSB Sie benachrichtigt, sobald eine Bestellung eingeht:
{
"action": "https://Ihr-endpoint.de/orders",
"topics": ["OrderReceived"],
"secret": "Ihr-geheimer-schluessel"
}
Der Webhook-Payload enthält unter anderem die documentId und die senderPartyId, sodass Sie wissen, welche Bestellung von welchem Absender eingegangen ist.
Verwenden Sie die DocumentId aus dem Webhook-Payload, um die Bestellung abzurufen:
GET /api/v1/{partyId}/salesOrder/{documentId}/download
Die Antwort enthält das UBL Order XML-Dokument. Standardmäßig erhalten Sie das Dokument im Format, in dem es gesendet wurde. Möchten Sie es in einem anderen Format? Verwenden Sie den Queryparameter targetDocumentTypeId, um das Dokument automatisch in das gewünschte Format transformieren zu lassen.
Wichtig: Empfangene Dokumente werden 90 Tage im PSB gespeichert. Nachdem Sie das Dokument heruntergeladen haben, bleibt es noch 7 Tage verfügbar. Laden Sie Bestellungen rechtzeitig herunter und speichern Sie sie in Ihrem eigenen System.
Nach dem Herunterladen verarbeiten Sie die Bestellung in Ihrem eigenen System. Beim Advanced Ordering-Profil wird erwartet, dass Sie eine Order Response an den Käufer zurücksenden. Die möglichen Status sind:
Senden Sie die Antwort über den Order Response Endpoint.
Neben OrderReceived gibt es weitere Topics, die beim Empfang von Bestellungen relevant sind:
OrderReceivedOrderChangeReceivedOrderCancellationReceivedMöchten Sie eine empfangene Bestellung manuell aus dem PSB löschen? Das geht über:
DELETE /api/v1/{partyId}/salesOrder/{documentId}
Registrieren Sie einen Webhook auf das Topic OrderReceived. Die Payload enthält unter anderem documentId und senderPartyId. Mit dieser documentId rufen Sie GET /api/v1/{partyId}/salesOrder/{documentId}/download auf, um das UBL Order XML abzurufen und in Ihrem eigenen System zu verarbeiten.
Beim Advanced Ordering-Profil erwartet der Käufer, dass Sie als Lieferant mit einer Order Response antworten. Sie verwenden die Codes AB (empfangen und lesbar), AP (akzeptiert), CA (bedingt akzeptiert) oder RE (abgelehnt). Ohne diese Response ist der Prozess laut Profil nicht abgeschlossen.
Empfangene Dokumente werden 90 Tage in der PSB aufbewahrt. Nach dem Download bleibt das Dokument noch 7 Tage verfügbar. Speichern Sie Bestellungen daher zeitnah in Ihrer eigenen Umgebung und planen Sie Ihre Integration entsprechend.
Die vollständige API-Spezifikation finden Sie unter psb.econnect.eu mit allen Parametern und Response-Strukturen.
API-Referenz öffnen