Events
Retrieve events which have happened in your shop.
View-Specific Information
Select
The driver uses the Shopify API to process search criteria that refer to the Id, ProductId, OrderId, Verb, and CreatedAt columns. The supported SQL operators are '=' for the Id, ProductId, OrderId, and Verb columns and ">" and "<" for CreatedAt. The driver processes other filters client-side within the driver. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.
For example, the following queries are processed server side:
SELECT * FROM Events
SELECT * FROM Events WHERE Id='123'
SELECT * FROM Events WHERE ProductId='123'
SELECT * FROM Events WHERE OrderId='123'
SELECT * FROM Events WHERE Verb='Confirmed'
SELECT * FROM Events WHERE CreatedAt > '2018-05-02'
Columns
Name | Type | References | Description |
Id [KEY] | Long | The ID of the event. | |
Description | String | A human readable description of the event. | |
Message | String | A human readable description of the event. Can contain some HTML formatting. | |
Body | String | A text field containing information about the event. | |
Path | String | A relative URL to the resource the event is for, if applicable. | |
SubjectId | Long | The ID of the resource that generated the event. | |
SubjectType | String | he type of the resource that generated the event. Valid values: Article, Blog, Collection, Comment, Order, Page, Product, ApiPermission. | |
Verb | String | The type of event that occurred. Different resources generate different types of event. | |
Author | String | The author of the event. | |
Arguments | String | Refers to a certain event and its resources. | |
CreatedAt | Datetime | The date and time when the event was created. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
OrderId | Long | The ID of the Order to retrieve events from. | |
ProductId | Long | The ID of the Product to retrieve events from. |