Skip to content

API · notification ​

Trang sinh tự động

Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.

3 query · 1 mutation.

Query ​

myNotifications ​

The caller's own notifications, newest first. notification.read (own).

query · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
unreadOnlyBoolean
pageInt
pageSizeInt

Trả về NotificationPage!

FieldKiểuMô tả
items[Notification!]!
pageInt!
pageSizeInt!
totalInt!

notificationEvent ​

One ledger entry by id; not_found when there is none. Requires notification_event.read.

query · quyền: notification_event.read

Tham sốKiểuMặc địnhMô tả
idID!

Trả về NotificationEvent!

FieldKiểuMô tả
idID!The ledger entry (the record id used by notificationEvent).
stateNotificationState!
skipReasonNotificationSkipReason
kindNotificationKind
recipientNotificationRecipient
orderIdID
orderCodeString#298 business order code of orderId (temporary format, NEW-SL-12); null without an order.
campaignIdID
notificationIdIDThe recipient's own notification row (their inbox id), when one was created.
sourceEventIdID!
sourceEventTypeString!Domain event type that triggered it, for example order.locked.
correlationIdString!
recordedAtDateTime!When the consumer recorded the event: the basis of the time window.
createdAtDateTime
readAtDateTime

notificationEvents ​

The in-app notification ledger, newest first. Filters: recipient app, kind, state and a half-open [from, to) window on recordedAt. kind and recipientApp match created notifications only (a skipped entry has neither). Requires notification_event.read (NTF-03, Admin).

query · quyền: notification_event.read

Tham sốKiểuMặc địnhMô tả
recipientAppAppCode
kindNotificationKind
stateNotificationState
fromDateTime
toDateTime
pageInt
pageSizeInt

Trả về NotificationEventPage!

FieldKiểuMô tả
items[NotificationEvent!]!
pageInt!
pageSizeInt!
totalInt!Entries matching the filters, not only this page.

Mutation ​

markNotificationRead ​

Mark one of the caller's notifications read. Idempotent: the first read time is kept. Another account's id is not_found. notification.mark_read.

mutation · SDL không ghi quyền

Tham sốKiểuMặc địnhMô tả
inputMarkNotificationReadInput!

Trả về MarkNotificationReadResult!

FieldKiểuMô tả
aggregateIdID!
versionInt!
statusCommandStatus!
requestIdID!
correlationIdID!
nextActionNextAction
notificationNotification!

Sinh từ ad83b0aea · 820 migration · PostgreSQL 17