Change: Automation Step Runs Added; Webhook Topics Trimmed

Type Changes

➕ Added Types (7)

🏗️AutomationStepRun➕ AddedOBJECT

A recorded execution of a step in an automation run, without its input, output, or error.

Fields: id, iterationTrail, lastRunAt, status, stepId ... +2 more

🏗️AutomationStepRunPage➕ AddedOBJECT

A bounded, live page of an automation run's recorded step executions.

Fields: continuation, nodes

📋AutomationStepRunStatus➕ AddedENUM

The effective status of a recorded step execution, read from the run's current state.

Values: NOT_RUN, SKIPPED, SKIPPED_NOT_RUN, CANCELLED, RUNNING, RETRYING, SUCCEEDED, FAILED

📥CollectionSourceInclusionConditionUpdateVariantOptionInput➕ AddedINPUT_OBJECT

The input fields for updating a condition based on variant option values.

🏗️CollectionSourceInclusionConditionVariantOption➕ AddedOBJECT

A condition based on variant option values for including products in a collection.

Fields: id, matchType, optionName, relation, values

📥CollectionSourceInclusionConditionVariantOptionInput➕ AddedINPUT_OBJECT

The input fields for a condition based on variant option values.

📋CollectionSourceInclusionConditionVariantOptionRelation➕ AddedENUM

The relation for comparing variant option values.

Values: EQUALS, NOT_EQUALS

🔄 Modified Types (5)

🏗️AutomationWorkflowRun🔄 Modified

➕ Field added: stepRun

One recorded execution of this run, by an ID that stepRuns returned for it. Returns null for an unknown ID or an ID from another run. Returns an access denied error when the run's step details aren't readable with the current permissions. A TEST run's step details can become searchable before its permission requirements. While the run is still in progress, started less than 4 minutes ago and its requirements aren't searchable, the field is null with an UNAVAILABLE error ("This test run's step details aren't readable yet. Try again."): retry with backoff. After 4 minutes without its requirements, or once the run has finished, missing requirements are an ACCESS_DENIED error; start a new test run instead. PRODUCTION runs never return UNAVAILABLE for this.

➕ Field added: stepRuns

A bounded, live page of the run's recorded step executions, ordered by step, iteration trail, and execution. Each page reads current data, so retrying a continuation can return a different page. An execution indexed behind a continuation's position appears only after a restart without after: restart a scan that started while a test run was IN_PROGRESS once its status is COMPLETED or FAILED. Returns an access denied error when the run's step details aren't readable with the current permissions. A TEST run's step details can become searchable before its permission requirements. While the run is still in progress, started less than 4 minutes ago and its requirements aren't searchable, the field is null with an UNAVAILABLE error ("This test run's step details aren't readable yet. Try again."): retry with backoff. After 4 minutes without its requirements, or once the run has finished, missing requirements are an ACCESS_DENIED error; start a new test run instead. PRODUCTION runs never return UNAVAILABLE for this.

🏗️Customer🔄 Modified

🔄 Field modified: state

🏗️RolloutChangeApplyResult🔄 Modified

🔄 Field modified: completedAt

🔄 Field modified: errorCode

🏗️Shop🔄 Modified

🔄 Field modified: customers

Before:

📝

Customer accounts associated to the shop.

Type: CustomerConnection!

Arguments:

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: CustomerSortKeys -

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	example_use
default	string	Filter by a case-insensitive search of multiple fields in a document.	- `query=Bob Norman` - `query=title:green hoodie`
accepts_marketing	boolean	Filter by whether a customer has consented to receive marketing material.	- `accepts_marketing:true`
country	string	Filter by the country associated with the customer's address. Use either the country name or the two-letter country code.	- `country:Canada` - `country:JP`
customer_date	time	Filter by the date and time when the customer record was created. This query parameter filters by the `createdAt` field.	- `customer_date:'2024-03-15T14:30:00Z'` - `customer_date: >='2024-01-01'`
email	string	The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that email is a tokenized field: To retrieve exact matches, quote the email address (phrase query) as described in Shopify API search syntax.	- `email:gmail.com` - `email:"bo.wang@example.com"` - `email:*`
first_name	string	Filter by the customer's first name.	- `first_name:Jane`
id	id	Filter by `id` range.	- `id:1234` - `id:>=1234` - `id:<=1234`
last_abandoned_order_date	time	Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase.	- `last_abandoned_order_date:'2024-04-01T10:00:00Z'` - `last_abandoned_order_date: >='2024-01-01'`
last_name	string	Filter by the customer's last name.	- `last_name:Reeves`
order_date	time	Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range.	- `order_date:'2024-02-20T00:00:00Z'` - `order_date: >='2024-01-01'` - `order_date:'2024-01-01..2024-03-31'`
orders_count	integer	Filter by the total number of orders a customer has placed.	- `orders_count:5`
phone	string	The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified.	- `phone:+18005550100` - `phone:*`
state	string	Filter by the state of the customer's account with the shop. This filter is only valid when Classic Customer Accounts is active.	- `state:ENABLED` - `state:INVITED` - `state:DISABLED` - `state:DECLINED`
tag	string	Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas.	- `tag:'VIP'` - `tag:'Wholesale,Repeat'`
tag_not	string	Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas.	- `tag_not:'Prospect'` - `tag_not:'Test,Internal'`
total_spent	float	Filter by the total amount of money a customer has spent across all orders.	- `total_spent:100.50` - `total_spent:50.00` - `total_spent:>100.50` - `total_spent:>50.00`
updated_at	time	The date and time, matching a whole day, when the customer's information was last updated.	- `updated_at:'2024-01-01T00:00:00Z'` - `updated_at:<now` - `updated_at:<=2024`
You can apply one or more filters to a query. Learn more about Shopify API search syntax.

