API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

CommentEvent object

Version unstable

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2021-07 (Release candidate)

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2021-04 (Latest)

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2021-01

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2020-10

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2020-07

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2020-04

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2020-01 (Unsupported)

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2019-10 (Unsupported)

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2019-07 (Unsupported)

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Version 2019-04 (Unsupported)

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.

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.

  • embed (CommentEventEmbed)

    The references associated with the comment event.

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

Implements

Samples