Recibir un pedido a través de la API

Recibir pedidos entrantes a través de webhooks, descargarlos vía la API SalesOrder y procesarlos.

Cuando un cliente envía una orden de compra a su organización a través de Peppol, la recibe como orden de venta en el PSB. Se le informa inmediatamente a través de un webhook, tras lo cual puede descargar y procesar el pedido.

Paso 1: configurar el webhook

Registre un webhook para el topic OrderReceived para que el PSB le notifique en cuanto llegue un pedido:

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

El payload del webhook contiene, entre otros, el documentId y el senderPartyId, permitiéndole saber qué pedido proviene de qué remitente.

Paso 2: descargar el pedido

Utilice el documentId del payload webhook para recuperar el pedido:

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

La respuesta contiene el documento XML UBL Order. Por defecto, recibe el documento en el formato en que fue enviado. ¿Lo desea en otro formato? Utilice el parámetro de consulta targetDocumentTypeId para que el documento se transforme automáticamente al formato deseado.

Atención: los documentos recibidos se conservan 90 días en el PSB. Después de la descarga, el documento permanece disponible durante 7 días. Por lo tanto, descargue los pedidos a tiempo y almacénelos en su propio sistema.

Paso 3: procesar el pedido

Después de la descarga, procesa el pedido en su propio sistema. Con el perfil Advanced Ordering, se espera que envíe una Order Response de vuelta al comprador. Los estados posibles son:

CódigoSignificadoABAcknowledged, pedido recibido y legibleAPAccepted, pedido aceptadoCAConditionally Accepted, pedido aceptado con modificacionesRERejected, pedido rechazado

Envíe la response a través del endpoint Order Response.

Topics webhook

Además de OrderReceived, hay más topics relevantes cuando recibe pedidos:

TopicCuándoOrderReceivedNuevo pedido recibidoOrderChangeReceivedEl comprador ha enviado una modificación del pedidoOrderCancellationReceivedEl comprador desea anular el pedido
Eliminar un documento

¿Desea eliminar manualmente un pedido recibido del PSB? Es posible a través de:

DELETE /api/v1/{partyId}/salesOrder/{documentId}
Preguntas frecuentes
¿Cómo vinculo un webhook a la recuperación de un pedido entrante?

Registre un webhook en el topic OrderReceived. El payload contiene, entre otros, documentId y senderPartyId. Con ese documentId, llame a GET /api/v1/{partyId}/salesOrder/{documentId}/download para recuperar el XML UBL Order y procesarlo en su propio sistema.

¿Por qué debo enviar una Order Response con Advanced Ordering?

Con el perfil Advanced Ordering, el comprador espera que usted como proveedor responda con una Order Response. Se utilizan los códigos AB (recibido y legible), AP (aceptado), CA (aceptado condicionalmente) o RE (rechazado). Sin esa respuesta, el proceso no se considera completado según el perfil.

¿Cuánto tiempo permanecen disponibles los pedidos recibidos en el PSB?

Los documentos recibidos se conservan en el PSB durante 90 días. Tras la descarga, el documento permanece disponible durante 7 días adicionales. Por lo tanto, almacene los pedidos en su propio entorno oportunamente y planifique su integración en consecuencia.


Consulte la especificación API completa en psb.econnect.eu para todos los parámetros y estructuras de respuesta.

Abrir la referencia API