Skip to content

adminAppearanceThemeImpact

What activating a theme on the given channels would leave behind. Reports only; nothing is written.

A channel is listed when it currently runs a different theme and already holds sections built for it. Those sections are not deleted by activation — they stop being drawn, and return if the channel is pointed back at that theme.

Arguments

ArgumentTypeDescription
codeString!Theme code being considered.
channelIds[Int!]!Channels the theme would be applied to.

Fields

FieldTypeDescription
codeStringThe theme code that was asked about.
impactIterableOne entry per affected channel, each { channelId, channel, currentTheme, customizations }. Empty when nothing would be left behind.

Use cases

  • Confirmation dialog before switching — query with the channels the merchant ticked; an empty impact means the switch is uneventful and the dialog can be skipped.

Best practices

  • Query impact bare. It is a JSON value and takes no sub-selection.
  • A channel already on this theme is never listed, so an empty array is the normal answer when re-activating a theme a channel already runs.

Permissions

Requires appearance.themes.

Released under the MIT License.