Order Response verzenden via de API

Wanneer je als leverancier een order, wijziging of annulering ontvangt, stuur je een Order Response terug om de koper te laten weten wat je met de order doet. De Order Response is een kernonderdeel van het Peppol Advanced Ordering-profiel.

Endpoint

POST /api/v1/{partyId}/salesOrder/{documentId}/response

De {partyId} is de Peppol-identifier van de leverancier. Het {documentId} is de ID van de ontvangen order waarop je reageert.

Statuscodes

De Order Response bevat een statuscode die aangeeft wat je met de order doet:

Code

Naam

Wanneer gebruiken

Acknowledged

Je hebt de order ontvangen en deze is leesbaar. Gebruik dit als tussentijdse bevestiging terwijl je de order nog beoordeelt.

Accepted

Je accepteert de order volledig en gaat deze uitvoeren.

Conditionally Accepted

Je accepteert de order, maar met wijzigingen (bijvoorbeeld aangepaste levertijd of hoeveelheden). Voeg de aangepaste orderregels toe aan de response.

Rejected

Je wijst de order af. De koper moet een nieuwe order indienen als de bestelling alsnog door moet gaan.

Tip: Je kunt meerdere responses sturen voor dezelfde order. Begin bijvoorbeeld met AB (bevestiging van ontvangst) en stuur later AP (geaccepteerd) zodra de order intern is goedgekeurd.

Voorbeeldflow

Een typisch Advanced Ordering-scenario ziet er zo uit:

Koper stuurt een order via POST /{partyId}/purchaseOrder/send
Leverancier ontvangt de order via OrderReceived-webhook
Leverancier downloadt de order via GET /{partyId}/salesOrder/{documentId}/download
Leverancier stuurt AB-response (ontvangstbevestiging)
Leverancier beoordeelt de order intern
Leverancier stuurt AP-response (order geaccepteerd)
Koper ontvangt de response via OrderResponseReceived-webhook

Conditioneel accepteren (CA)

Bij een CA-response (Conditionally Accepted) geef je aan dat je de order accepteert, maar met aanpassingen. De response bevat dan een gewijzigde versie van de orderregels. De koper kan op basis daarvan beslissen of de aangepaste order acceptabel is.

Mogelijke redenen voor een CA-response zijn onder meer een aangepaste levertijd, een gewijzigde hoeveelheid (beperkte voorraad) of vervangende artikelen.

Webhooktopics

Topic

Richting

Wanneer

OrderResponseSent

Leverancier

Response is succesvol verzonden naar de koper

OrderResponseReceived

Koper

Response van de leverancier is ontvangen

Request-body

De response wordt als UBL OrderResponse XML-document meegestuurd in de body van het request, met content-type application/xml. Het document moet de juiste verwijzing naar de oorspronkelijke order bevatten.

Raadpleeg de Swagger-documentatie op psb.econnect.eu voor de exacte XML-structuur en verplichte velden.

Veelgestelde vragen

Wanneer gebruik ik AB, AP, CA of RE in een Order Response?

AB betekent dat de order is ontvangen en leesbaar, vaak als tussenstap. AP is volledige acceptatie en uitvoering. CA is acceptatie met wijzigingen; je voegt de aangepaste orderregels toe. RE wijst de order af; de koper moet dan een nieuwe order indienen als de bestelling door moet gaan.

Mag ik meerdere Order Responses voor dezelfde order sturen?

Ja. Je kunt bijvoorbeeld eerst AB sturen zodra je de order hebt ingelezen en later AP wanneer interne goedkeuring rond is. Dat past bij een typische Advanced Ordering-keten met webhook OrderResponseReceived aan de kant van de koper.

Hoe roep ik het Order Response-endpoint technisch aan?

Gebruik POST /api/v1/{partyId}/salesOrder/{documentId}/response met {partyId} als Peppol-identifier van de leverancier en {documentId} als ID van de ontvangen order. De body is een UBL OrderResponse XML met Content-Type: application/xml en de juiste verwijzing naar de oorspronkelijke order.

Bekijk de volledige API-specificatie op psb.econnect.eu voor voorbeeldpayloads en foutmeldingen.

Open de API-referentie

Gerelateerd