Choose a version:

Event

interface

Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product.

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 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 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 idid •ID! non-null: A globally-unique ID.
Anchor to messagemessage •FormattedString! non-null: Human readable text that describes the event.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

BasicEvent

•OBJECT

Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the addition of a product.

General events

Action	Description
`create`	The item was created.
`destroy`	The item was destroyed.
`published`	The item was published.
`unpublished`	The item was unpublished.
`update`	The item was updated.

Order events

Order events can be divided into the following categories:

Authorization: Includes whether the authorization succeeded, failed, or is pending.
Capture: Includes whether the capture succeeded, failed, or is pending.
Email: Includes confirmation or cancellation of the order, as well as shipping.
Fulfillment: Includes whether the fulfillment succeeded, failed, or is pending. Also includes cancellation, restocking, and fulfillment updates.
Order: Includess the placement, confirmation, closing, re-opening, and cancellation of the order.
Refund: Includes whether the refund succeeded, failed, or is pending.
Sale: Includes whether the sale succeeded, failed, or is pending.
Void: Includes whether the void succeeded, failed, or is pending.

Action	Message	Description
`authorization_failure`	The customer, unsuccessfully, tried to authorize: `{money_amount}`.	Authorization failed. The funds cannot be captured.
`authorization_pending`	Authorization for `{money_amount}` is pending.	Authorization pending.
`authorization_success`	The customer successfully authorized us to capture: `{money_amount}`.	Authorization was successful and the funds are available for capture.
`cancelled`	Order was cancelled by `{shop_staff_name}`.	The order was cancelled.
`capture_failure`	We failed to capture: `{money_amount}`.	The capture failed. The funds cannot be transferred to the shop.
`capture_pending`	Capture for `{money_amount}` is pending.	The capture is in process. The funds are not yet available to the shop.
`capture_success`	We successfully captured: `{money_amount}`	The capture was successful and the funds are now available to the shop.
`closed`	Order was closed.	The order was closed.
`confirmed`	Received a new order: `{order_number}` by `{customer_name}`.	The order was confirmed.
`fulfillment_cancelled`	We cancelled `{number_of_line_items}` from being fulfilled by the third party fulfillment service.	Fulfillment for one or more of the line_items failed.
`fulfillment_pending`	We submitted `{number_of_line_items}` to the third party service.	One or more of the line_items has been assigned to a third party service for fulfillment.
`fulfillment_success`	We successfully fulfilled line_items.	Fulfillment was successful for one or more line_items.
`mail_sent`	`{message_type}` email was sent to the customer.	An email was sent to the customer.
`placed`	Order was placed.	An order was placed by the customer.
`re_opened`	Order was re-opened.	An order was re-opened.
`refund_failure`	We failed to refund `{money_amount}`.	The refund failed. The funds are still with the shop.
`refund_pending`	Refund of `{money_amount}` is still pending.	The refund is in process. The funds are still with shop.
`refund_success`	We successfully refunded `{money_amount}`.	The refund was successful. The funds have been transferred to the customer.
`restock_line_items`	We restocked `{number_of_line_items}`.	One or more of the order's line items have been restocked.
`sale_failure`	The customer failed to pay `{money_amount}`.	The sale failed. The funds are not available to the shop.
`sale_pending`	The `{money_amount}` is pending.	The sale is in process. The funds are not yet available to the shop.
`sale_success`	We successfully captured `{money_amount}`.	The sale was successful. The funds are now with the shop.
`update`	`{order_number}` was updated.	The order was updated.
`void_failure`	We failed to void the authorization.	Voiding the authorization failed. The authorization is still valid.
`void_pending`	Authorization void is pending.	Voiding the authorization is in process. The authorization is still valid.
`void_success`	We successfully voided the authorization.	Voiding the authorization was successful. The authorization is no longer valid.

Anchor to actionaction •String! non-null: The action that occured.
Anchor to additionalContentadditionalContent •JSON: Provides additional content for collapsible timeline events.
Anchor to additionalDataadditionalData •JSON: Provides additional data for event consumers.
Anchor to appTitleappTitle •String: The name of the app that created the event.
Anchor to argumentsarguments •JSON: Refers to a certain event and its resources.
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 •String: The entity which performed the action that generated the event.
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 hasAdditionalContenthasAdditionalContent •Boolean! non-null: Whether this event has additional content.
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 secondaryMessagesecondaryMessage •FormattedString: Human readable text that supports the event message.
Anchor to subjectsubject •HasEvents: The resource that generated the event. To see a list of possible types, refer to HasEvents.
Anchor to subjectIdsubjectId •ID! non-null: The ID of the resource that generated the event.
Anchor to subjectTypesubjectType •EventSubjectType! non-null: The type of the resource that generated the event.

CommentEvent

•OBJECT

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 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?