Skip to main content

app bulk execute

Executes an Admin API GraphQL query or mutation on the specified store, as a bulk operation. Mutations are only allowed on dev stores.

Bulk operations allow you to process large amounts of data asynchronously. Learn more about bulk query operations and bulk mutation operations.

Use bulk status to check the status of your bulk operations.

The following flags are available for the app bulk execute command:

Anchor to --client-id <value>
--client-id <value>
string
env: SHOPIFY_FLAG_CLIENT_ID

The Client ID of your app.

Anchor to --no-color
--no-color
env: SHOPIFY_FLAG_NO_COLOR

Disable color output.

Anchor to --output-file <value>
--output-file <value>
string
env: SHOPIFY_FLAG_OUTPUT_FILE

The file path where results should be written if --watch is specified. If not specified, results will be written to STDOUT.

Anchor to --path <value>
--path <value>
string
env: SHOPIFY_FLAG_PATH

The path to your app directory.

Anchor to --query-file <value>
--query-file <value>
string
env: SHOPIFY_FLAG_QUERY_FILE

Path to a file containing the GraphQL query or mutation. Can't be used with --query.

Anchor to --reset
--reset
env: SHOPIFY_FLAG_RESET

Reset all your settings.

Anchor to --variable-file <value>
--variable-file <value>
string
env: SHOPIFY_FLAG_VARIABLE_FILE

Path to a file containing GraphQL variables in JSONL format (one JSON object per line). Can't be used with --variables.

Anchor to --verbose
--verbose
env: SHOPIFY_FLAG_VERBOSE

Increase the verbosity of the output.

Anchor to --version <value>
--version <value>
string
env: SHOPIFY_FLAG_VERSION

The API version to use for the bulk operation. If not specified, uses the latest stable version.

Anchor to --watch
--watch
env: SHOPIFY_FLAG_WATCH

Wait for bulk operation results before exiting. Defaults to false.

Anchor to -c, --config <value>
-c, --config <value>
string
env: SHOPIFY_FLAG_APP_CONFIG

The name of the app configuration.

Anchor to -q, --query <value>
-q, --query <value>
string
env: SHOPIFY_FLAG_QUERY

The GraphQL query or mutation to run as a bulk operation.

Anchor to -s, --store <value>
-s, --store <value>
string
env: SHOPIFY_FLAG_STORE

The store domain. Must be an existing dev store.

Anchor to -v, --variables <value>
-v, --variables <value>
string
env: SHOPIFY_FLAG_VARIABLES

The values for any GraphQL variables in your mutation, in JSON format. Can be specified multiple times.

Examples

app bulk execute

shopify app bulk execute [flags]
Was this page helpful?