2/3/2026, 8:00:11 PM
Channel queries and mutations now use flattened argument names; the collectionCreate and collectionUpdate mutations no longer accept an input object, which means callers must now provide individual fields directly. Event filtering across many resource types has been updated to reference a oneβyear retention window, with the created_at filter description amended accordingly in all Event connections and the eventsCount query. The channelFullSync mutation's language and country arguments have been clarified to perform a full sync for all languages or countries when omitted. The inventorySetScheduledChanges mutation has been marked deprecated and will be removed in a future release. New metafield capability types (MetafieldCapabilityCartToOrderCopyable and its input) were introduced and the MetafieldCapabilities type now exposes the cartToOrderCopyable field. Additional enum values were added to CheckoutBrandingColorSchemeSelection (COLOR_SCHEME5 and COLOR_SCHEME6) along with new scheme fields in CheckoutBrandingColorSchemes. Several new error code enum values (INVENTORY_STATE_NOT_ACTIVE, ACTIVATION_FAILED, MISSING_COUNTRY_CODE, INVALID_COUNTRY_AND_PROVINCE_CONDITIONS) were added to improve inventory, market, and transfer error handling. Subsequent document updates throughout object types (Article, Blog, Collection, Comment, Company, etc.) updated the details of the events field arguments, specifically the retention period of event data.
Returns a channel by its handle. The channel must have been established by the calling application.
A paginated list of events that chronicle activities in the store. Event is an interface implemented by types such as BasicEvent and CommentEvent that track actions such as creating Article objects, fulfilling Order objects, adding Product objects, or staff comments on timelines.
The query supports filtering and sorting to help you find specific events or audit store activity over time.
Count of events. Limited to a maximum of 10000.
Initiates a full sync via Product Feed mechanism for the matching Channel.
Creates a collection
to group products together
in the online store and
other sales channels.
For example, an athletics store might create different collections for running attire, shoes, and accessories.
There are two types of collections:
Use the collectionCreate mutation when you need to:
Note:
The created collection is unpublished by default. To make it available to customers,
use thepublishablePublish
mutation after creation.
Learn more about using metafields with smart collections.
Updates a collection,
modifying its properties, products, or publication settings. Collections help organize
products together
in the online store and
other sales channels.
Use the collectionUpdate mutation to programmatically modify collections in scenarios such as:
There are two types of collections with different update capabilities:
job object that you can use to track the progress of the update.To publish or unpublish collections to specific sales channels, use the dedicatedpublishablePublish andpublishableUnpublish mutations.
Learn more about using metafields with smart collections.
Set up scheduled changes of inventory items.
Caution:
As of 2026-01, this mutation supports an optional idempotency key using the@idempotentdirective.
As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective.
For more information, see the idempotency documentation.
Information about the cart to order copyable capability on a metafield definition.
Only order metafield definitions are eligible to have this capability enabled.
When enabled, the value from a cart metafield is automatically copied to the corresponding
order metafield when an order is created. The namespace and key must match between the cart and order metafields.
The input fields for enabling or disabling the "Cart to order copyable" capability.
This capability is only available for order metafield definitions.
When enabled, the value from a cart metafield is automatically copied to the corresponding
order metafield when an order is created. The namespace and key must match between the cart and order metafields.
eventsevents on ArticleThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on BlogThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
accountNameaccountName on ChannelDisplay name for the channel.
StringThe account name for the external channel account.
StringspecificationHandlespecificationHandle on ChannelThe channel specification for the channel.
StringThe handle of the channel specification.
StringCOLOR_SCHEME5COLOR_SCHEME6scheme5An extra scheme available to customize more surfaces, components or specific states of the user interface.
scheme6An extra scheme available to customize more surfaces, components or specific states of the user interface.
eventsevents on CollectionThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CommentThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CompanyThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CompanyLocationThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on CustomerA list of events associated with the customer.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of events associated with the customer.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountAutomaticBxgyThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountAutomaticNodeThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountCodeNodeThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DiscountNodeThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on DraftOrderThe list of events associated with the draft order.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The list of events associated with the draft order.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on HasEventsThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
INVENTORY_STATE_NOT_ACTIVEACTIVATION_FAILEDeventsevents on InventoryTransferThe list of events associated with the inventory transfer.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The list of events associated with the inventory transfer.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
MISSING_COUNTRY_CODEINVALID_COUNTRY_AND_PROVINCE_CONDITIONScartToOrderCopyableThe capability configuration for automatically copying values from a cart metafield to the corresponding order metafield when an order is created.
eventsevents on OrderA list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of events associated with the order. Events track significant changes and activities related to the order, such as creation, payment, fulfillment, and cancellation.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on PageThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on PriceRuleThe paginated list of events associated with the price rule.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the price rule.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on ProductThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
eventsevents on ProductVariantThe paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event happened. | - created_at:>2020-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The paginated list of events associated with the host subject.
EventConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: EventSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
query: String - A filter made up of terms, connectives, modifiers, and comparators.
| name | type | description | acceptable_values | default_value | example_use |
|---|---|---|---|---|---|
| action | string | The action that occured. | - action:create |
||
| comments | boolean | Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events. |
- false- true |
||
| created_at | time | Filter by the date and time when the event occurred. Event data is retained for 1 year. | - created_at:>2025-10-21- created_at:<now |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| subject_type | string | The resource type affected by this event. See EventSubjectType for possible values. | - PRODUCT_VARIANT- PRODUCT- COLLECTION |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |