CommentEvent - admin-graphql - OBJECT

Version: 2024-10

Description:

Comment events are generated by staff members of a shop. They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.

Access Scopes

Fields

• action: String! - The action that occured.
• appTitle: String - The name of the app that created the event.
• attachments: CommentEventAttachment! - The attachments associated with the comment event.
• attributeToApp: Boolean! - Whether the event was created by an app.
• attributeToUser: Boolean! - Whether the event was caused by an admin user.
• author: StaffMember! - The name of the user that authored the comment event.
• canDelete: Boolean! - Whether the comment event can be deleted. If true, then the comment event can be deleted.
• canEdit: Boolean! - Whether the comment event can be edited. If true, then the comment event can be edited.
• createdAt: DateTime! - The date and time when the event was created.
• criticalAlert: Boolean! - Whether the event is critical.
• edited: Boolean! - Whether the comment event has been edited. If true, then the comment event has been edited.
• embed: CommentEventEmbed - The object reference associated with the comment event. For example, a product or discount).
• id: ID! - A globally-unique ID.
• message: FormattedString! - Human readable text that describes the event.
• rawMessage: String! - The raw body of the comment event.
• subject: CommentEventSubject - The parent subject to which the comment event belongs.

Connections

Related queries

Related mutations

Related Unions

Examples