Listar notificações
Lista as suas notificações mais recentes.
GET/v1/workspaces/{regionId}/notifications
Parâmetros
audience"buyer" | "supplier"ObrigatórioDe qual lado retornar o feed de notificações.
Retorna
200 OK com o objeto mostrado na resposta.
Mais detalhes
Lista até as 50 notificações mais recentes do público indicado, da mais recente para a mais antiga. As notificações são mantidas por 90 dias. Use ListNotificationsPage para percorrer as mais antigas.
Campos da resposta
title, bodystringEm inglês, como foi escrito quando a notificação foi criada. Slack, Teams e e-mail mostram o mesmo texto.
titleMessageId, titleParams, bodyMessageId, bodyParamsstring, objectA mensagem a partir da qual cada texto foi montado e os valores com que foi preenchido, para que um aplicativo possa exibi-lo no idioma de quem lê. Ausente em notificações criadas antes de esses campos existirem; nesse caso, exiba title e body.
resolutionobjectSó em uma solicitação de aprovação (po_approval_requested, invoice_approval_requested) ou em um aviso de falta de aprovador (po_needs_approver, invoice_needs_approver) que não precisa mais de quem lê, calculado na listagem e nunca armazenado: outcome you_approved ou you_rejected (com at) quando quem lê decidiu a etapa; caso contrário, no_longer_needed (outra pessoa decidiu, a etapa foi reatribuída ou o documento saiu da aprovação). Ausente enquanto ainda precisa dessa pessoa.
Erros
- 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/{regionId}/notifications" \
-H "X-Api-Key: $PLEAXY_API_KEY"[
{
"id": "string",
"audience": "buyer" | "supplier",
"type": "report_ready" | "company_report_ready" | "po_approved" | "po_rejected" | "po_canceled" | "po_changed" | "po_approval_requested" | "request_approval_requested" | "request_approved" | "request_rejected" | "request_ordered" | "po_store_order_problem" | "po_supplier_confirmed" | "po_supplier_exception" | "po_shipped" | "po_supplier_email" | "po_changes_declined" | "po_needs_approver" | "invoice_submitted" | "invoice_ready_for_approval" | "invoice_approval_requested" | "invoice_discrepancy" | "invoice_approved" | "invoice_paid" | "invoice_payment_withdrawn" | "payments_recorded_by_key" | "accounting_sync_failed" | "invoice_remittance_sent" | "invoice_payment_failed" | "invoice_reminder" | "invoice_rejected" | "invoice_on_hold" | "invoice_hold_released" | "invoice_payment_reminder" | "invoice_entered_by_buyer" | "invoice_bank_details_to_confirm" | "invoice_bank_details_confirmed" | "invoice_bank_details_disputed" | "invoice_bank_details_changed" | "invoice_needs_approver" | "ses_approval_requested" | "ses_auto_approved" | "ses_approved" | "ses_rejected" | "receipt_return_recorded" | "po_line_due" | "po_line_due_asked" | "po_receipt_requested" | "invoice_held_due_soon" | "ses_approval_overdue" | "credit_note_received" | "credit_note_accepted" | "credit_note_rejected" | "credit_note_applied" | "invoice_comment" | "po_comment" | "contract_comment" | "invoice_feed_changed" | "supplier_connection_invited" | "supplier_connection_submitted" | "supplier_connection_approved" | "supplier_connection_rejected" | "supplier_connection_region_mismatch" | "agent_request" | "support_case_opened" | "support_case_updated" | "supplier_late_fee_terms_changed" | "contract_terms_to_acknowledge" | "contract_terms_acknowledged" | "contract_terms_disputed" | "contract_recheck_requested" | "contract_sent_to_joined_supplier" | "copilot_allowance_80" | "copilot_allowance_100" | "copilot_degraded" | "copilot_packs_low" | "copilot_packs_empty" | "copilot_payg_cap",
"title": "string",
"body": "string",
"titleMessageId": "string",
"titleParams": { },
"bodyMessageId": "string",
"bodyParams": { },
"relatedId": "string",
"createdAt": "string",
"read": boolean,
"resolution": { "outcome": "you_approved" | "you_rejected" | "no_longer_needed", "at": "string" }
}
]