Mergado MCP Server

This domain hosts the MCP (Model Context Protocol) server for Mergado. It provides a unified interface for AI assistants to access Mergado tools, product feeds, and data management capabilities.

Tato doména hostuje MCP (Model Context Protocol) server pro Mergado. Poskytuje jednotné rozhraní pro přístup AI asistentů k nástrojům Mergado, produktovým feedům a dalším funkcím platformy.

Contact supportKontaktovat podporu

Getting Started

Authentication

The Mergado MCP server requires authentication. There are two ways:

Sign in through your client (Recommended)

Some MCP clients (like ChatGPT or Claude) have sign-in built right into MCP. Just add the MCP server URL and the client redirects you to log in and authorize access to Mergado on its own - no token or manual setup needed.

Client registration is automatic. The client registers itself with the server on first connect - there's nothing to create or fill in by hand.

Bearer token

Clients that don't support signing in through MCP use a Personal Access Token (PAT). Add it to every request in the Authorization header:

Authorization: Bearer YOUR_TOKEN

You can create a PAT in your Mergado account: Personal Access Token ->

Server URL

The Mergado MCP server URL is: 

https://mcp.mergado.com

Client Setup

Select your MCP client to see the setup instructions.

ChatGPT supports remote MCP servers with built-in sign-in.

  1. Enable Developer mode in Settings -> Apps -> Advanced settings
  2. Go to Settings -> Apps -> Create app
  3. Paste the MCP server URL: https://mcp.mergado.com
  4. ChatGPT will handle authorization automatically - you'll be redirected to log in
  5. After authorizing, the server tools will be available in your conversations
Remote MCP servers in ChatGPT require a Plus, Pro, Business, Enterprise, or Edu plan with Developer mode enabled.

Claude.ai supports remote MCP servers with built-in sign-in.

  1. Open claude.ai -> Settings -> Connectors
  2. Click Add custom connector and paste the MCP server URL
  3. Claude will redirect you to log in and authorize
  4. Once connected, the server tools will appear in your conversations
Custom connectors are available on the Free, Pro, Max, Team, and Enterprise plans (Free is limited to one connector). On Team and Enterprise, only Owners can add a connector.

Claude Desktop supports remote MCP servers via its configuration file.

  1. Open Claude Desktop -> Settings -> Developer -> Edit Config
  2. Edit the file claude_desktop_config.json:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "mergado": {
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

If your Claude Desktop version doesn't support remote HTTP MCP servers directly, use the mcp-remote bridge via npx (requires Node.js):

{
  "mcpServers": {
    "mergado-npx": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.mergado.com",
        "--header",
        "Authorization: Bearer YOUR_TOKEN"
      ]
    }
  }
}
After saving, fully quit and relaunch Claude Desktop. Closing the window isn't enough - on Windows and macOS it keeps running in the system tray. Right-click the tray icon and choose Quit (or Cmd + Q on macOS) before launching again.

Add an MCP server using the claude mcp add command:

claude mcp add mergado \
  --transport http \
  https://mcp.mergado.com \
  --header "Authorization: Bearer YOUR_TOKEN"

Or add it to the .mcp.json file in your project root:

