Invoke Operations Page

Select the module, the operations you want to perform in the Shopify application, and the response parameters .

Element Description

Select Module

Select the module on which you want to perform operations (for example, Customers, Company, Fulfillment, Order, and Payment).

Select Business Object

Select an operation for a module such as Customer Create, Customer Merge, Customer Delete, Customer Merge Job Status, and so on. The operations available for selection are based on the module and action (Query/Create,Update or Delete) selected.

Business Object Description

Describes the business object or the operation selected above. For example, a description for the Customer Payment Method business object might be:
Returns a CustomerPaymentMethod resource by its Id.

Available Response Objects

Displays a list of objects in a shuttle box. You can select these objects to filter the response of query, create, update, and delete operations.

You can select a maximum of five response objects, which allows you to filter results of up to three six-nested levels.

The shuttle box shows only objects. Scalar and ENUM type fields are included in the query by default.

The objects retrieved from the Shopify application are determined by the eligibility criteria listed below:

  • Eligibility criteria for objects to appear in the shuttle box based on arguments (first, last, before, after, query, or reverse):

    Note: To understand these criteria, perform the following configurations as an example: select Query as the invoke action, Customer as the module, and Customers as the business object. See Shopify API Documentation for Customers Query.

    An object appears in the shuttle box only if it fulfills one of the conditions listed below:
    • Contains only the first argument (for example, addresses).
    • Contains all or some of the arguments (for example, addressesV2).
    An object does not appear in the shuttle box if it:
    • Contains arguments other than first, last, after, before, query or reverse (for example, events).
    • None of the arguments are present (for example, canDelete).
    • If the object is deprecated (for example, email).

  • Eligibility criteria for objects to appear in the shuttle box based on the operation's response schema:

    To understand these criteria, perform the following configurations as an example: select Query as the invoke action, Customer as the module, and Customer Merge Preview as the business object. See Shopify API Documentation for Customer Merge Preview Query.

    • If the operation’s response schema has exactly three parent fields (edges, nodes, and page info), then nested objects within nodes and page info are displayed in the shuttle box (for example, addressesV2).
    • If the operation’s response schema has parent fields other than edges, nodes, and page info, then those parent fields appear as objects in the shuttle box (for example, alternateFields).

Edit Query

Allows you to edit the default query generated based on the action, module, business object, and response objects selected so far.

Note: You can add a new response object or remove the selected one while editing the query. You can also supply the input variable, test, and update the query, if required.

Try Query (Appears only if you select Query action)

Allows you to execute the query and fetch a sample data for reference.

Reset Configurations

Allows you to discard a customized query and return to the default configuration state.