Ricevere un ordine tramite l'API

Ricevere ordini in arrivo tramite webhook, scaricare tramite la SalesOrder API ed elaborare.

Quando un cliente invia un ordine d'acquisto alla Sua organizzazione tramite Peppol, lo riceve come ordine di vendita nella PSB. Tramite un webhook viene immediatamente informato, dopodiché può scaricare e elaborare l'ordine.

Passo 1: configurare il webhook

Registri un webhook per il topic OrderReceived affinché la PSB La notifichi non appena arriva un ordine:

{
  "action": "https://jouw-endpoint.nl/orders",
  "topics": ["OrderReceived"],
  "secret": "jouw-geheime-sleutel"
}

Il payload del webhook contiene, tra l'altro, il documentId e il senderPartyId, in modo da sapere quale ordine è arrivato e da quale mittente.

Passo 2: scaricare l'ordine

Utilizzi il documentId dal payload del webhook per recuperare l'ordine:

GET /api/v1/{partyId}/salesOrder/{documentId}/download

La risposta contiene il documento UBL Order XML. Per impostazione predefinita riceve il documento nel formato in cui è stato inviato. Lo desidera in un altro formato? Utilizzi il parametro query targetDocumentTypeId per far trasformare automaticamente il documento nel formato desiderato.

Attenzione: i documenti ricevuti vengono conservati nella PSB per 90 giorni. Dopo aver scaricato il documento, rimane disponibile per altri 7 giorni. Scarichi quindi gli ordini tempestivamente e li salvi nel Suo sistema.

Passo 3: elaborare l'ordine

Dopo il download elabora l'ordine nel Suo sistema. Con il profilo Advanced Ordering ci si aspetta che invii un Order Response all'acquirente. Gli stati possibili sono:

CodiceSignificatoABAcknowledged, l'ordine è stato ricevuto ed è leggibileAPAccepted, l'ordine è stato accettatoCAConditionally Accepted, l'ordine è stato accettato con modificheRERejected, l'ordine è stato rifiutato

Invii la risposta tramite l'endpoint Order Response.

Topic webhook

Oltre a OrderReceived ci sono altri topic rilevanti quando si ricevono ordini:

TopicQuandoOrderReceivedNuovo ordine ricevutoOrderChangeReceivedL'acquirente ha inviato una modifica all'ordineOrderCancellationReceivedL'acquirente vuole annullare l'ordine
Eliminare il documento

Desidera eliminare manualmente un ordine ricevuto dalla PSB? È possibile tramite:

DELETE /api/v1/{partyId}/salesOrder/{documentId}
Domande frequenti
Come collego un webhook al recupero di un ordine in arrivo?

Registri un webhook sul topic OrderReceived. Il payload contiene, tra l'altro, documentId e senderPartyId. Con quel documentId, chiami GET /api/v1/{partyId}/salesOrder/{documentId}/download per recuperare l'XML UBL Order ed elaborarlo nel proprio sistema.

Perché devo inviare una Order Response con Advanced Ordering?

Con il profilo Advanced Ordering, l'acquirente si aspetta che Lei come fornitore risponda con una Order Response. Si utilizzano i codici AB (ricevuto e leggibile), AP (accettato), CA (accettato condizionalmente) o RE (rifiutato). Senza tale risposta, il processo non è considerato completato secondo il profilo.

Per quanto tempo restano disponibili gli ordini ricevuti nella PSB?

I documenti ricevuti vengono conservati nella PSB per 90 giorni. Dopo il download, il documento resta disponibile per altri 7 giorni. Conservi quindi gli ordini nel proprio ambiente tempestivamente e pianifichi la sua integrazione di conseguenza.


Consulti la specifica API completa su psb.econnect.eu per tutti i parametri e le strutture di risposta.

Apra il riferimento API