Skip to content

Theme Impact

What activating a theme on the given channels would leave behind, so the change can be spelled out before anything is written. Reports only; nothing is modified.

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.

Endpoint

MethodPathPurpose
GET/api/admin/appearance/themes/{code}/impactReport the impact of activating a theme

Path parameters

ParameterDescription
codeTheme code being considered.

Query parameters

ParameterRequiredDescription
channel_ids[]YesChannels the theme would be applied to. Repeat for each channel.

Response fields

FieldTypeDescription
codestringThe theme code that was asked about.
impactarrayOne entry per affected channel. Empty when nothing would be left behind.
impact[].channelIdintegerChannel ID.
impact[].channelstringChannel name.
impact[].currentThemestring | nullName of the theme the channel runs today.
impact[].customizationsintegerSections the channel holds for that theme.

Use cases

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

Best practices

  • A channel already on this theme is never listed. impact counts only channels whose current theme differs, so an empty array is the normal answer when re-activating the theme a channel already runs.

Errors

StatusWhen
404No theme with this code.
422channel_ids missing, or naming a channel that does not exist.

Permissions

Requires appearance.themes.

Released under the MIT License.