Listar notificaciones
Lista tus notificaciones más recientes.
GET/v1/workspaces/{regionId}/notifications
Parámetros
audience"buyer" | "supplier"ObligatorioDe qué lado se devuelve el feed de notificaciones.
Devuelve
200 OK con el objeto que se muestra en la respuesta.
Más detalles
Lista hasta las 50 notificaciones más recientes para el público indicado, de la más reciente a la más antigua. Las notificaciones se conservan 90 días. Usa ListNotificationsPage para recorrer las más antiguas.
Campos de la respuesta
title, bodystringEn inglés, tal como se escribió al crear la notificación. Slack, Teams y el correo muestran el mismo texto.
titleMessageId, titleParams, bodyMessageId, bodyParamsstring, objectEl mensaje a partir del cual se construyó cada texto y los valores con los que se completó, para que una aplicación pueda mostrarlo en el idioma de su lector. Ausente en notificaciones creadas antes de que existieran; muestra entonces title y body.
resolutionobjectSolo en una solicitud de aprobación (po_approval_requested, invoice_approval_requested) o un aviso de falta de aprobador (po_needs_approver, invoice_needs_approver) que ya no necesita a su lector; se calcula al listar y nunca se guarda: outcome you_approved o you_rejected (con at) cuando el lector decidió el paso y, si no, no_longer_needed (otra persona decidió, el paso se reasignó o el documento salió de aprobación). Ausente mientras aún lo necesite.
Errores
- 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/{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" }
}
]