{
  "mcpServers": {
    "mergado": {
      "type": "http",
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Cursor supports remote MCP servers via its settings.

  1. Open Cursor -> Settings -> MCP
  2. Click Add new MCP server
  3. Select type HTTP and enter the server URL

Or add it to .cursor/mcp.json in your project:

{
  "mcpServers": {
    "mergado": {
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Windsurf supports MCP servers via its configuration file.

  1. Open Windsurf -> Settings -> search for MCP
  2. Click Add Server or edit ~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "mergado": {
      "serverUrl": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

VS Code supports MCP servers through GitHub Copilot's agent mode.

  1. Make sure you have the GitHub Copilot extension installed
  2. Create a .vscode/mcp.json file in your project
{
  "servers": {
    "mergado": {
      "type": "http",
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Alternatively, add it to your VS Code settings.json under the "mcp" key.

OpenWebUI supports MCP servers at two levels - globally for all users (admin), or per-user.

Admin-level (shared with all users)

  1. Open Admin Panel -> Settings -> External Tools
  2. Click Add Connection, then click OpenAPI (it should switch to MCP Streamable HTTP)
  3. Fill in URL, ID, and Name
  4. For Bearer token auth, enter Bearer YOUR_TOKEN in the API Key field
  5. For OAuth, switch from Bearer to OAuth 2.1 and click Register Client

User-level (personal tools)

  1. Click your profile icon (bottom-left) -> Settings -> External Tools
  2. Click Add Connection
  3. Fill in API Base URL with the MCP server URL
  4. Fill in the API Key field with your Personal Access Token (PAT)
The admin must enable User MCP Connections in Admin Panel -> Settings -> External Tools for user-level connections to work.

Any MCP-compatible client can connect to Mergado MCP servers. The servers use the HTTP Streaming transport (Streamable HTTP). To connect, your client needs:

  1. Server URL - e.g. https://mcp.mergado.com
  2. Transport - HTTP Streaming (Streamable HTTP, sometimes listed as http or streamable-http)
  3. Authentication - Authorization: Bearer YOUR_TOKEN header, or sign in through MCP if the client supports it

For a list of known MCP clients and their capabilities, see the official MCP client list.

MCP Inspector

MCP Inspector is a tool for testing MCP servers interactively from your browser - handy when you want to try the server out without setting up a client.

Prerequisites

How to use

  1. Run in your terminal: 
    npx @modelcontextprotocol/inspector
  2. The Inspector UI will open in your browser
  3. Set Transport Type to Streamable HTTP
  4. Enter https://mcp.mergado.com in the URL field
  5. For authentication, add an Authorization header with the value Bearer YOUR_TOKEN (your Personal Access Token)
  6. Click Connect

Official Inspector documentation ->

Jak se připojit

Autentizace

Mergado MCP server vyžaduje autentizaci. Existují dva způsoby:

Přihlášení přes klienta (doporučeno)

Někteří MCP klienti (např. ChatGPT nebo Claude) mají přihlášení zabudované přímo v MCP. Stačí zadat URL MCP serveru a klient vás sám přesměruje na přihlášení a autorizaci do Mergada - žádný token ani jeho ruční nastavení není potřeba.

Registrace klienta probíhá automaticky. Klient se k serveru zaregistruje sám při prvním připojení - nemusíte nic ručně vytvářet ani nikam vyplňovat.

Bearer token

Klienti, kteří přihlášení přes MCP nepodporují, použijí Personal Access Token (PAT). Přidejte jej do každého požadavku v hlavičce Authorization:

Authorization: Bearer YOUR_TOKEN

PAT vytvoříte v nastavení svého účtu Mergado: Osobní přístupový token ->

URL serveru

URL Mergado MCP serveru je: 

https://mcp.mergado.com

Nastavení klienta

Vyberte svého MCP klienta a zobrazte pokyny k nastavení.

ChatGPT podporuje vzdálené MCP servery se zabudovaným přihlášením.

  1. Zapněte Developer mode v Settings -> Apps -> Advanced settings
  2. Přejděte do Settings -> Apps -> Create app
  3. Vložte URL MCP serveru: https://mcp.mergado.com
  4. ChatGPT provede autorizaci automaticky - budete přesměrováni na přihlášení
  5. Po autorizaci budou nástroje serveru dostupné ve vašich konverzacích
Vzdálené MCP servery v ChatGPT vyžadují plán Plus, Pro, Business, Enterprise nebo Edu se zapnutým Developer mode.

Claude.ai podporuje vzdálené MCP servery se zabudovaným přihlášením.

  1. Otevřete claude.ai -> Settings -> Connectors
  2. Klikněte na Add custom connector a vložte URL MCP serveru
  3. Claude vás přesměruje na přihlášení a autorizaci
  4. Po připojení se nástroje serveru zobrazí ve vašich konverzacích
Vlastní konektory jsou dostupné v plánech Free, Pro, Max, Team a Enterprise (Free je omezen na jeden konektor). V plánech Team a Enterprise může konektor přidat pouze vlastník (Owner).

Claude Desktop podporuje vzdálené MCP servery přes konfigurační soubor.

  1. Otevřete Claude Desktop -> Settings -> Developer -> Edit Config
  2. Upravte soubor claude_desktop_config.json:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "mergado": {
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Pokud vaše verze Claude Desktop nepodporuje vzdálené HTTP MCP servery přímo, použijte mcp-remote bridge přes npx (vyžaduje Node.js):

{
  "mcpServers": {
    "mergado-npx": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.mergado.com",
        "--header",
        "Authorization: Bearer YOUR_TOKEN"
      ]
    }
  }
}
Po uložení Claude Desktop zcela ukončete a znovu spusťte. Zavření okna nestačí - na Windows a macOS běží na pozadí v systémové liště. Klikněte pravým tlačítkem na ikonu v liště a zvolte Quit (nebo Cmd + Q na macOS).

Přidejte MCP server příkazem claude mcp add:

claude mcp add mergado \
  --transport http \
  https://mcp.mergado.com \
  --header "Authorization: Bearer YOUR_TOKEN"

Nebo jej přidejte do souboru .mcp.json v kořenovém adresáři projektu:

{
  "mcpServers": {
    "mergado": {
      "type": "http",
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Cursor podporuje vzdálené MCP servery přes nastavení.

  1. Otevřete Cursor -> Settings -> MCP
  2. Klikněte na Add new MCP server
  3. Vyberte typ HTTP a zadejte URL serveru

Nebo jej přidejte do .cursor/mcp.json ve vašem projektu:

{
  "mcpServers": {
    "mergado": {
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Windsurf podporuje MCP servery přes konfigurační soubor.

  1. Otevřete Windsurf -> Settings -> vyhledejte MCP
  2. Klikněte na Add Server nebo upravte ~/.codeium/windsurf/mcp_config.json
{
  "mcpServers": {
    "mergado": {
      "serverUrl": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

VS Code podporuje MCP servery prostřednictvím agent módu GitHub Copilotu.

  1. Ujistěte se, že máte nainstalované rozšíření GitHub Copilot
  2. Vytvořte soubor .vscode/mcp.json ve svém projektu
{
  "servers": {
    "mergado": {
      "type": "http",
      "url": "https://mcp.mergado.com",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN"
      }
    }
  }
}

Případně jej přidejte do settings.json VS Code pod klíč "mcp".

OpenWebUI podporuje MCP servery na dvou úrovních - globálně pro všechny uživatele (admin), nebo pro jednotlivé uživatele.

Admin úroveň (sdíleno se všemi uživateli)

  1. Otevřete Admin Panel -> Settings -> External Tools
  2. Klikněte na Add Connection, pak na OpenAPI (přepne se na MCP Streamable HTTP)
  3. Vyplňte URL, ID a Name
  4. Pro Bearer token zadejte Bearer YOUR_TOKEN do pole API Key
  5. Pro OAuth přepněte z Bearer na OAuth 2.1 a klikněte na Register Client

Uživatelská úroveň (osobní nástroje)

  1. Klikněte na ikonu profilu (vlevo dole) -> Settings -> External Tools
  2. Klikněte na Add Connection
  3. Do pole API Base URL zadejte URL MCP serveru
  4. Do pole API Key zadejte váš Personal Access Token (PAT)
Admin musí povolit User MCP Connections v Admin Panel -> Settings -> External Tools, aby uživatelská připojení fungovala.

Jakýkoli MCP-kompatibilní klient se může připojit k Mergado MCP serverům. Servery používají transport HTTP Streaming (Streamable HTTP). Pro připojení váš klient potřebuje:

  1. URL serveru - např. https://mcp.mergado.com
  2. Transport - HTTP Streaming (Streamable HTTP, někdy označovaný jako http nebo streamable-http)
  3. Autentizace - hlavička Authorization: Bearer YOUR_TOKEN, případně přihlášení přes MCP, pokud ho klient podporuje

Seznam známých MCP klientů a jejich možností najdete na oficiálním seznamu MCP klientů.

MCP Inspector

MCP Inspector je nástroj pro interaktivní testování MCP serverů přímo z prohlížeče - hodí se, pokud si chcete server vyzkoušet bez nastavování klienta.

Požadavky

Jak používat

  1. Ve svém terminálu spusťte: 
    npx @modelcontextprotocol/inspector
  2. V prohlížeči se otevře rozhraní Inspectoru
  3. Jako Transport Type zvolte Streamable HTTP
  4. Do pole URL vložte https://mcp.mergado.com
  5. Pro autentizaci přidejte hlavičku Authorization s hodnotou Bearer YOUR_TOKEN (váš Personal Access Token)
  6. Klikněte na Connect

Oficiální dokumentace Inspectoru ->

Available toolsDostupné nástroje

106

Below is the full list of tools this MCP server provides to connected AI assistants. Select a tool to see what it does, its input parameters, and whether it only reads or also writes data.Níže je úplný seznam nástrojů, které tento MCP server poskytuje připojeným AI asistentům. Rozkliknutím nástroje zobrazíte, co dělá, jeho vstupní parametry a zda data pouze čte, nebo také zapisuje.

assign_query_to_rule Writes dataZapisuje data
Attaches an existing query to a rule, adding to its scope (the rule applies to the UNION of all attached queries). Use to scope a rule down after creating it, or to add another query. The query must already exist - create it first with `create_project_query`, then attach it here.
Input parametersVstupní parametry
  • query_id string requiredpovinné
    ID of existing query to assign. Query must exist or 400 is returned.
  • rule_id string requiredpovinné
    ID of the rule to assign query to
create_batch_copy_values_rule Writes dataZapisuje data
Create a 'Batch Copy Values' rule in a project. Copy the content of a source element into a target element for matching products. Multiple source -> target mappings can be specified in a single rule. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants to copy values from one element to another in bulk (also swaps via a temporary element).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"rows":[{"source_element_path":"g:title","target_element_path":"g:custom_label_0","position":0}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_batch_delivery_rule Writes dataZapisuje data
Create a 'Batch Delivery' rule in a project. Add delivery information (courier company, price, cash-on-delivery price) to products. Multiple delivery options can be specified in a single rule. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants shipping/delivery prices composed per carrier.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"rows":[{"type":"CESKA_POSTA","price":"99","price_cod":"129"}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_batch_param_rule Writes dataZapisuje data
Create a 'Batch Param' rule in a project. Add product parameters (name/value/unit triples) in bulk. This is used for shopping feed PARAM elements such as those on Heureka. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants product parameters added per query; the `ep_*` settings must be full nested element paths.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"settings":{"ep_param":"g:product_detail","ep_param_name":"g:product_detail | g:attribute_name","ep_param_value":"g:product_detail | g:attribute_value"},"rows":[{"queries":["<query_id>"],"params":[{"param_name":"Material","value":"Cotton"}]}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_batch_rewriting_rule Writes dataZapisuje data
Create a 'Batch Rewriting' rule in a project. Rewrite an element's content per query condition. Each row associates a query (filter) with the replacement value. Products matching the query receive the specified value. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants a different value written per query (per-product or per-segment writes in one rule).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"rows":[{"query_id":123456,"value":"New value","position":0}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_batch_rewriting_values_rule Writes dataZapisuje data
Create a 'Bulk Rewriting by Values' rule in a project. Looks up each product's value in a SOURCE element and, when it matches a row's input_value, writes the row's output_value into a DESTINATION element — a lookup/mapping table (e.g. map source categories to target names). CAUTION — the two element-path fields are counter-intuitive: the top-level `element_path` is the DESTINATION (written into), while `data.target_element_path` is the SOURCE (searched); swapping them silently writes into the wrong element. Provide this rule type's parameters in the typed `data` object. At least one query is required in `queries` (objects [{"id": "..."}]); use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants a lookup/mapping table (source value → output value).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"regex":false,"target_element_path":"CATEGORYTEXT","rows":[{"input_value":"Old","output_value":"New","position":0}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_batch_set_datetime_rule Writes dataZapisuje data
Create a 'Batch Set Datetime' rule in a project. Set a date element to today's date plus a configurable number of days, formatted using a strftime-style format string. Each row targets products matching the listed queries. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants a date (now + N days) written per query.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"date_format":"Y-m-d","rows":[{"query_ids":["<query_id>"],"number_of_days":7}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_bidding_rule Writes dataZapisuje data
Create a 'Bidding' rule in a project. Adjust a CPC element's value based on product price. Specify an absolute increment, a percentage factor, or both. At least one field must be non-null. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants CPC bidding values set.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"bidding_strategy":"pricePercentage","price_percentage":10}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_calc_rule Writes dataZapisuje data
Create a 'Calc' rule in a project. Evaluate a mathematical expression and write the result into an element. Supports the four basic arithmetic operations. Mergado variable expressions (e.g. `%PRICE_VAT%`) are resolved at runtime. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants a computed numeric value (margins, VAT, price adjustments).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"expression":"%PRICE_VAT% * 1.21","rounding_type":"mathematical"}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_casechanging_rule Writes dataZapisuje data
Create a 'Case Changing' rule in a project. Transform the capitalisation of text in an element. Supported modes: `lower`, `upper`, `sentence`, `word`, `firstletter`, `titlelongwords`. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants to change the letter case of a value.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"case_type":"lower"}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_categories_rule Writes dataZapisuje data
Create a 'Categories' rule in a project. Rename product categories by partial (or exact) match. Each row maps an input pattern to an output replacement. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants to bulk-rename categories into the format's category element (it ignores a custom `element_path`).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"rows":[{"input":"Shop > Shoes","output":"Apparel & Accessories > Shoes","position":0}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_create_product_value_rule Writes dataZapisuje data
Create an 'Add a Value to a Multi-Value Element' rule in a project. Appends a NEW value to an element that can hold multiple values (e.g. `g:additional_image_link`, categories, PARAM, alternative URLs) WITHOUT overwriting existing values — it writes to the next free position (equivalent to a Rewriting rule with element path `ELEMENT {@@POSITION = @@MAX_POSITION + 1}`). Use when the user wants to append an additional value to a multi-value element (e.g. add a second image or an extra category) without replacing what is already there. On an empty element it creates the first value; on an element that already has values it adds one more. Mergado variable expressions (e.g. `%element%`) are supported. Provide this rule type's parameters in the typed `data` object. At least one query is required in `queries` (objects `[{"id": "..."}]`); use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • data object optionalvolitelné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"value":"summer_2026"}`
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_data_import_rule Writes dataZapisuje data
Create a 'Data Import' rule in a project. Import product data from an external CSV or XML file (via URL) or from a previously uploaded file. The imported data is matched against products and applied as additional element values. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants to enrich products from an external CSV/XML file matched by a key (use a public source URL; base64 upload is a silent no-op).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"file_type":"csv","data_source_type":"url","source_url":"https://docs.example.com/data.csv","matching_mode":"exact"}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_element Writes dataZapisuje data
Creates a new element in a project. Use when adding an output element required by a target format (e.g. `g:gtin` for Google Shopping) that does not yet exist in the element tree. After creating it, use a rule (e.g. a `create_<type>_rule` tool) to fill it with values. Pass `parent_id` to nest it under an existing element (a child), or omit it for a top-level element.
Input parametersVstupní parametry
  • name string requiredpovinné
    Element name/tag (e.g. "CUSTOM_FIELD", "BRAND"). Must be valid XML tag name.
  • project_id string requiredpovinné
    ID of the project where element will be created
  • hidden boolean optionalvolitelné
    Whether the element is hidden from UI
  • parent_id string optionalvolitelné
    Optional ID of the parent element to nest this element under (creates a child element). Get the parent ID from `list_project_elements`. Omit to create a top-level element.
create_feedaudit Writes dataZapisuje data
Creates and starts a new feed audit for a project. KNOWN ISSUE: this endpoint currently fails (400 without `feed_url` despite the schema marking it optional; HTTP 500 with a valid one) — if it fails, do not retry blindly; direct the user to Product Data Audit in the Mergado UI and read EXISTING audits instead (`list_project_feedaudits` → `get_feedaudit` → `list_feedaudit_issues`). When functional, the audit runs asynchronously: poll `get_feedaudit` until `status` is `done`.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project to audit. Get it from `list_shop_projects`.
  • feed_types array optionalvolitelné
    Comparison-shopping formats to validate the feed against, e.g. ["heureka.cz", "zbozi.cz"]. Optional - the project default is used when omitted.
  • feed_url string optionalvolitelné
    Source feed URL to audit. Optional - defaults to the project feed URL.
  • parser_type string optionalvolitelné
    Input-feed parser type, e.g. "heureka.cz". Optional - auto-detected when omitted.
  • webhook_url string optionalvolitelné
    URL pinged once the audit finishes. Optional.
create_hiding_rule Writes dataZapisuje data
Create a 'Hiding' rule in a project. Hide (remove from output) all products that match the rule's queries. No additional data fields are required. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants to remove whole products from the output feed.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • data object optionalvolitelné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{}`
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_params_remove_by_value_rule Writes dataZapisuje data
Create a 'Params Remove By Value' rule in a project. Hide specific parameter values (or entire parameters) from the output. Each row specifies a parameter name and the list of values to remove. An empty `values` list removes all values for that parameter. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants specific parameter values removed from a PARAM-style structure.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"ep_param":"PARAM","ep_param_name":"PARAM_NAME","ep_param_value":"VAL","rows":[{"param_name":"Color","values":["Red"]}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_product_grouping_rule Writes dataZapisuje data
Create a 'Product Grouping' rule in a project. Group variant products together into a single product with multiple variants. Specify which elements identify products and groups, and define per-element MERGE or EXTRACT actions. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). This rule type does not require any queries. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants product variants merged (a whole-feed rule).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"product_key_element_path":"g:id","group_key_element_path":"g:item_group_id"}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
  • queries array optionalvolitelné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
create_project Writes dataZapisuje data
Creates a new project (output feed) inside an existing shop. A project fetches the source feed at `url`, transforms it via rules, and exports it in `output_format`. Only `name` and `url` are required, omit the optional fields to let Mergado auto-detect the input format and apply defaults. Get `shop_id` from `list_user_eshops` and discover valid format IDs via `list_supported_feed_formats`. The new project starts turned off, after creating it inspect it with `get_project` and add rules before enabling.
Input parametersVstupní parametry
  • name string requiredpovinné
    Project name. Max 100 characters, must be unique within the shop. Shown in the Mergado UI and helps identify the project purpose (e.g. "Google Shopping Feed", "Heureka Export").
  • shop_id string requiredpovinné
    ID of the shop (eshop) where this project will be created. Must be an existing shop ID from your account, get it from `list_user_eshops`.
  • url string requiredpovinné
    Source feed URL. Must use an http, https, or sftp scheme. This feed is fetched and transformed by Mergado (e.g. "https://example.com/products.xml").
  • autohide_new_products boolean optionalvolitelné
    Optional. When true, products newly appearing after a synchronisation are automatically hidden until reviewed. Defaults to false.
  • input_format string optionalvolitelné
    Optional. Format identifier of the input feed (e.g. "heureka.cz", "zbozi.cz", "google"). Native or custom. If omitted, Mergado attempts to auto-detect the format.
  • output_format string optionalvolitelné
    Optional. Desired output format for the transformed feed (e.g. "heureka.cz", "billiger.de", "google"). Native or custom. Discover valid IDs via `list_supported_feed_formats`.
  • pairing_elements string optionalvolitelné
    Optional. Element(s) used to pair (match) products across syncs, e.g. "URL". Leave unset to use the format default.
create_project_query Writes dataZapisuje data
Creates a standalone, reusable query in a project (a saved MQL product selection) that can be attached to one or more rules with `assign_query_to_rule`. Even a query used by a single rule is created here first, then attached via `assign_query_to_rule`. Use to define which products a rule should target, or to verify a hypothesis about the data (check the match via `list_project_products` with the same `mql`).
Input parametersVstupní parametry
  • name string requiredpovinné
    Descriptive name for the query (e.g. "Products under $10", "Items without images"). Helps identify query purpose.
  • project_id string requiredpovinné
    ID of the project where this query will be created
  • query string requiredpovinné
    Query expression using MQL (Mergado Query Language). Can filter, aggregate, or transform data (e.g. "PRICE < 10", "CATEGORY = Electronics").
  • read_only boolean optionalvolitelné
    Whether this query is read-only (cannot be modified)
  • search_output boolean optionalvolitelné
    True to query output data (after rules), False to query input data
create_remove_diacritics_rule Writes dataZapisuje data
Create a 'Remove Diacritics' rule in a project. Remove diacritical marks (accents) from the content of the targeted element. Useful for generating URL-safe or ASCII-only values (e.g. image URLs). No additional configuration is required. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants accents/diacritics removed from a value.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • data object optionalvolitelné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{}`
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_replacing_rule Writes dataZapisuje data
Create a 'Replacing' rule in a project. Find and replace content within element values. Supports plain text and regular expressions. Multiple search/replacement pairs can be specified in `rows`. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants find-and-replace inside values (plain text or regex with `\1` group references).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"regex":false,"case_sensitive":false,"rows":[{"search":"old","replacement":"new","position":0}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_rewriting_rule Writes dataZapisuje data
Create a 'Rewriting' rule in a project. Replace the content of one or more product elements with a new value. Mergado variable expressions (e.g. `%ITEM_ID%`) are supported in `new_content`. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants to overwrite an element's content (supports `%element%` references).
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"rows":[{"element_path":"g:title","new_content":"%MANUFACTURER% %g:title%"}]}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_rounding_rule Writes dataZapisuje data
Create a 'Rounding' rule in a project. Round a numeric element value to a fixed number of decimal places. The separators control how the formatted output looks. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants prices rounded. NOTE: this endpoint currently returns HTTP 500.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"rounding_type":"mathematical","decimal_places":0}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_shop Writes dataZapisuje data
Creates a new eshop (the top-level container that owns projects/feeds) for the current account. Only a `name` is required, Mergado trims it and converts it to title case. Use this during onboarding before creating any project, the returned `id` is the `shop_id` you pass to `create_project`. To configure the eshop's website or XML domain afterwards, use `update_shop`.
Input parametersVstupní parametry
  • name string requiredpovinné
    E-shop name. Max 100 characters. The value is trimmed and converted to title case by Mergado (e.g. "example.com").
create_tagstripping_rule Writes dataZapisuje data
Create a 'Tag Stripping' rule in a project. Remove all HTML tags from the content of the targeted element. No additional configuration is required. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants HTML tags stripped from a value.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • data object optionalvolitelné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{}`
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_truncating_rule Writes dataZapisuje data
Create a 'Truncating' rule in a project. Shorten the content of an element to a specified maximum length. The intelligent flag attempts to truncate at a word boundary. The *append* string (e.g. `...`) is appended after the truncated text. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants values shortened to a length limit.
Input parametersVstupní parametry
  • data object requiredpovinné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"max_length":150,"intelligent":true,"append":"…"}`
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_utm_rule Writes dataZapisuje data
Create a 'UTM Parameters' rule in a project. Append UTM tracking parameters to product URLs. Mergado variable expressions (e.g. `%ITEM_ID%`) are supported in all text fields. Provide this rule type's parameters in the typed `data` object (its fields are fixed by the schema). At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Mergado applies the rule automatically on the next rebuild — do not force recalculation. After creating, read the rule back with `get_rule` and verify its effect on a sample once the rebuild runs. Use when the user wants UTM tracking parameters appended to product URLs.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project the rule is created in. Obtain it from `list_shop_projects`.
  • queries array requiredpovinné
    Queries selecting which products the rule applies to, as a list of objects `[{"id": "<query_id>"}]` (NOT strings). At least one query is required for this rule type. To target every product, pass the system ♥ALLPRODUCTS♥ query whose ID is each project's `all_products_query_id` in `list_shop_projects`.
  • applies boolean optionalvolitelné
    Whether the rule is active (vs. paused).
  • data object optionalvolitelné
    Rule-type-specific configuration payload. Its fields are fixed by this rule type's schema (see the nested object's properties) the backend validates them authoritatively. Example: `{"utm_source":"mergado","utm_medium":"cpc","utm_campaign":"summer_2026"}`
  • element_path string optionalvolitelné
    Target element path must already exist in the project.
  • is_deletable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_editable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_movable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • is_pausable boolean optionalvolitelné
    System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
  • name string optionalvolitelné
    Human-readable rule name (max 100 chars).
  • placement object optionalvolitelné
    Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
  • priority string optionalvolitelné
    Numeric string controlling rule order (lower priority runs earlier). Required in practice: omitting it returns 400 "Failed to determine rule priority". Pass e.g. "100" to append at the end; use `list_project_rules` to see existing priorities.
create_variable Writes dataZapisuje data
Creates a variable in a project. Use for: (a) named constants used by multiple rules (shipping_cost, vat_rate), (b) regex extraction (define a regex once, reference it in rules), or (c) computed values. The variable name becomes the reference token in rules: `{name}`.
Input parametersVstupní parametry
  • element_path string requiredpovinné
    Element path from which the variable value is extracted (e.g. "ITEM | PRICE", "PARAM { NAME = 'color' } | VALUE")
  • name string requiredpovinné
    Variable name/identifier. Use clear, descriptive names (e.g. "shipping_cost", "vat_rate"). This will be referenced in rules and queries.
  • project_id string requiredpovinné
    ID of the project where this variable will be created and available for use
  • fragment_number integer optionalvolitelné
    Optional regex group/fragment number to extract (used with regular_expression)
  • regular_expression string optionalvolitelné
    Optional regex pattern to extract part of the element value
  • sample_text string optionalvolitelné
    Optional sample text for UI/testing purposes
delete_element Writes dataZapisuje data
Deletes an element AND all of its child elements. Any rules referencing this element will break. Get the user's explicit confirmation, especially for parent elements (e.g. PARAM, g:shipping). Check the `children` field from `list_project_elements` and list the affected children in the confirmation. Use only to remove an element you created (e.g. a helper element after a one-off import); ask the user before deleting anything else.
Input parametersVstupní parametry
  • id string requiredpovinné
    Element ID to delete. Get from `list_project_elements`. Deletes all child elements too.
delete_query Writes dataZapisuje data
Deletes a query. If the query is attached to a rule, that rule is left with one fewer scope query - or fails on the next apply if it was the only one (every rule must have at least one query). Check `list_rule_queries` for consumers first. System queries (`read_only=true`) cannot be deleted. Use to clean up queries you created; ask the user before deleting queries you did not create.
Input parametersVstupní parametry
  • id string requiredpovinné
    Query ID to delete. Get from `list_project_queries` or `list_rule_queries`. System queries (`read_only=true`) cannot be deleted.
delete_rule Writes dataZapisuje data
Deletes a rule and all of its rule-level queries (project-level queries persist). Products previously affected by this rule revert to their pre-rule values on the next rebuild. Get the user's explicit confirmation first, especially for high-priority rules (applied first) or `format_converter` rules (essential for output). Rules with `is_deletable=false` cannot be deleted. Use to remove a rule after user confirmation, or to replace one (there is no `update_rule` — delete + recreate).
Input parametersVstupní parametry
  • id string requiredpovinné
    Rule ID to delete. Get from `list_project_rules`. Rules with `is_deletable=false` (system rules) cannot be deleted.
delete_variable Writes dataZapisuje data
Deletes a variable. Rules referencing this variable will silently fail to expand the `{var_name}` token on the next rebuild - search rules for references first (`list_project_rules`). Use to clean up variables you created; ask the user before deleting others.
Input parametersVstupní parametry
  • id string requiredpovinné
    Variable ID to delete. Get from `list_project_variables`.
get_access_log Read-onlyPouze čtení
Returns details of a single access record. Returns 410 if the related project has been deleted (the log is preserved but the linked resource is gone). Use rarely - the `get_access_logs` listing is usually enough.
Input parametersVstupní parametry
  • log_id string requiredpovinné
    ID of the access log
get_access_logs Read-onlyPouze čtení
Returns the history of HTTP access to the project's output feed URL - which ad-channel crawlers (GMC, Heureka, ...) fetched the feed, when, and the response status. Use to verify ad channels are consuming the feed regularly.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project whose access logs to retrieve
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
get_app_by_name Read-onlyPouze čtení
Returns metadata of a specific app from the global catalog by its slug name (e.g. 'biddingfoxelements', 'feedimageeditor', 'mergadoaudit'). Use to look up an app's description, latest release date, or capabilities. For apps currently enabled by a user/shop/project, use `list_user_apps` / `list_shop_apps` / `list_project_apps`.
Input parametersVstupní parametry
  • name string requiredpovinné
    Name (ID) of the application
get_apply_log Read-onlyPouze čtení
Returns details of a single rule-application run. Use after `get_apply_logs` when you need granular per-rule diagnostics for a specific run.
Input parametersVstupní parametry
  • log_id string requiredpovinné
    ID of the apply log
get_apply_logs Read-onlyPouze čtení
Returns the history of rule-application runs for a project (timestamp, duration, item count, per-rule processed counts). 'Apply' transforms data internally, it does not publish to the output feed - that is 'rebuild'. Use for forensic "when were rules last applied" or to diagnose unexpected rule behavior.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project whose apply logs to retrieve
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
get_current_user Read-onlyPouze čtení
Returns the user account that the current OAuth token belongs to. Use this as the first call in any user-scoped workflow to confirm identity. Requires a user-bound ONLINE token (an OAuth token tied to a specific Mergado user, not a server-to-server token). If you get a 401 or a 'token scope not valid' error, ask the user to (re)authorize Mergado MCP.
Input parametersVstupní parametry

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.

get_element Read-onlyPouze čtení
Returns details of a single element (path, type, is_attribute, origin, hidden flag). Use to verify properties before an update or delete. Get the element ID from `list_project_elements`.
Input parametersVstupní parametry
  • id string requiredpovinné
    Element ID to fetch. Get from `list_project_elements`.
get_export_log Read-onlyPouze čtení
Returns details of a single output-feed export run. Use after `get_export_logs` to inspect a specific export.
Input parametersVstupní parametry
  • log_id string requiredpovinné
    ID of the export log
get_export_logs Read-onlyPouze čtení
Returns the history of output-feed exports for a project (= publishing applied data to the output feed file). Each entry has a timestamp, items exported, exported_product_group_count, and duration. Use to confirm the last successful publish and to diagnose stale outputs.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project whose export logs to retrieve
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
get_feedaudit Read-onlyPouze čtení
Returns a single feed audit: its status, progress, product count, timings, and any error. Use to poll a running audit to completion before listing its issues or products.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the feed audit. Get from `list_project_feedaudits`.
get_feedaudit_issue Read-onlyPouze čtení
Returns a single audit issue by ID, including the validator, verdict, severity, and validator-specific context (`info`). Use to inspect one issue surfaced by `list_feedaudit_issues`.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the audit issue. Get from `list_feedaudit_issues`.
get_feedaudit_product Read-onlyPouze čtení
Returns a single audited product with all its parsed elements (tag/value pairs). Use to inspect the exact feed content the audit saw for one product.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the audited product. Get from `list_feedaudit_products`.
get_format Read-onlyPouze čtení
Returns basic metadata about a feed format (name, country, source channels). For the full element specification (required/optional elements and their types), use `get_format_specification`. Use when you need the human-readable definition of a feed format (e.g. before creating a project or mapping elements).
Input parametersVstupní parametry
  • format_id string requiredpovinné
    Format ID (e.g. 'heureka.cz', 'zbozi.cz')
get_format_specification Read-onlyPouze čtení
Returns the full element specification of a format (required/optional elements and their types). For basic metadata only (name, country, source channels), use `get_format`. Use when you need the full element-level specification of a format, e.g. to find required elements a feed is missing.
Input parametersVstupní parametry
  • format_id string requiredpovinné
    Format ID (e.g. 'heureka.cz', 'zbozi.cz')
get_import_log Read-onlyPouze čtení
Returns details of a single input-feed import run, including the error message if it failed. Use after `get_import_logs` to dig into a specific failure - the error usually contains an HTTP status (404/500), a parse error line, or a timeout reason.
Input parametersVstupní parametry
  • log_id string requiredpovinné
    ID of the import log
get_import_logs Read-onlyPouze čtení
Returns the history of input-feed fetches for a project (items received vs processed, created/updated/removed, duration, status). Use to diagnose "the feed didn't download" or "where did the products go" by comparing items vs items_processed.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project whose import logs to retrieve
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
get_notification Read-onlyPouze čtení
Returns a single notification by ID. Use after `get_user_notifications` to read the full body of a specific notification. (tied to a specific user).
Input parametersVstupní parametry
  • id string requiredpovinné
    Notification ID to retrieve. Get it from `get_user_notifications`.
get_pairing Read-onlyPouze čtení
Returns details of a single pairing record - input item identifier, matched output item ID, and the matching elements used. Use after `list_pairings` to inspect a specific pairing.
Input parametersVstupní parametry
  • pairing_id string requiredpovinné
    ID of the pairing to retrieve
get_product Read-onlyPouze čtení
Returns a single product (input and output data) by its product ID. Get the ID from `list_project_products` or `query_products`. Use to inspect one product in full detail after finding it via `list_project_products` or `query_products`.
Input parametersVstupní parametry
  • id string requiredpovinné
    Product ID to retrieve. Get it from `list_project_products` or `query_products`.
get_project Read-onlyPouze čtení
Returns core project fields (URL, input/output formats, status, timestamps). The default `all_products_query_id` (needed when targeting every product in a rule) is available per project in the `list_shop_projects` listing.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID to fetch. Get from `list_shop_projects`.
get_project_app Read-onlyPouze čtení
Fetches subscription details (free_until, paid_until) for a project-level app. Use after `list_project_apps` to inspect a specific subscription.
Input parametersVstupní parametry
  • app_name string requiredpovinné
    Name (ID) of the application
  • project_id string requiredpovinné
    ID of the project
get_query Read-onlyPouze čtení
Returns details of a single query - its MQL expression, count of matching products, and `read_only` flag. Use to inspect a query before reusing it or before `update_query`. To get the actual products matching the query, use `query_products`.
Input parametersVstupní parametry
  • id string requiredpovinné
    Query ID to fetch. Get from `list_project_queries` or `list_rule_queries`.
get_rule Read-onlyPouze čtení
Returns details of a single rule instance - type, priority, `applies` (active), queries (scope), and the rule-type-specific `data` field. Use before `delete_rule`, or to read the current state before changing a rule. There is no update tool to change a rule, `delete_rule` it and recreate it with the matching `create_<type>_rule` tool.
Input parametersVstupní parametry
  • id string requiredpovinné
    Rule ID to fetch. Get from `list_project_rules`.
get_shop Read-onlyPouze čtení
Returns core shop fields (name, owner, tariff). For usage statistics and keychain (ad channel auth) connections, use `get_shop_info` instead. Use to confirm shop identity/tariff before working on its projects.
Input parametersVstupní parametry
  • id string requiredpovinné
    Shop ID to fetch. Get from `list_user_eshops`.
get_shop_app Read-onlyPouze čtení
Fetches subscription details (free_until, paid_until) for a shop-level app. Use after `list_shop_apps` to inspect a specific subscription.
Input parametersVstupní parametry
  • app_name string requiredpovinné
    Name (ID) of the application
  • shop_id string requiredpovinné
    ID of the shop
get_shop_event_logs Read-onlyPouze čtení
Retrieves the audit log of significant shop-level events tariff changes, project create/delete, user permission changes, payment events. Use for forensic "who changed what and when" questions. Get the shop ID from `list_user_eshops`.
Input parametersVstupní parametry
  • shop_id string requiredpovinné
    ID of the shop whose event logs to retrieve
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
get_shop_info Read-onlyPouze čtení
Returns enriched shop info usage statistics and keychain (ad channel auth) connections. Use for questions about ad channel integrations or shop utilization. For core fields (name, owner, tariff), use `get_shop` instead.
Input parametersVstupní parametry
  • id string requiredpovinné
    Shop ID whose info to retrieve. Get it from `list_user_eshops`.
get_stats_audit Read-onlyPouze čtení
Returns a single shop statistics audit: its date, status, product count, and a per-validator issue summary (ok/wrong/missing counts with item totals). The `id` is the composite `{m3shop_id}-{date_id}` (e.g. `1276-260625`) taken from `list_shop_stats_audits`. This is the stats-side audit, distinct from a project feed audit - use `get_feedaudit` for the latter. Use to read one stats audit found via `list_shop_stats_audits`.
Input parametersVstupní parametry
  • id string requiredpovinné
    Composite statistics-audit ID of the form `{m3shop_id}-{date_id}` (e.g. `1276-260625`). Get it from `list_shop_stats_audits`.
get_tariff Read-onlyPouze čtení
Returns details of a specific tariff (name, prices in all currencies, included limits). Use after identifying a `tariff_id` from `list_user_eshops` or `get_shop`.
Input parametersVstupní parametry
  • id string requiredpovinné
    Tariff ID to fetch. Get it from `list_available_tariffs`.
get_user Read-onlyPouze čtení
Returns details of a specific user by their ID. Use only for users that share an eshop with the current user (visible via `list_users`). For the current user's own identity, prefer `get_current_user`.
Input parametersVstupní parametry
  • id string requiredpovinné
    User ID to retrieve. Get it from `get_current_user` or `list_users`.
get_user_app Read-onlyPouze čtení
Fetches a specific user-level app subscription (free_until, paid_until). Use after `list_user_apps` to check the expiration of a specific app.
Input parametersVstupní parametry
  • app_name string requiredpovinné
    Name (ID) of the application
  • user_id string requiredpovinné
    ID of the user
get_user_custom_formats Read-onlyPouze čtení
Returns a user-defined ("custom") feed format. A custom format is a user-created alternative to Mergado's built-ins (heureka.cz, zbozi.cz, google.cz, ...). Its ID looks like `custom.cz.36562` and it can be used as an input or output format. Use when a project's `input_format` or `output_format` starts with `custom.*` and you need its specification.
Input parametersVstupní parametry
  • format_id string requiredpovinné
    Custom format ID to retrieve (e.g. 'custom.cz.36562'). Get it from a project's `input_format` / `output_format` when it starts with `custom.*`.
  • id string requiredpovinné
    User ID who owns the custom formats. Get it from `get_current_user`.
get_user_eshop_permissions Read-onlyPouze čtení
Returns the role (writer / admin / owner) a specific user has in a specific eshop. Use to check whether a user can perform an action on a shop before suggesting it. Returns 404 if no permission exists.
Input parametersVstupní parametry
  • shop_id string requiredpovinné
    ID of the shop
  • user_id string requiredpovinné
    ID of the user
get_user_notifications Read-onlyPouze čtení
Returns all notifications for a user (system messages, billing reminders, app updates). Use when the user asks whether they have anything new in their account, or to check whether a previously sent notification was delivered.
Input parametersVstupní parametry
  • user_id string requiredpovinné
    ID of the user whose notifications to retrieve
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
get_user_permissions Read-onlyPouze čtení
Lists a user's eshop access roles (writer / admin / owner) across all their shops. Use to answer "what can this user do" or to verify access before suggesting an action on a shop.
Input parametersVstupní parametry
  • id string requiredpovinné
    User ID whose permissions to retrieve. Get it from `get_current_user`.
get_user_project_permissions Read-onlyPouze čtení
Returns the role a specific user has in a specific project. Mostly inherits from the eshop permission - use only for projects with a permission override, otherwise `get_user_eshop_permissions` is sufficient. Use when an operation fails with 403 to check the user's role on the project.
Input parametersVstupní parametry
  • project_id string requiredpovinné
    ID of the project
  • user_id string requiredpovinné
    ID of the user
get_variable Read-onlyPouze čtení
Returns details of a variable - name, type, element path, regex. Get the variable ID from `list_project_variables`. Use to read a variable's definition (element path, regex, fragment) before referencing it as `%NAME%` in a rule.
Input parametersVstupní parametry
  • id string requiredpovinné
    Variable ID to fetch. Get from `list_project_variables`.
list_apps Read-onlyPouze čtení
Lists the global catalog of all Mergado apps available (Audit, FIE, Translator, Bidding Fox, Pricing Fox, ...). This is the CATALOG of available apps - to see apps currently enabled by a user / shop / project, use `list_user_apps` / `list_shop_apps` / `list_project_apps`. Use to look up the global app catalog, e.g. before checking whether a shop or project has an app installed.
Input parametersVstupní parametry
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_available_tariffs Read-onlyPouze čtení
Returns the catalog of all available Mergado tariffs with prices in CZK / EUR / PLN / GBP / USD. Tariffs are auto-assigned based on product count. Use when the user asks what a tariff costs or to explain an auto-upgrade.
Input parametersVstupní parametry
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_defined_rules Read-onlyPouze čtení
Lists the available rule-type definitions and the data fields each type accepts. Each type is also exposed as its own dedicated `create_<type>_rule` tool (generated from these definitions) use this to inspect the data shape a given rule type expects.
Input parametersVstupní parametry
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_feedaudit_issues Read-onlyPouze čtení
Lists all issues (failed/recommended validations) found by a feed audit - each with the validator, verdict, severity level, and the related product. This is the main "what's wrong with my feed" answer use it after an audit's `status` is `done`.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the feed audit whose issues to list. Get from `list_project_feedaudits`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_feedaudit_product_issues Read-onlyPouze čtení
Lists the issues found for a single audited product - the per-product slice of the audit's validations. Use to answer "what's wrong with this specific product" after `list_feedaudit_products`.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the audited product whose issues to list. Get from `list_feedaudit_products`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_feedaudit_products Read-onlyPouze čtení
Lists the products captured by a feed audit, each with its parsed elements (tag/value pairs as they appeared in the feed at audit time). Use to see exactly what the audit read for each product.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the feed audit whose products to list. Get from `list_project_feedaudits`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_pairings Read-onlyPouze čtení
Returns product pairings for a project. A 'pairing' is Mergado's internal identification of which input feed item corresponds to which output feed item across feed reloads, so that user-applied changes (hide/show, manual values) persist when the input feed is re-imported. The matching key elements are defined in the project's `pairing_elements` (typically ITEM_ID, EAN, PRODUCTNAME_EXACT, IMAGE). Use to inspect or troubleshoot product identity tracking across imports. Supports `limit`/`offset` pagination (handled automatically).
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose pairings to list. Get it from `list_shop_projects`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_project_apps Read-onlyPouze čtení
Lists Mergado apps enabled specifically for one project (e.g. Audit, FIE on this output). Project-level apps run only against this project. For shop-wide apps use `list_shop_apps`. Use when diagnosing behaviour that might come from an installed app on the project.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose installed apps to list. Get it from `list_shop_projects`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_project_elements Read-onlyPouze čtení
Lists all XML elements in a project (input + output) as a hierarchical tree. Each element has an `origin` (`input` / `from_rule` / `manual`) and a `hidden` flag (hidden = exists internally but not in the output XML). Use to plan rules - check whether a target element exists before creating a rule, or to discover what is available in the feed.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose elements to list. Get from `list_shop_projects`.
list_project_feedaudits Read-onlyPouze čtení
Lists feed audits run for a project (newest first), each with its status, progress, product count, and the comparison-shopping formats it validated against. Use to find an audit's ID before drilling into its issues or audited products, or to check whether an audit you started has finished (`status` / `progress`).
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose feed audits to list. Get from `list_shop_projects`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_project_products Read-onlyPouze čtení
Lists products in a project, with an optional MQL filter (e.g. `PRICE_VAT < 50`) sent in the request body via POST (so even long or hard-to-encode MQL works). Pass `values_to_extract` to return only specific elements per product. Note: MQL filtering works server-side, but ORDER BY / LIMIT are not supported server-side, so ranking ("10 most expensive") must be done by the caller. Supports `limit`/`offset` pagination (handled automatically, sent as query params). For products of an existing saved query, use `query_products` instead. Use to inspect real product data or count products matching an `mql` filter (read `total_results`); prefer `limit` — responses are large.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose products to list (named `id` here for legacy reasons; create/write tools call it `project_id`). Get it from `list_shop_projects`.
  • is_hidden boolean optionalvolitelné
    Filter by visibility: true=only hidden, false=only visible, null/omitted=all products
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • mql string optionalvolitelné
    Optional MQL query string to filter products (e.g. "PRICE > 100"). Can be used in GET or POST request body.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
  • values_to_extract array optionalvolitelné
    CURRENTLY NOT FUNCTIONAL: the server ignores this field and returns the full product tree (`extracted_values` comes back null). Do not rely on it — use `limit` to bound the response and filter fields client-side. (Kept for forward compatibility.)
list_project_queries Read-onlyPouze čtení
Lists all standalone queries in a project (project-level and rule-level). Each query has `query` (the MQL expression), `product_count`, and a `read_only` flag. System queries such as ♥ALLPRODUCTS♥ are included with `read_only=true`. Use before creating a query — an equivalent saved query may already exist; also to find query ids for rules.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose queries to list. Get from `list_shop_projects`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_project_rules Read-onlyPouze čtení
Lists all rules in a project, ordered by application priority (lower priority = applied first). Each rule has `type` (rewriting, hiding, replacing, format_converter, ...), `applies` (active), and attached `queries` (which products it targets). Use as the first step to inspect a project's rule chain before creating or deleting a rule.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose rules to list. Get from `list_shop_projects`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_project_variables Read-onlyPouze čtení
Lists all variables defined in a project. Variables are named, reusable values referenced from rules and other variables (e.g. `{shipping_cost}` in a rule expression). Use before `create_variable` to avoid duplicates.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID whose variables to list. Get from `list_shop_projects`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_rule_queries Read-onlyPouze čtení
Lists the queries attached to a specific rule (= the rule's scope). The rule applies to the union of these queries. Use before changing a rule's scope to see its current state.
Input parametersVstupní parametry
  • id string requiredpovinné
    Rule ID whose queries to list. Get from `list_project_rules`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_shop_apps Read-onlyPouze čtení
Lists Mergado apps enabled at the eshop level (cross-cutting all projects in the shop). Use to check Mergado Audit / Keychain availability. For project-level apps use `list_project_apps`, for user-level apps use `list_user_apps`.
Input parametersVstupní parametry
  • id string requiredpovinné
    Shop ID whose installed apps to list. Get it from `list_user_eshops`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_shop_projects Read-onlyPouze čtení
Returns all projects (input + output feeds) within a specific eshop. Each project has `input_format` and `output_format`, use this list to understand which feeds the eshop already has before suggesting new ones. (Mergado has no global "list all projects" endpoint, this per-shop listing is the way to enumerate projects.)
Input parametersVstupní parametry
  • id string requiredpovinné
    Shop ID whose projects to list. Get from `list_user_eshops`.
list_shop_stats_audits Read-onlyPouze čtení
Lists a shop's statistics audits (newest first), each with its date, status, and timings. This is the stats-side audit, distinct from a project feed audit - use `list_project_feedaudits` for the latter. Requires the `shop.stats.read` scope. Use when the user asks about stats audits of a shop. Note: currently returns empty even when audits exist in the UI — tell the user to check the Mergado UI.
Input parametersVstupní parametry
  • id string requiredpovinné
    ID of the shop whose statistics audits to list. Get from `list_user_eshops`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_stats_audit_issues Read-onlyPouze čtení
Lists the individual issues of a shop statistics audit, each with its validator, verdict, and affected item. The `id` is the composite `{m3shop_id}-{date_id}` (e.g. `1276-260625`) from `list_shop_stats_audits`. Optionally narrow or sort the result with `filter_by` / `order_by`. Use after `get_stats_audit` to drill from the per-validator summary into concrete failing items.
Input parametersVstupní parametry
  • id string requiredpovinné
    Composite statistics-audit ID of the form `{m3shop_id}-{date_id}` (e.g. `1276-260625`). Get it from `list_shop_stats_audits`.
  • filter_by string optionalvolitelné
    Optional filter expression applied to the returned issues.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
  • order_by string optionalvolitelné
    Optional sort expression applied to the returned issues.
list_supported_feed_formats Read-onlyPouze čtení
Lists all built-in feed formats supported by Mergado (input + output). Use during onboarding to discover what is possible - e.g. available Google Shopping country variants, Heureka SK vs CZ. The result is a `data` array of format IDs (e.g. "heureka.cz", "zbozi.cz"), pass one to `get_format` or `get_format_specification` for details.
Input parametersVstupní parametry

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.

list_unique_element_values Read-onlyPouze čtení
Returns the unique values (with counts) of an element. Set `is_output` to distinguish input (pre-rules) vs output (post-rules) values. Works for both simple and complex element paths. Use as the first step of any data analysis — real values of an element across products (e.g. categories, availability values) without reading whole products.
Input parametersVstupní parametry
  • element_path string requiredpovinné
    XPath to the element (e.g. "SHOP/SHOPITEM/PRICE")
  • project_id string requiredpovinné
    Project ID from which to retrieve values
  • is_output boolean optionalvolitelné
    True=output values (after rules), False=input values (before rules), null=output
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_user_apps Read-onlyPouze čtení
Lists Mergado apps enabled at the user level (not eshop / project level). Use when answering "what do I have paid for" or before suggesting features that depend on an app.
Input parametersVstupní parametry
  • id string requiredpovinné
    User ID whose installed apps to list. Get it from `get_current_user`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_user_eshops Read-onlyPouze čtení
Returns all eshops a user has access to, with their roles. Use as the second call after `get_current_user` to map the user's scope. Each eshop has `tariff_id`, `exported_items` useful for tariff/billing questions. (There is no global "list all shops" endpoint, for the current user this listing is the equivalent.)
Input parametersVstupní parametry
  • id string requiredpovinné
    User ID whose shops to retrieve. Get it from `get_current_user`.
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
list_users Read-onlyPouze čtení
Lists users that share at least one eshop with the authenticated user (= users you can collaborate with). Does NOT list all Mergado users globally. Use when resolving an e-mail or name mentioned by the user to a Mergado user ID.
Input parametersVstupní parametry
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
mark_project_products_dirty Writes dataZapisuje data
Marks products of a whole project as 'dirty' for rule reapplication on the next rebuild. NORMALLY NOT NEEDED: Mergado regenerates automatically — do not call this after creating rules or queries. Reserved for an explicit user request. Known issue: can time out (HTTP 599) on larger catalogs — prefer `mark_query_products_dirty` scoped by a query, or advise the user to run "Run processes manually" in the Mergado editor.
Input parametersVstupní parametry
  • is_dirty boolean requiredpovinné
    Set to true to mark all products (or filtered products) for rule reapplication
  • project_id string requiredpovinné
    ID of the project containing products
  • filter string optionalvolitelné
    Optional filter in format: [{"field": "id", "op": "in", "value": "[123, 124]"}]
mark_query_products_dirty Writes dataZapisuje data
Marks all products matching a query as 'dirty' for rule reapplication on the next rebuild. NORMALLY NOT NEEDED: Mergado regenerates and applies rules automatically in the background — do not call this after creating rules or queries. Reserved for an explicit user request to reprocess a specific product set. Lighter than `mark_project_products_dirty` (scoped by a query). Confirm the product count via `query_products` before calling.
Input parametersVstupní parametry
  • is_dirty boolean requiredpovinné
    Set to true to mark all matching products for rule reapplication
  • query_id string requiredpovinné
    ID of the query that selects products to update
query_products Read-onlyPouze čtení
Returns the products matching a saved query (by `query_id`). Use after `create_project_query` to fetch the matching set, or to count a query's scope before a bulk operation. For ad-hoc filters use `list_project_products` with the `mql` parameter directly. Pass `values_to_extract` to return only specific elements per product.
Input parametersVstupní parametry
  • query_id string requiredpovinné
    ID of the query to execute
  • is_hidden boolean optionalvolitelné
    Filter by visibility: true=only hidden, false=only visible, null=all
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
  • values_to_extract array optionalvolitelné
    CURRENTLY NOT FUNCTIONAL: the server ignores this field and returns the full product tree (`extracted_values` comes back null). Do not rely on it — use `limit` to bound the response and filter fields client-side. (Kept for forward compatibility.)
retract_query_from_rule Writes dataZapisuje data
Removes a query from a rule's scope (the query itself is NOT deleted - for that use `delete_query`). If this was the rule's last query, the next apply will fail because every rule must have at least one query. Use to swap the scope queries on an existing rule.
Input parametersVstupní parametry
  • query_id string requiredpovinné
    ID of query to unassign from the rule
  • rule_id string requiredpovinné
    ID of the rule to remove query from
show_maintenance_info Read-onlyPouze čtení
Returns scheduled maintenance windows for the Mergado platform (historical windows included - filter by the `from` timestamp). Use proactively when a user reports an unusual outage to check whether a maintenance window explains it.
Input parametersVstupní parametry
  • limit integer optionalvolitelné
    Pagination: maximum number of items to return in one response (Mergado default is 10). Combine with `offset` to page through large result sets.
  • offset integer optionalvolitelné
    Pagination: number of items to skip from the start of the result set (default 0). For the next page set offset to the previous offset plus limit the response's `total_results` tells you when to stop.
update_project Writes dataZapisuje data
Updates a project's flags. Currently only `is_dirty` is supported. NORMALLY NOT NEEDED: Mergado schedules rebuilds automatically — setting `is_dirty: true` manually is reserved for an explicit user request to force the next rebuild to reprocess the whole project. It does not run the rebuild immediately.
Input parametersVstupní parametry
  • id string requiredpovinné
    Project ID to update (named `id` here for legacy reasons; create/write tools call it `project_id`). Get it from `list_shop_projects`.
  • is_dirty boolean requiredpovinné
    Set to true to mark project as dirty, forcing all rules to be reapplied to all products during next rebuild. This is an expensive operation.
update_project_app Writes dataZapisuje data
Updates billing details (free_until, paid_until) of a project-level app subscription. Typically called by internal Mergado systems, NOT by end-user agents.
Input parametersVstupní parametry
  • app_name string requiredpovinné
    Name (ID) of the application
  • project_id string requiredpovinné
    ID of the project
  • free_until string optionalvolitelné
    Trial expiration date (ISO 8601 format)
  • paid_until string optionalvolitelné
    Paid subscription expiration date (ISO 8601 format)
update_query Writes dataZapisuje data
Updates a query's name or MQL expression. Changing the expression affects every rule using this query - they will apply to a different product set on the next rebuild. Check `list_rule_queries` / `list_project_queries` for consumers before updating a shared query.
Input parametersVstupní parametry
  • id string requiredpovinné
    Query ID to update (named `id` here for legacy reasons; other tools call it `query_id`). Get it from `list_project_queries`.
  • name string optionalvolitelné
    New name for the query
  • query string optionalvolitelné
    New MQL query expression replacing the existing one
update_shop Writes dataZapisuje data
Updates an eshop's display name or web URL. Limited scope does NOT change tariff, owner, or permissions. Use only when the user explicitly asks to rename their eshop or update its website link.
Input parametersVstupní parametry
  • id string requiredpovinné
    Shop ID to update. Get it from `list_user_eshops`.
  • name string optionalvolitelné
    New name for the shop
  • web string optionalvolitelné
    New website URL for the shop
  • xml_domain string optionalvolitelné
    XML domain for the shop
update_shop_app Writes dataZapisuje data
Updates billing details (free_until, paid_until) of a shop-level app subscription. Typically called by internal Mergado systems, NOT by end-user agents.
Input parametersVstupní parametry
  • app_name string requiredpovinné
    Name (ID) of the application
  • shop_id string requiredpovinné
    ID of the shop
  • free_until string optionalvolitelné
    Trial expiration date (ISO 8601 format)
  • paid_until string optionalvolitelné
    Paid subscription expiration date (ISO 8601 format)
update_user_app Writes dataZapisuje data
Updates billing details (free_until, paid_until) of a user-level app subscription. Typically called by internal Mergado systems, NOT by end-user agents. Avoid unless the user explicitly requests it and has admin scope.
Input parametersVstupní parametry
  • app_name string requiredpovinné
    Name (ID) of the application
  • user_id string requiredpovinné
    ID of the user
  • free_until string optionalvolitelné
    Trial expiration date (ISO 8601 format)
  • paid_until string optionalvolitelné
    Paid subscription expiration date (ISO 8601 format)
update_variable Writes dataZapisuje data
Updates a variable's name. Renaming may break rules that hardcode the old `{name}` token check `list_project_rules` and `list_project_queries` for references before renaming. (The API currently only supports updating the name field.)
Input parametersVstupní parametry
  • id string requiredpovinné
    Variable ID to update. Get it from `list_project_variables`.
  • name string optionalvolitelné
    New name for the variable. Will affect all references in rules and queries.