Get order data

Early access

This action is in limited release and is only available to certain stores.

In workflows that use order data, you can use the Get order data action to retrieve order 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 order data action contains the following fields.

Fields used in the Get order data action.

Field	Description
Sort data by	Required. The parameters by which the data returned by the search query is sorted.
Maximum number of orders	Required. The maximum amount of orders 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 orders query by using Shopify's API search syntax.
Edit query	The search query that's used to select orders. This query can be edited to customize the results.

Returned data

The Get order 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 order data action to a workflow, steps that follow this action have a Get order data variable available in the variable picker. To use the data extracted by your query in following conditions or actions, select Get order data in the Returned data section of the configuration panel. For custom created variables, use the getOrderData object.

Note

If then Get order 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 order data action twice, the first variable for returned data is getOrderData and the second variable is getOrderData1.

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

Triggers

The Get order data action can be used in any workflow.

Example

In this example workflow, a workflow is scheduled to run every Sunday at 9:00 am. The Get order data action is used to collect data for orders created in the last week. If the customers associated with the orders have a lifetime spend amount of over 100 USD, then the Gold tag is applied to the customer.