Using Parameters

When using Shopify actions, MESA will display all available and required fields that are needed in order to complete them.

If you are using a Shopify action that gets a list of items (their names typically start with Get List of), MESA will return 50 results by default. But, if you want to get results based on a specific criteria, you can select the Get a list of items that meet the specified criteria option from the step. After selecting, you can fill any of the available fields to filter out unwanted results.

However, if you need to specify a filter that is not available as a field, you can click on the step's Advanced Options field.

You should not have to fill out the Advanced Options: Parameters field unless you don't see your preferred field in a step's Step Configuration section.

The Parameters field lets you input parameters for HTTP endpoints which are specific addresses on the internet where you can access or send data. Parameters are additional details you include when making a request to these endpoints, providing specific instructions or preferences. You can think of endpoints as destinations and parameters as special requests. For example, when you search for something online, the search term is a parameter you send to a search endpoint. For more information, read here.

To use the Parameters field, you would need to look at Shopify's REST Admin API documentation for the Shopify action (endpoint) that you want to work with.

For the rest of this section, we will assume that you are familiar with HTTP parameters and we will use MESA's Shopify: Get List of Orders action as an example.

To look up this action on the API documentation,we would need to look at this page: https://shopify.dev/docs/api/admin-rest/2023-07/resources/order#get-orders?status=any

Once there, you will see a list of Parameters that you can specify. Please ignore the api_version parameter since MESA takes care of that already.

If we are trying to get a list of paid orders, you would need to use the financial_status parameter.

This is how you'd fill out the Parameters field in your workflow.

Again, you should not have to do this since we already include the Financial Status field in the Step Configuration section. This is just for demo purposes.