/ docs
ProduktZnalostiVývojáři
Platforma Control
Stornování objednávky (Order Cancellation)

Stornování existující objednávky přes API: endpoint, flow a reakce dodavatele.

Objednávku, která již byla odeslána, může kupující stornovat pomocí Order Cancellation. Dodavatel přijme stornování a může ho akceptovat nebo zamítnout. Order Cancellations jsou součástí profilu Peppol Advanced Ordering.

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

{partyId} je Peppol identifikátor kupujícího. {documentId} je ID původní objednávky, kterou chcete stornovat. Toto je ID dokumentu, které jste obdrželi při odeslání objednávky.

Pozor: Stornování je žádost, ne garance. Dodavatel může stornování zamítnout, například pokud je objednávka již ve výrobě. Až po přijetí Order Response se stavovým kódem AP (akceptováno) je stornování definitivní.

Flow
  1. Kupující odešle žádost o stornování přes cancel endpoint
  2. Dodavatel přijme stornování přes webhook OrderCancellationReceived
  3. Dodavatel posoudí, zda je možné stornování provést
  4. Dodavatel odešle Order Response: AP (akceptováno) nebo RE (zamítnuto)
  5. Kupující obdrží response přes webhook OrderResponseReceived
Přijetí jako dodavatel

Nastavte webhook na topic OrderCancellationReceived:

{
  "action": "https://jouw-endpoint.nl/order-cancellations",
  "topics": ["OrderCancellationReceived"],
  "secret": "jouw-geheime-sleutel"
}

Stáhněte dokument stornování pro zobrazení důvodu stornování:

GET /api/v1/{partyId}/salesOrder/{documentId}/download
Webhook topics
TopicSměrKdyOrderCancellationSentKupujícíStornování bylo úspěšně doručenoOrderCancellationReceivedDodavatelStornování bylo přijatoOrderResponseReceivedKupujícíDodavatel reagoval na stornováníOrderResponseSentDodavatelResponse na stornování byl odeslán
Reagování na stornování

Jako dodavatel reagujete na stornování přes Order Response endpoint. Relevantní stavové kódy jsou:

KódVýznamAPStornování akceptováno, objednávka se nebude provádětREStornování zamítnuto, objednávka zůstává aktivní
Často kladené otázky
Jaké `documentId` použiji v cancel endpointu?

Použijte ID dokumentu původní objednávky, které jste obdrželi od PSB při odesílání (POST .../purchaseOrder/send). Cesta je POST /api/v1/{partyId}/purchaseOrder/{documentId}/cancel, kde {partyId} je Peppol identifikátor kupujícího.

Je zrušení okamžitě definitivní, když je požadavek úspěšný?

Ne. Zrušení je požadavek. Dodavatel ho může odmítnout, například pokud je objednávka již v realizaci. Teprve když obdržíte Order Response s kódem AP, je zrušení podle toku akceptováno.

Jak zapadá Order Cancellation do profilu Advanced Ordering?

Order Cancellation patří k Advanced Ordering: dodavatel obdrží OrderCancellationReceived, může si stáhnout dokument o zrušení a odpoví přes Order Response s AP (akceptováno) nebo RE (zamítnuto). Kupující sleduje výsledek mimo jiné přes OrderResponseReceived.

Podívejte se na kompletní API specifikaci na psb.econnect.eu pro přesnou strukturu požadavků a odpovědí.

Vyzkoušejte to v API

PreviousZměna objednávky
NextOrder Response