⚠️ Deprecated: Use `QueryRoot.customers` instead.

After:

📝

Customer accounts associated to the shop.

Type: CustomerConnection!

Arguments:

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: CustomerSortKeys -

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	example_use
default	string	Filter by a case-insensitive search of multiple fields in a document.	- `query=Bob Norman` - `query=title:green hoodie`
accepts_marketing	boolean	Filter by whether a customer has consented to receive marketing material.	- `accepts_marketing:true`
country	string	Filter by the country associated with the customer's address. Use either the country name or the two-letter country code.	- `country:Canada` - `country:JP`
customer_date	time	Filter by the date and time when the customer record was created. This query parameter filters by the `createdAt` field.	- `customer_date:'2024-03-15T14:30:00Z'` - `customer_date: >='2024-01-01'`
email	string	The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that email is a tokenized field: To retrieve exact matches, quote the email address (phrase query) as described in Shopify API search syntax.	- `email:gmail.com` - `email:"bo.wang@example.com"` - `email:*`
first_name	string	Filter by the customer's first name.	- `first_name:Jane`
id	id	Filter by `id` range.	- `id:1234` - `id:>=1234` - `id:<=1234`
last_abandoned_order_date	time	Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase.	- `last_abandoned_order_date:'2024-04-01T10:00:00Z'` - `last_abandoned_order_date: >='2024-01-01'`
last_name	string	Filter by the customer's last name.	- `last_name:Reeves`
order_date	time	Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range.	- `order_date:'2024-02-20T00:00:00Z'` - `order_date: >='2024-01-01'` - `order_date:'2024-01-01..2024-03-31'`
orders_count	integer	Filter by the total number of orders a customer has placed.	- `orders_count:5`
phone	string	The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified.	- `phone:+18005550100` - `phone:*`
state	string	Filter by the state of the customer's account with the shop.	- `state:ENABLED` - `state:INVITED` - `state:DISABLED` - `state:DECLINED`
tag	string	Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas.	- `tag:'VIP'` - `tag:'Wholesale,Repeat'`
tag_not	string	Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas.	- `tag_not:'Prospect'` - `tag_not:'Test,Internal'`
total_spent	float	Filter by the total amount of money a customer has spent across all orders.	- `total_spent:100.50` - `total_spent:50.00` - `total_spent:>100.50` - `total_spent:>50.00`
updated_at	time	The date and time, matching a whole day, when the customer's information was last updated.	- `updated_at:'2024-01-01T00:00:00Z'` - `updated_at:<now` - `updated_at:<=2024`
You can apply one or more filters to a query. Learn more about Shopify API search syntax.

⚠️ Deprecated: Use `QueryRoot.customers` instead.

🏗️WebhookSubscriptionTopic🔄 Modified

➖ Enum value removed: ATTRIBUTED_SESSIONS_FIRST

➖ Enum value removed: ATTRIBUTED_SESSIONS_LAST

Automation Step Runs Added; Webhook Topics Trimmed

Query Changes

🔄 Modified Queries (1)

Type Changes

➕ Added Types (7)

🔄 Modified Types (5)

Automation Step Runs Added; Webhook Topics Trimmed

Query Changes

🔄 Modified Queries (1)

Type Changes

➕ Added Types (7)

🔄 Modified Types (5)

Field Modified: state on Customer

Before:

After:

Field Modified: completedAt on RolloutChangeApplyResult

Before:

After:

Field Modified: errorCode on RolloutChangeApplyResult

Before:

After:

Field Modified: customers on Shop

Before:

After:

Field Modified: `state` on `Customer`

Field Modified: `completedAt` on `RolloutChangeApplyResult`

Field Modified: `errorCode` on `RolloutChangeApplyResult`

Field Modified: `customers` on `Shop`