Skip to main content
Anchor to HydrogenStorefrontCreatePayload

HydrogenStorefrontCreatePayload

payload

Return type for hydrogenStorefrontCreate mutation.

Anchor to FieldsFields

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?

Anchor to Mutations with this payloadMutations with this payload

Anchor to hydrogenStorefrontCreatehydrogenStorefrontCreate
•mutation

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.

Was this section helpful?