Listar eventos de sincronización
Lista lo que cambió desde tu última llamada, del más antiguo al más reciente.
GET/v1/workspaces/{regionId}/sync/events
Parámetros
afterstringEl nextCursor de tu última llamada (un id de evento). Omítelo para empezar por el evento más antiguo.
limitinteger1-500 eventos por llamada. Por defecto, 100.
Devuelve
200 OK con el objeto que se muestra en la respuesta.
Más detalles
Qué cambió en este lado del espacio de trabajo, del más antiguo al más reciente. Un evento nombra un documento, nunca su contenido: lee el documento con la operación correspondiente, así siempre obtienes su versión actual. Devuelve nextCursor como after en tu siguiente llamada; mientras hasMore sea true, vuelve a llamar de inmediato. Los eventos se conservan 30 días y se entregan al menos una vez, así que el mismo cambio puede llegar dos veces; los 5 segundos más recientes esperan a la siguiente llamada. Un llamador proveedor recibe purchase_order.issued, changed, canceled y rejected; invoice.received, approved, rejected, paid, payment_withdrawn, remittance_sent y credit_applied; invoice.updated (un comprador puso la factura en espera para revisarla, o la liberó: lee GetInvoiceStatus); y credit_note.accepted y rejected. Un llamador comprador recibe invoice.received y credit_note.received (un proveedor envió uno); invoice.updated (una factura se aprobó, por una persona o automáticamente, o se rechazó, o su proveedor confirmó los datos bancarios o la reportó); invoice.payment (se registró o retiró un pago, un crédito saldó la factura, o un pago a través de Pleaxy se completó o falló: consulta GetInvoiceRemittance); purchase_order.updated (una orden se aprobó, se rechazó o se canceló); y purchase_order.confirmed y purchase_order.shipped (consulta GetPurchaseOrderFulfillment). Solo recibe los tipos de documento que su rol de compras puede ver.
Campos de la respuesta
events[].typestringQué pasó, como <document>.<change>, p. ej. invoice.paid.
events[].buyerWorkspaceIdstringLlamadores proveedores: el ID del espacio de trabajo del comprador, para pasarlo como ?buyer= al leer el documento.
nextCursorstringDónde empieza tu siguiente llamada. Ausente solo antes del primer evento.
hasMorebooleanHay más eventos esperando: vuelve a llamar de inmediato.
Errores
- 400 Bad Request - after no es un id de evento, o limit está fuera de rango.
- 401 Unauthorized - No se presentó ninguna credencial, o el token Bearer o el valor de X-Api-Key falta, no es válido, caducó o fue revocado.
- 403 Forbidden - El token Bearer o la clave de API del llamador no da acceso a este espacio de trabajo (regionId), o no tiene el rol requerido.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/reg_01k5x8p9j3q7vn2mhb4tzc6rde.supplier/sync/events?after=EV-mgx2k9a1-0c4f81d2" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"events": [
{ "id": "EV-mgx2kb7e-91a2c3d4", "at": "2026-10-23T10:02:11.402Z", "type": "invoice.paid", "documentType": "invoice", "documentId": "INV-3C9E71B2", "buyerWorkspaceId": "reg_01k5x8n2a7c4bq9wze0tkv3fjm.buyer" }
],
"nextCursor": "EV-mgx2kb7e-91a2c3d4",
"hasMore": false
}