Storefront style

Toolset storefront_style, 16 tools.

RecordsCopy Anchor Link

brandCopy Anchor Link

The store's brand that the theme, emails and share images draw from: logo, dark logo, icon, primary and accent colours, slogan and description per language, and social links. There is one record; pass any id, e.g. "current".

• Permission: settings.read
• Tools: brand_get

ActionsCopy Anchor Link

brand_updateCopy Anchor Link

Change the store's logo, icon, colours, slogan, description or social links; what is not given stays.

Writes over the version it read, so a brand someone saved in between is refused rather than overwritten; read brand_get again then.

• Action key: brand.update
• Permission: settings.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example inputs:

{
  "colors": {
    "accent": "#c2410c"
  }
}

{
  "slogan": {
    "hu": "Minden, ami játék"
  }
}

theme_banner_setCopy Anchor Link

Add or change an announcement bar or promo, discount or newsletter pop-up.

Add, change, schedule, switch off or delete one storefront banner: an announcement bar, a discount, newsletter or promo pop-up, a slide-in card, an age gate or a maintenance or coming-soon page. Pop-ups open immediately, after a delay, on scroll or on exit intent (trigger), on all or chosen pages, devices and audiences, between starts_at and ends_at. The cookie banner, language suggestion and newsletter pop-up overlay are platform pop-ups edited as sections, not here.

• Action key: theme_banner.set
• Permission: theme.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "template": "announcement",
  "name": "Free shipping",
  "content": {
    "heading": "Free shipping over 50 EUR"
  }
}

theme_base_locale_setCopy Anchor Link

Make another language the one the theme's base copy is written in.

Make locale the language the theme's base copy is written in, when the store's default language is not the theme's (overview base_locale). Text that language already has becomes the base; the old base moves to its own overlay; untranslated text keeps its old wording.

• Action key: theme_base_locale.set
• Permission: theme.write
• Approval: Always waits for a person to approve it.
• Effect: Changes a draft; nothing goes live until it is published.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "locale": "hu"
}

theme_color_scheme_setCopy Anchor Link

Add a named colour scheme or change one.

Change one named colour scheme (its colours or name) or add a new one. Every section, block and pop-up that picks the scheme through its color_scheme setting follows it; to recolour just one section, pick a scheme for it with theme_section_update instead. Answers with contrast warnings where text would read poorly.

• Action key: theme_color_scheme.set
• Permission: theme.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "name": "Dark",
  "colors": {
    "background": "#111111",
    "foreground": "#ffffff"
  }
}

theme_locale_keys_getCopy Anchor Link

The theme's locale-file texts for one language, by flat key.

Read flattened locale-file keys for a locale, optionally filtered by prefix.

• Action key: theme_locale_keys.get
• Permission: theme.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{
  "locale": "hu",
  "prefix": "cart"
}

theme_locale_keys_updateCopy Anchor Link

Merge entries into one language's locale file.

Merge locale-file entries for a locale.

• Action key: theme_locale_keys.update
• Permission: theme.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "locale": "hu",
  "entries": {
    "cart": {
      "title": "Kosár"
    }
  }
}

theme_og_image_getCopy Anchor Link

How the draft draws the share image of a page kind (the picture links show on social sites and chats), and what the merchant may change about it.

• Action key: theme_og_image.get
• Permission: theme.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{
  "kind": "product"
}

theme_og_image_previewCopy Anchor Link

Draw the draft's share image of a page kind with a real page's data, optionally with a design not saved yet. Nothing is stored.

• Action key: theme_og_image.preview
• Permission: theme.write
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{
  "kind": "product",
  "subject_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b"
}

theme_preset_applyCopy Anchor Link

Set every look setting of the draft to a preset's values.

Apply a design preset to the draft: every look setting takes the preset value, or the shipped default where the preset has none. Content settings and layouts stay. preset_id "default" restores the shipped look.

• Action key: theme_preset.apply
• Permission: theme.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "preset_id": "default"
}

theme_preset_listCopy Anchor Link

The theme's design presets with their swatches, and which is the current look.

List the theme's design presets: id, label, colour swatches and whether it is the current look. A preset sets the look settings (colours, fonts, shapes) in one step.

• Action key: theme_preset.list
• Permission: theme.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{}

theme_preview_getCopy Anchor Link

A preview link of the theme draft, or of the published theme.

Create a customizer preview and return its preview_url. The draft URL carries a signed token showing unpublished changes; the plain storefront keeps showing the published theme until theme_publish runs.

• Action key: theme_preview.get
• Permission: theme.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{}

theme_settings_getCopy Anchor Link

The theme's settings groups with their fields and current values.

Get settings groups, field defs, and current values. Pass group to narrow.

• Action key: theme_settings.get
• Permission: theme.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{
  "group": "colors"
}

theme_settings_translateCopy Anchor Link

AI-translate the theme-wide texts (menus, announcement bar, store name) into a language.

AI-translate the theme-wide text (menu labels, announcement bar, store name, other settings copy) from the base language into target_locale and save it. By default only text without a current translation; theme_translate covers a whole language including pages.

• Action key: theme_settings.translate
• Permission: theme.write and translation.use
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "target_locale": "de"
}

theme_settings_updateCopy Anchor Link

Merge theme settings by their flat dot paths into the draft.

Merge flat (dot-path) theme settings. Menus are arrays: use theme_menu_add_item or theme_menu_remove_item.

• Action key: theme_settings.update
• Permission: theme.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "flat": {
    "colors.accent": "#c2410c"
  }
}

theme_translateCopy Anchor Link

AI-translate the theme's texts and section copy from its base language into another.

AI-translate theme locale keys and section copy from the theme's base language (overview base_locale) into a target locale.

• Action key: theme.translate
• Permission: theme.write and translation.use
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.

Example input:

{
  "target_locale": "de"
}