Skip to main content
Anchor to CommentEvent

CommentEvent

object

A comment that staff members add to the timeline of Order, DraftOrder, Customer, InventoryTransfer, Company, CompanyLocation, or PriceRule objects. Staff use comments to document internal notes, communicate with team members, and track important information about these types.

The comment includes information like the StaffMember who authored it, when it was created, and whether it's editable or deletable. Comments can have file attachments and reference related objects like Product or ProductVariant objects through embeds.

Anchor to FieldsFields

Anchor to actionaction
•String!
non-null

The action that occured.

Anchor to appTitleappTitle
•String

The name of the app that created the event.

Anchor to attachmentsattachments
•[CommentEventAttachment!]!
non-null

The attachments associated with the comment event.

Anchor to attributeToAppattributeToApp
•Boolean!
non-null

Whether the event was created by an app.

Anchor to attributeToUserattributeToUser
•Boolean!
non-null

Whether the event was caused by an admin user.

Anchor to authorauthor
•StaffMember!
non-null

The name of the user that authored the comment event.

Anchor to canDeletecanDelete
•Boolean!
non-null

Whether the comment event can be deleted. If true, then the comment event can be deleted.

Anchor to canEditcanEdit
•Boolean!
non-null

Whether the comment event can be edited. If true, then the comment event can be edited.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the event was created.

Anchor to criticalAlertcriticalAlert
•Boolean!
non-null

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
•CommentEventEmbed

The object reference associated with the comment event. For example, a product or discount).

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to messagemessage
•FormattedString!
non-null

Human readable text that describes the event.

Anchor to rawMessagerawMessage
•String!
non-null

The raw body of the comment event.

Anchor to subjectsubject
•CommentEventSubject

The parent subject to which the comment event belongs.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?