Inkomende orders ontvangen via webhooks, downloaden via de SalesOrder API en verwerken.
Wanneer een klant een inkooporder naar jouw organisatie stuurt via Peppol, ontvang je deze als sales order in de PSB. Via een webhook word je direct op de hoogte gebracht, waarna je de order kunt downloaden en verwerken.
Registreer een webhook voor het topic OrderReceived zodat de PSB je notificeert zodra er een order binnenkomt:
{
"action": "https://jouw-endpoint.nl/orders",
"topics": ["OrderReceived"],
"secret": "jouw-geheime-sleutel"
}
De webhook-payload bevat onder andere het documentId en de senderPartyId, zodat je weet welke order van welke afzender is binnengekomen.
Gebruik het documentId uit de webhook-payload om de order op te halen:
GET /api/v1/{partyId}/salesOrder/{documentId}/download
De response bevat het UBL Order XML-document. Standaard ontvang je het document in het formaat waarin het is verzonden. Wil je het in een ander formaat? Gebruik dan de targetDocumentTypeId queryparameter om het document automatisch te laten transformeren naar het gewenste formaat.
Let op: Ontvangen documenten worden 90 dagen bewaard in de PSB. Nadat je het document hebt gedownload, blijft het nog 7 dagen beschikbaar. Download orders daarom tijdig en sla ze op in je eigen systeem.
Na het downloaden verwerk je de order in je eigen systeem. Bij het Advanced Ordering-profiel wordt van je verwacht dat je een Order Response terugstuurt naar de koper. De mogelijke statussen zijn:
Stuur de response via het Order Response endpoint.
Naast OrderReceived zijn er meer topics die relevant zijn als je orders ontvangt:
OrderReceivedOrderChangeReceivedOrderCancellationReceivedWil je een ontvangen order handmatig verwijderen uit de PSB? Dat kan via:
DELETE /api/v1/{partyId}/salesOrder/{documentId}
Registreer een webhook op het topic OrderReceived. De payload bevat onder andere documentId en senderPartyId. Met dat documentId roep je GET /api/v1/{partyId}/salesOrder/{documentId}/download aan om het UBL Order XML op te halen en in je eigen systeem te verwerken.
Bij het Advanced Ordering-profiel verwacht de koper dat je als leverancier reageert met een Order Response. Je gebruikt de codes AB (ontvangen en leesbaar), AP (geaccepteerd), CA (voorwaardelijk geaccepteerd) of RE (afgewezen). Zonder die response is het proces volgens het profiel niet afgerond.
Ontvangen documenten worden 90 dagen bewaard in de PSB. Na download blijft het document nog 7 dagen beschikbaar. Sla orders daarom tijdig op in je eigen omgeving en plan je integratie daarop in.
Bekijk de volledige API-specificatie op psb.econnect.eu voor alle parameters en response-structuren.
Open de API-referentie