Note: Events are export-only and cannot be imported or updated through Altera.
General
ID
Description | Example Value |
Unique event identifier |
|
The unique identifier assigned to each event by Shopify. This field is export-only and cannot be imported.
Message
Description | Example Value |
Description of what occurred |
|
A human-readable description of the event that occurred. This field is export-only and cannot be imported.
Created At
Description | Example Value |
When the event occurred |
|
The timestamp when the event was recorded. This field is export-only and cannot be imported.
Subject Type
Description | Example Value |
Type of object affected |
|
The type of Shopify object that was affected by this event. Common values include:
ARTICLE: Blog articles
BLOG: Blogs
COLLECTION: Product collections
COMMENT: Blog comments
CUSTOMER: Customers
ORDER: Orders
PAGE: Static pages
PRODUCT: Products
VARIANT: Product variants
This field is export-only and cannot be imported.
Subject ID
Description | Example Value |
Identifier of affected object |
|
The unique identifier of the specific object that was affected by this event. This field is export-only and cannot be imported.
Verb
Description | Example Value |
Action that occurred |
|
The type of action that was performed. Common values include:
CREATE: Object was created
UPDATE: Object was modified
DELETE: Object was deleted
PUBLISH: Object was published
UNPUBLISH: Object was unpublished
This field is export-only and cannot be imported.
Author
Description | Example Value |
User who performed the action |
The email address or identifier of the user who performed the action that triggered this event. This field is export-only and cannot be imported.
Arguments
Description | Example Value |
Additional event details |
|
A JSON object containing additional details about what changed during the event. The structure varies depending on the type of event. This field is export-only and cannot be imported.
Body
Description | Example Value |
Detailed event description |
|
A detailed description of what changed during the event. This field is export-only and cannot be imported.
Path
Description | Example Value |
API path related to the event |
|
The API endpoint path related to the event, if applicable. This field is export-only and cannot be imported.
Order
These fields are only populated for order-related activity (events where Subject Type is ORDER). For other event types, these fields will be empty.
Order ID
Description | Example Value |
Unique order identifier |
|
The unique identifier assigned to the order by Shopify.
Order Name
Description | Example Value |
Order display name |
|
The human-readable order number displayed in Shopify admin.
Order Email
Description | Example Value |
Customer email |
The email address associated with the order.
Order Phone
Description | Example Value |
Customer phone number |
|
The phone number associated with the order.
Order Tags
Description | Example Value |
Tags applied to order |
|
Tags associated with the order for organization and filtering.
Order Price: Total
Description | Example Value |
Total order amount |
|
The total price of the order in the shop's currency.
Order Payment: Status
Description | Example Value |
Payment status of order |
|
The financial status of the order. Common values include:
paid: Payment has been received
pending: Payment is pending
authorized: Payment has been authorized but not captured
partially_paid: Partial payment received
partially_refunded: Partial refund issued
refunded: Full refund issued
voided: Payment was voided
Order Fulfillment Status
Description | Example Value |
Fulfillment status of order |
|
The fulfillment status of the order. Common values include:
fulfilled: All items have been shipped
unfulfilled: No items have been shipped
partial: Some items have been shipped
scheduled: Fulfillment is scheduled
on_hold: Fulfillment is on hold
Order Processed At
Description | Example Value |
When the order was placed |
|
The timestamp when the order was processed/placed.
Export Filters
You can use these filters to limit which events are exported:
created_at: Filter by when event occurredsubject_type: Filter by type of object (ARTICLE, BLOG, COLLECTION, COMMENT, etc.)verb: Filter by action type (see below)
Verb Filter
The verb filter allows you to filter events by the type of action that occurred. This filter is applied client-side, so counts will not be available when using this filter.
There are many possible verbs depending on the type of activity. Some of the most common include:
closedconfirmedcreatedestroyorder_placedplacedpublishedrefund_createdsale_successstatus_changedunpublishedupdate
Example: To export only events where products were created, use two filters:
Subject type:
ProductVerb:
create