previewInstall

Installs storefront generation preview for shop.

Use it in a workflow

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

mutation PreviewInstall($storefrontGenerationPreviewUuid: String!) {
  previewInstall(
    storefrontGenerationPreviewUuid: $storefrontGenerationPreviewUuid
  ) {
    newTheme {
      createdAt
      id
      name
      prefix
      processing
      processingFailed
      role
      themeStoreId
      updatedAt
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

{
  "storefrontGenerationPreviewUuid": "string"
}

Response

Read the result with {{previewinstall.response.data.data.previewInstall}}. If the API returns errors, the step fails and they are at {{previewinstall.response.data.errors}}.

Need more? See the Shopify guide for connection setup and behaviour shared by every action.