Skip to main content
Anchor to hydrogenStorefrontCreate

hydrogenStorefrontCreate

mutation

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

Sets up a new Hydrogen storefront to power your headless commerce experience. This mutation kicks off the provisioning process in the background and gives you a job ID to track progress.

For example, when launching a new headless commerce experience, developers use this mutation to provision the storefront environment.

Use hydrogenStorefrontCreate to:

  • Provision new Hydrogen storefront instances
  • Track creation progress through background jobs
  • Handle setup validation and error reporting

The mutation returns immediately with a job ID that can be used to monitor the creation progress, as storefront provisioning runs asynchronously. User errors provide feedback if the creation request contains invalid parameters or conflicts with existing resources.

Learn more about creating Hydrogen storefronts.

Anchor to Arguments

Arguments

Anchor to titletitle
•String!
required

The title for the Hydrogen storefront.

Was this section helpful?

Anchor to HydrogenStorefrontCreatePayload returnsHydrogenStorefrontCreatePayload returns

Anchor to jobIdjobId
•ID

ID for job that connects the Hydrogen storefront to Oxygen.

Anchor to userErrorsuserErrors
•[HydrogenStorefrontCreateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?