/ docs
ProduktWissenEntwickler
Plattform Control
Bestellung stornieren (Order Cancellation)

Eine bestehende Bestellung über die API stornieren: Endpoint, Ablauf und Antwort des Lieferanten.

Eine bereits versendete Bestellung kann vom Käufer über eine Order Cancellation storniert werden. Der Lieferant empfängt die Stornierung und kann diese akzeptieren oder ablehnen. Order Cancellations sind Teil des Peppol Advanced Ordering-Profils.

Endpoint
POST /api/v1/{partyId}/purchaseOrder/{documentId}/cancel

Die {partyId} ist der Peppol-Identifier des Käufers. Die {documentId} ist die ID der ursprünglichen Bestellung, die Sie stornieren möchten. Dies ist die Dokument-ID, die Sie beim Versand der Bestellung erhalten haben.

Wichtig: Eine Stornierung ist eine Anfrage, keine Garantie. Der Lieferant kann die Stornierung ablehnen, zum Beispiel wenn die Bestellung bereits in Produktion ist. Erst nach Empfang einer Order Response mit Statuscode AP (akzeptiert) ist die Stornierung endgültig.

Ablauf
  1. Käufer sendet eine Stornierungsanfrage über den Cancel-Endpoint
  2. Lieferant empfängt die Stornierung über den OrderCancellationReceived-Webhook
  3. Lieferant beurteilt, ob die Stornierung durchgeführt werden kann
  4. Lieferant sendet eine Order Response zurück: AP (akzeptiert) oder RE (abgelehnt)
  5. Käufer empfängt die Antwort über den OrderResponseReceived-Webhook
Als Lieferant empfangen

Richten Sie einen Webhook auf das Topic OrderCancellationReceived ein:

{
  "action": "https://Ihr-endpoint.de/order-cancellations",
  "topics": ["OrderCancellationReceived"],
  "secret": "Ihr-geheimer-schluessel"
}

Laden Sie das Stornierungsdokument herunter, um den Stornierungsgrund einzusehen:

GET /api/v1/{partyId}/salesOrder/{documentId}/download
Webhook-Topics
TopicRichtungWannOrderCancellationSentKäuferStornierung wurde erfolgreich zugestelltOrderCancellationReceivedLieferantStornierung wurde empfangenOrderResponseReceivedKäuferLieferant hat auf die Stornierung geantwortetOrderResponseSentLieferantAntwort auf die Stornierung wurde versendet
Auf eine Stornierung reagieren

Als Lieferant reagieren Sie auf eine Stornierung über den Order Response Endpoint. Die relevanten Statuscodes sind:

CodeBedeutungAPStornierung akzeptiert, Bestellung wird nicht ausgeführtREStornierung abgelehnt, Bestellung bleibt aktiv
Häufig gestellte Fragen
Welche `documentId` verwende ich im Cancel-Endpoint?

Verwenden Sie die Dokument-ID der ursprünglichen Bestellung, die Sie beim Senden (POST .../purchaseOrder/send) von der PSB zurückerhalten haben. Der Pfad lautet POST /api/v1/{partyId}/purchaseOrder/{documentId}/cancel, wobei {partyId} die Peppol-Kennung des Käufers ist.

Ist eine Stornierung sofort endgültig, sobald die Anfrage erfolgreich ist?

Nein. Eine Stornierung ist eine Anfrage. Der Lieferant kann sie ablehnen, beispielsweise wenn die Bestellung bereits in Bearbeitung ist. Erst wenn Sie eine Order Response mit dem Code AP erhalten, ist die Stornierung gemäß dem Flow akzeptiert.

Wie passt Order Cancellation in das Advanced Ordering-Profil?

Order Cancellation gehört zu Advanced Ordering: Der Lieferant erhält OrderCancellationReceived, kann das Stornierungsdokument herunterladen und antwortet über Order Response mit AP (akzeptiert) oder RE (abgelehnt). Der Käufer verfolgt das Ergebnis unter anderem über OrderResponseReceived.

Die vollständige API-Spezifikation finden Sie unter psb.econnect.eu mit der genauen Request- und Response-Struktur.

In der API ausprobieren

PreviousBestellung ändern
NextOrder Response