CommentEvent

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.

Show definition

# 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.

type CommentEvent implements Event, Node { # The name of the app that created the event. Returns null when the event originates from the Shopify admin. appTitle: String

# Whether the event was created by an app. attributeToApp: Boolean!

# Whether the event was caused by an admin user. attributeToUser: Boolean!

# The date and time when the event was created. createdAt: DateTime!

# Whether the event is critical. criticalAlert: Boolean!

# Globally unique identifier. id: ID!

# Human readable text that describes the event. message: FormattedString!

# The attachments associated with the comment event. attachments: [CommentEventAttachment!]!

# Whether the comment event can be deleted. If true, then the comment event can be deleted. canDelete: Boolean!

# Whether the comment event can be edited. If true, then the comment event can be edited. canEdit: Boolean!

# Whether the comment event has been edited. If true, then the comment event has been edited. edited: Boolean!

# The raw body of the comment event. rawMessage: String!

# The subject of the comment event. subject: CommentEventSubject! }

Implements

Fields

appTitle   (String)

The name of the app that created the event. Returns null when the event originates from the Shopify admin.

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.

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.

id   (ID!)

Globally unique identifier.

message   (FormattedString!)

Human readable text that describes the event.

rawMessage   (String!)

The raw body of the comment event.

subject   (CommentEventSubject!)

The subject of the comment event.

Sign up for a Partner account to get started.

Sign up