Skip to main content

store execute

Executes an Admin API GraphQL query or mutation on the specified store using previously stored app authentication.

Run shopify store auth first to create stored auth for the store.

Mutations are disabled by default. Re-run with --allow-mutations if you intend to modify store data.

The following flags are available for the store execute command:

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

The myshopify.com domain of the store.

Anchor to --allow-mutations
--allow-mutations
env: SHOPIFY_FLAG_ALLOW_MUTATIONS

Allow GraphQL mutations to run against the target store.

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 name where results should be written, instead of STDOUT.

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 --variable-file <value>
--variable-file <value>
string
env: SHOPIFY_FLAG_VARIABLE_FILE

Path to a file containing GraphQL variables in JSON format. 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 query or mutation. Defaults to the latest stable version.

Anchor to -j, --json
-j, --json
env: SHOPIFY_FLAG_JSON

Output the result as JSON. Automatically disables color output.

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

The GraphQL query or mutation, as a string.

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

The values for any GraphQL variables in your query or mutation, in JSON format.


Was this page helpful?