Comment
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.
Anchor to FieldsFields
- Anchor to actionaction•String!non-null
The action that occured.
- Anchor to appTitleapp•String
Title The name of the app that created the event.
- Anchor to attachmentsattachments•[Comment
Event Attachment!]!non-null The attachments associated with the comment event.
- Anchor to attributeToAppattribute•Boolean!non-null
To App Whether the event was created by an app.
- Anchor to attributeToUserattribute•Boolean!non-null
To User Whether the event was caused by an admin user.
- •Staff
Member!non-null The name of the user that authored the comment event.
- Anchor to canDeletecan•Boolean!non-null
Delete Whether the comment event can be deleted. If true, then the comment event can be deleted.
- Anchor to canEditcan•Boolean!non-null
Edit Whether the comment event can be edited. If true, then the comment event can be edited.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the event was created.
- Anchor to criticalAlertcritical•Boolean!non-null
Alert Whether the event is critical.
- Anchor to editededited•Boolean!non-null
Whether the comment event has been edited. If true, then the comment event has been edited.
- Anchor to embedembed•Comment
Event Embed The object reference associated with the comment event. For example, a product or discount).
- •ID!non-null
A globally-unique ID.
- Anchor to messagemessage•Formatted
String!non-null Human readable text that describes the event.
- Anchor to rawMessageraw•String!non-null
Message The raw body of the comment event.
- Anchor to subjectsubject•Comment
Event Subject The parent subject to which the comment event belongs.