hydrogenStorefrontEnvironmentVariableBulkReplace

mutation

Requires Request must be initiated from the Shopify CLI and user must have full access to apps or access to the Hydrogen channel.

Replaces all environment variables for a specific Hydrogen storefront environment in a single atomic operation. This mutation provides a complete replacement strategy rather than individual variable updates, ensuring consistent environment configuration.

For example, when deploying a new version of your Hydrogen storefront that requires a different set of API keys, database URLs, and feature flags, you can replace the entire environment configuration at once rather than updating variables individually.

Use HydrogenStorefrontEnvironmentVariableBulkReplace to:

Deploy complete environment configurations during releases
Synchronize development and production environment settings
Reset environment variables to a known baseline state
Migrate between different configuration schemas

This bulk replacement approach helps prevent configuration drift and ensures all related variables are updated together, reducing the risk of partial updates that could break your storefront functionality.

Learn more about Hydrogen deployment.

Anchor to Arguments

Arguments

Anchor to environmentIdenvironmentId •ID! required: The environment ID for which the variables will be set.
Anchor to environmentVariablesInputenvironmentVariablesInput •[HydrogenStorefrontEnvironmentVariableInput!]! required: An array of objects, each representing an environment variable to be created.
Anchor to storefrontIdstorefrontId •ID! required: The ID of the storefront.

Was this section helpful?

Anchor to HydrogenStorefrontEnvironmentVariableBulkReplacePayload returnsHydrogenStorefrontEnvironmentVariableBulkReplacePayload returns

Anchor to userErrorsuserErrors •[EnvironmentVariablesUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

hydrogenStorefrontEnvironmentVariableBulkReplace reference

Mutation Reference

mutation hydrogenStorefrontEnvironmentVariableBulkReplace($environmentId: ID!, $environmentVariablesInput: [HydrogenStorefrontEnvironmentVariableInput!]!, $storefrontId: ID!) {

hydrogenStorefrontEnvironmentVariableBulkReplace(environmentId: $environmentId, environmentVariablesInput: $environmentVariablesInput, storefrontId: $storefrontId) {

userErrors {

field

message

}

Input

{

"environmentId": "gid://shopify/<objectName>/10079785100",

"environmentVariablesInput": [

{

"isSecret": true,

"key": "<your-key>",

"value": "<your-value>"

}

"storefrontId": "gid://shopify/<objectName>/10079785100"

}

{
  "environmentId": "gid://shopify/<objectName>/10079785100",
  "environmentVariablesInput": [
    {
      "isSecret": true,
      "key": "<your-key>",
      "value": "<your-value>"
    }
  ],
  "storefrontId": "gid://shopify/<objectName>/10079785100"
}

input HydrogenStorefrontEnvironmentVariableInput {
  isSecret: Boolean
  key: String!
  value: String!
}