Get product variant data

Note

A product has one or more product variants. For example, a shirt product might have a product variant for each size and color combination.

In workflows that use product variant data, you can use the Get product variant data action to retrieve product variant information from your store. You can use this action in any workflow, including the Scheduled time trigger. In a workflow that uses the Scheduled time trigger, the workflow starts at a time that you've specified, rather than as a result of an event. Because there is no specific event in your store or from an app that starts the workflow, there is no data automatically included.

Fields

The Get product variant data action contains the following fields.

Fields used in the Get product variant data action.

Field	Description
Sort data by	Required. How the data returned by the search query is sorted.
Maximum number of product variants	Required. The maximum amount of product variants that can be returned by the search query that you select.
Select a query to filter data	Required. The search query that obtains the data to be used in the workflow. Select Advanced to create your own product variants query by using Shopify's API search syntax.
Edit query	The search query that's used to select product variants. This query can be edited to customize the results.

Returned data

The Get product variant data action itself doesn't take any direct action in your store. Instead, it extracts data from your store based on your query, and makes this data available for use in subsequent steps in your workflow.

When you add a Get product variant data action to a workflow, steps that follow this action have a Get product variant data variable available in the variable picker. To use the data extracted by your query in following conditions or actions, select Get product variant data in the Returned data section of the configuration panel. For custom created variables, use the getProductVariantData object.

Note

If the Get product variant data action is used multiple times in a single workflow, then a number is added to the variable name. For example, in a workflow that uses the Get product variant data action twice, the first variable for returned data is getProductVariantData and the second variable is getProductVariantData1.

Variables are named according to the action, and can't be customized.

Triggers

The Get product variant data action can be used in any workflow.

Example

In this example workflow, a workflow is scheduled to run every Sunday. The Get product variant data action is used to collect data for product variants that are currently low stock. An email is sent with a list of the product variants.