Mutations / Notifications — Shopfront Developer Documentation

Mutation

createNotification — Returns Notification

No scope required

This is currently an experimental mutation, please get in contact with us before using it.

Arguments	Type	Description
notifiable	NotifiableInput!
image	String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
title	String!	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
message	String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
action	NotificationActionTypeEnum
address	String	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example Mutation

mutation CreateNotification {
    createNotification {
        id,
        data,
        readAt,
        createdAt,
        updatedAt
    }
}

Mutation

deleteAllNotifications — Returns boolean

No scope required

Delete all the read notifications

Arguments	Type	Description
register	ID	The register to delete the notifications from
outlet	ID	The outlet to delete the notifications from

Example Mutation

mutation DeleteAllNotifications($register: ID) {
    deleteAllNotifications(register: $register)
}

# Example variables
{
    "register": "<REGISTER>"
}

Mutation

deleteNotification — Returns boolean

No scope required

Delete a notification

Arguments	Type	Description
id	String!	The id of the notification to delete

Example Mutation

mutation DeleteNotification($id: String!) {
    deleteNotification(id: $id)
}

# Example variables
{
    "id": "<ID>"
}

Mutation

readAllNotifications — Returns boolean

No scope required

Mark all notification as read

Arguments	Type	Description
register	ID	The register for which to mark the notifications as read
outlet	ID	The outlet for which to mark the notifications as read

Example Mutation

mutation ReadAllNotifications($register: ID) {
    readAllNotifications(register: $register)
}

# Example variables
{
    "register": "<REGISTER>"
}

Mutation

readNotification — Returns boolean

No scope required

Mark a notification as read

Arguments	Type	Description
id	String!	The id of the notification to mark as read

Example Mutation

mutation ReadNotification($id: String!) {
    readNotification(id: $id)
}

# Example variables
{
    "id": "<ID>"
}