Elencare le notifiche
Elenca le tue notifiche più recenti.
GET/v1/workspaces/{regionId}/notifications
Parametri
audience"buyer" | "supplier"ObbligatorioIl feed di notifiche del lato da restituire.
Restituisce
200 OK con l’oggetto mostrato nella risposta.
Più dettagli
Elenca fino alle 50 notifiche più recenti per il pubblico indicato, dalla più recente. Le notifiche vengono conservate per 90 giorni. Usa ListNotificationsPage per scorrere quelle meno recenti.
Campi della risposta
title, bodystringIn inglese, come scritto alla creazione della notifica. Slack, Teams ed email mostrano lo stesso testo.
titleMessageId, titleParams, bodyMessageId, bodyParamsstring, objectIl messaggio da cui è stato costruito ciascun testo e i valori con cui è stato compilato, così un’app può mostrarlo nella lingua del suo lettore. Assente sulle notifiche create prima della loro introduzione; in tal caso mostra title e body.
resolutionobjectSolo su una richiesta di approvazione (po_approval_requested, invoice_approval_requested) o su un avviso di approvatore mancante (po_needs_approver, invoice_needs_approver) che non richiede più l’azione del suo lettore, calcolato al momento dell’elenco e mai memorizzato: outcome you_approved o you_rejected (con at) quando il lettore ha deciso il passaggio, altrimenti no_longer_needed (qualcun altro ha deciso, il passaggio è stato riassegnato o il documento è uscito dall’approvazione). Assente finché richiede ancora la sua azione.
Errori
- 401 Unauthorized - Non è stata presentata alcuna credenziale, oppure il token Bearer o il valore di X-Api-Key è mancante, non valido, scaduto o revocato.
- 403 Forbidden - Il token Bearer o la chiave API del chiamante non dà accesso a questo workspace (regionId), oppure non ha il ruolo richiesto.
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" }
}
]