Listar eventos de sincronização
Lista o que mudou desde a sua última chamada, do mais antigo para o mais recente.
GET/v1/workspaces/{regionId}/sync/events
Parâmetros
afterstringO nextCursor da sua última chamada (um id de evento). Omita para começar do evento mais antigo.
limitintegerDe 1-500 eventos por chamada. O padrão é 100.
Retorna
200 OK com o objeto mostrado na resposta.
Mais detalhes
O que mudou neste lado do espaço de trabalho, do mais antigo para o mais recente. Um evento indica um documento, nunca o conteúdo dele: leia o documento com a operação correspondente, para sempre receber a versão atual. Devolva nextCursor como after na próxima chamada; enquanto hasMore for true, chame de novo imediatamente. Os eventos ficam guardados por 30 dias e são entregues pelo menos uma vez, então a mesma mudança pode chegar duas vezes; os 5 segundos mais recentes aguardam a próxima chamada. Quem chama como Fornecedor recebe purchase_order.issued, changed, canceled e rejected, invoice.received, approved, rejected, paid, payment_withdrawn, remittance_sent e credit_applied, invoice.updated (um comprador colocou a fatura em espera para revisão, ou a liberou: leia GetInvoiceStatus), e credit_note.accepted e rejected. Quem chama como Comprador recebe invoice.received e credit_note.received (um fornecedor enviou um documento); invoice.updated (uma fatura foi aprovada, por uma pessoa ou automaticamente, ou rejeitada, ou o fornecedor dela confirmou ou denunciou os dados bancários); invoice.payment (um pagamento foi registrado ou retirado, um crédito quitou a fatura, ou um pagamento pela Pleaxy foi concluído ou falhou: leia GetInvoiceRemittance); purchase_order.updated (um pedido foi aprovado, rejeitado ou cancelado); e purchase_order.confirmed e purchase_order.shipped (leia GetPurchaseOrderFulfillment). Recebe só os tipos de documento que a sua função de compras pode ver.
Campos da resposta
events[].typestringO que aconteceu, como <document>.<change>, por exemplo invoice.paid.
events[].buyerWorkspaceIdstringQuem chama como Fornecedor: o ID do espaço de trabalho do comprador, para passar como ?buyer= ao ler o documento.
nextCursorstringOnde a sua próxima chamada começa. Ausente só antes do primeiro evento.
hasMorebooleanHá mais eventos aguardando: chame de novo imediatamente.
Erros
- 400 Bad Request - after não é um id de evento, ou limit está fora do intervalo.
- 401 Unauthorized - Nenhuma credencial foi apresentada, ou o token Bearer / valor de X-Api-Key está ausente, é inválido, expirou ou foi revogado.
- 403 Forbidden - O token Bearer ou a chave de API de quem chama não dá acesso a este espaço de trabalho (regionId), ou não tem a função exigida.
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
}