Mergado MCP Server

app_biddingfox_create_product_filter Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates a new product filter in the project. The filter gets the lowest priority and does not change bidding until a strategy uses it. Calling the tool twice creates a duplicate. Returns the current list of project filters.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

filters object requiredpovinnépovinnékötelező

Filter conditions, in the same format as returned by list_product_filters.
name string requiredpovinnépovinnékötelező

Filter name.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

success boolean alwaysvždyvždymindig

False when at least one of the filters could not be changed.
products_filters array of object alwaysvždyvždymindig

Current list of project filters ordered by priority.
products_filters[].id integer alwaysvždyvždymindig
products_filters[].name string alwaysvždyvždymindig
products_filters[].filters object | array

Filter conditions.
products_filters[].priority integer
products_filters[].created_at string
products_filters[].project_id integer alwaysvždyvždymindig
products_filters[].updated_at string
products_filters[].products_count integer

Number of matching products at products_count_updated_at.
products_filters[].products_count_updated_at string

app_biddingfox_create_product_tag Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates a new product tag in the project. Returns the current list of tags.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

background string requiredpovinnépovinnékötelező

Tag background colour as a hex value including the hash, e.g. "#ff0000".
color string requiredpovinnépovinnékötelező

Tag text colour as a hex value including the hash, e.g. "#ffffff".
name string requiredpovinnépovinnékötelező

Tag name.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

tags array of object alwaysvždyvždymindig

Current list of project tags, newest first.
tags[].id integer alwaysvždyvždymindig
tags[].name string alwaysvždyvždymindig
tags[].color string

Text colour, hex.
tags[].background string

Background colour, hex.
tags[].created_at string
tags[].project_id integer
tags[].updated_at string
status boolean alwaysvždyvždymindig

True when the tag was created.

app_biddingfox_create_strategies Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates new bidding strategies in the project. Each new strategy gets the lowest priority and is active immediately (inactive when start_at is set), so it starts changing CPC on the next bidding run. Calling the tool twice creates duplicates. Check the data with validate_strategies first. Returns the per-item result, the created strategies and all project strategies.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
settings array requiredpovinnépovinnékötelező

Array of new strategies to create.

OutputVýstupVýstupKimenet

status enum alwaysvždyvždymindig

success = all items succeeded, warning = some failed, error = all failed.
created array of object

Newly created strategies.
results object | array alwaysvždyvždymindig

Per-item result (true = succeeded), keyed by strategy ID or by the index of the request item.
settings array of object alwaysvždyvždymindig

Current list of all project strategies after the change, including the statistics returned by list_strategies.
settings[].id integer alwaysvždyvždymindig

Strategy ID.
settings[].pno number | string

Target PNO in percent.
settings[].name string alwaysvždyvždymindig
settings[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
settings[].is_test boolean
settings[].max_cpc number | string
settings[].min_cpc number | string
settings[].queries array

Mergado query IDs the strategy applies to.
settings[].stop_at string
settings[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
settings[].start_at string
settings[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
settings[].with_vat integer | boolean
settings[].vat_value integer
settings[].created_at string
settings[].project_id integer alwaysvždyvždymindig
settings[].updated_at string
settings[].cron_enable string
settings[].initial_cpc number | string
settings[].price_ratio number | string
settings[].cron_disable string
settings[].target_positions array
settings[].max_cpc_search_ratio number | string
settings[].max_cpc_percent_price number | string

app_biddingfox_delete_product_filters Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently deletes the given product filters of the project. Strategies that use a deleted filter stop applying to its products. This cannot be undone from the MCP. Returns success=false when some filter could not be deleted, and the remaining project filters.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

filter_ids array requiredpovinnépovinnékötelező

IDs of the filters to delete. Get them from the list_product_filters tool.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

success boolean alwaysvždyvždymindig

False when at least one of the filters could not be changed.
products_filters array of object alwaysvždyvždymindig

Current list of project filters ordered by priority.
products_filters[].id integer alwaysvždyvždymindig
products_filters[].name string alwaysvždyvždymindig
products_filters[].filters object | array

Filter conditions.
products_filters[].priority integer
products_filters[].created_at string
products_filters[].project_id integer alwaysvždyvždymindig
products_filters[].updated_at string
products_filters[].products_count integer

Number of matching products at products_count_updated_at.
products_filters[].products_count_updated_at string

app_biddingfox_delete_strategies Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently deletes the given bidding strategies of the project. The products they controlled stop being bidded by them. This cannot be undone from the MCP. Returns the per-strategy result and the remaining strategies.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

ids array requiredpovinnépovinnékötelező

IDs of the strategies. Get them from the list_strategies tool.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

status enum alwaysvždyvždymindig

success = all items succeeded, warning = some failed, error = all failed.
results object | array alwaysvždyvždymindig

Per-item result (true = succeeded), keyed by strategy ID or by the index of the request item.
settings array of object alwaysvždyvždymindig

Current list of all project strategies after the change, including the statistics returned by list_strategies.
settings[].id integer alwaysvždyvždymindig

Strategy ID.
settings[].pno number | string

Target PNO in percent.
settings[].name string alwaysvždyvždymindig
settings[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
settings[].is_test boolean
settings[].max_cpc number | string
settings[].min_cpc number | string
settings[].queries array

Mergado query IDs the strategy applies to.
settings[].stop_at string
settings[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
settings[].start_at string
settings[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
settings[].with_vat integer | boolean
settings[].vat_value integer
settings[].created_at string
settings[].project_id integer alwaysvždyvždymindig
settings[].updated_at string
settings[].cron_enable string
settings[].initial_cpc number | string
settings[].price_ratio number | string
settings[].cron_disable string
settings[].target_positions array
settings[].max_cpc_search_ratio number | string
settings[].max_cpc_percent_price number | string

app_biddingfox_get_project_overview Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns a project overview of the chosen type: "metrics" (metrics over time), "analytics" (analytics data and landing pages) or "diagnostics" (problem diagnostics).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
type string requiredpovinnépovinnékötelező

Overview type: "metrics", "analytics" or "diagnostics".
date_from string optionalvolitelnévoliteľnéválasztható

Only for type=metrics. Start of the period in YYYY-MM-DD format, defaults to 30 days ago.
date_to string optionalvolitelnévoliteľnéválasztható

Only for type=metrics. End of the period in YYYY-MM-DD format, defaults to today.
filters object optionalvolitelnévoliteľnéválasztható

Only for type=analytics and type=diagnostics. Filters for the metrics calculation, e.g. {"settings": [12, 34]} to limit it to specific strategies.
source string optionalvolitelnévoliteľnéválasztható

Only for type=metrics. "project" (default) for project-level metrics, "settings" for metrics broken down by individual strategies.

OutputVýstupVýstupKimenet

date string

type=analytics and type=diagnostics: date the data belongs to.
source string

type=metrics: project or settings.
current object

type=metrics: values of the newest day plus period totals (*_sum) and daily averages (*_avg).
date_to string

type=metrics: end of the period.
filters object | array

type=analytics: applied filters.
history object | array

type=metrics: daily values keyed by date, newest first.
date_from string

type=metrics: start of the period.
landing_pages object | array

type=analytics: landing pages from GA4.
out_of_target object

type=diagnostics: products out of the target position by strategy type.
products_total integer

type=diagnostics: number of products.
max_cpc_reached object

type=diagnostics: products that hit max CPC (in_bidding, out_of_bidding).
mergado_queries object

type=diagnostics: links to Mergado queries with the problematic products.
products_paired integer

type=diagnostics: number of products paired with the engine.
landing_pages_ga4 object | array

type=analytics: landing pages from GA4.

app_biddingfox_get_project_settings Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the project configuration - data sources, report setup, credit limits and other options. This is not the list of bidding strategies, that one is returned by list_strategies.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

id integer alwaysvždyvždymindig
created_at string
project_id integer alwaysvždyvždymindig
updated_at string
default_vat integer
zbozi_token string

Hidden, only indicates whether a token is set.
costs_source string

analytics, heureka-conversion, zbozi-stats or ga4.
sales_source string

analytics, heureka-conversion, zbozi-stats or ga4.
clicks_source string

analytics, heureka-conversion, zbozi-stats or ga4.
reports_emails array
heureka_conversion_token string

Hidden, only indicates whether a token is set.

app_biddingfox_get_project_settings_history Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the change history of the project configuration including the record count. The newest record is the current configuration. This is not the history of a bidding strategy, that one is returned by get_setting_history.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

data array of object alwaysvždyvždymindig

Versions of the project configuration, the newest record is the current configuration.
data[].id integer alwaysvždyvždymindig
data[].created_at string
data[].project_id integer alwaysvždyvždymindig
data[].updated_at string
data[].default_vat integer
data[].zbozi_token string

Hidden, only indicates whether a token is set.
data[].costs_source string

analytics, heureka-conversion, zbozi-stats or ga4.
data[].sales_source string

analytics, heureka-conversion, zbozi-stats or ga4.
data[].clicks_source string

analytics, heureka-conversion, zbozi-stats or ga4.
data[].reports_emails array
data[].heureka_conversion_token string

Hidden, only indicates whether a token is set.
count integer alwaysvždyvždymindig

Number of records.

app_biddingfox_get_report Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the project performance report for a given period. Use page to fetch a single section (1 = summary metrics, 2 = strategies, 3 = best and worst products); without page it returns all sections at once. Supplying date_from_compare and date_to_compare adds a second period for comparison.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
date_from string optionalvolitelnévoliteľnéválasztható

Start of the period in YYYY-MM-DD format. Defaults to 30 days ago.
date_from_compare string optionalvolitelnévoliteľnéválasztható

Start of the comparison period in YYYY-MM-DD format. Must be supplied together with date_to_compare.
date_to string optionalvolitelnévoliteľnéválasztható

End of the period in YYYY-MM-DD format. Defaults to today.
date_to_compare string optionalvolitelnévoliteľnéválasztható

End of the comparison period in YYYY-MM-DD format. Must be supplied together with date_from_compare.
page integer optionalvolitelnévoliteľnéválasztható

Report section: 1 = summary metrics, 2 = strategies, 3 = best and worst products. Omit to get all sections.

OutputVýstupVýstupKimenet

data object alwaysvždyvždymindig

Report sections for the period.
logo string

Always omitted, only indicates whether a logo is set.
date_to string alwaysvždyvždymindig
date_from string alwaysvždyvždymindig
project_id string | integer alwaysvždyvždymindig
data_compare object alwaysvždyvždymindig

Report sections for the comparison period, null without comparison dates.
date_to_compare string alwaysvždyvždymindig
date_from_compare string alwaysvždyvždymindig

app_biddingfox_get_setting_history Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the change history of a single bidding strategy including the record count.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
settings_id integer requiredpovinnépovinnékötelező

ID of the strategy whose history to return. Obtain it from the list_strategies tool.

OutputVýstupVýstupKimenet

data array of object alwaysvždyvždymindig

Versions of the strategy, each change creates a new record.
data[].id integer alwaysvždyvždymindig

Strategy ID.
data[].pno number | string

Target PNO in percent.
data[].name string alwaysvždyvždymindig
data[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
data[].is_test boolean
data[].max_cpc number | string
data[].min_cpc number | string
data[].queries array

Mergado query IDs the strategy applies to.
data[].stop_at string
data[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
data[].start_at string
data[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
data[].with_vat integer | boolean
data[].vat_value integer
data[].created_at string
data[].project_id integer alwaysvždyvždymindig
data[].updated_at string
data[].cron_enable string
data[].initial_cpc number | string
data[].price_ratio number | string
data[].cron_disable string
data[].target_positions array
data[].max_cpc_search_ratio number | string
data[].max_cpc_percent_price number | string
count integer alwaysvždyvždymindig

Number of records.

app_biddingfox_get_setting_metrics_history Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the daily metrics history of a single strategy including period totals. Without a period it returns the last 30 days. For a quick overview use last_only=true, which returns only the totals and the last day instead of every day.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
settings_id integer requiredpovinnépovinnékötelező

Strategy ID. Obtain it from the list_strategies tool.
date_from string optionalvolitelnévoliteľnéválasztható

Start of the period in YYYY-MM-DD format. Defaults to 30 days ago.
date_to string optionalvolitelnévoliteľnéválasztható

End of the period in YYYY-MM-DD format. Defaults to today.
last_only boolean optionalvolitelnévoliteľnéválasztható

Return only the period totals and the last day instead of every day. Defaults to false.

OutputVýstupVýstupKimenet

sum object alwaysvždyvždymindig

Totals for the period, e.g. heureka_clicks_sum, heureka_cost_sum, pno. Without last_only the remaining top-level keys are dates with the metrics of that day.
last object | array

Only with last_only=true: metrics of the last day, [] when there are none.

app_biddingfox_list_competitors Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the competitors of the project on Heureka or Zbozi.cz including top producers and categories. Paginated by 10 items.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

engine string requiredpovinnépovinnékötelező

Comparison engine: "heureka" or "zbozi".
project_id string requiredpovinnépovinnékötelező

Project ID.
page integer optionalvolitelnévoliteľnéválasztható

Page number, defaults to 1.
sort object optionalvolitelnévoliteľnéválasztható

Result ordering. Defaults to {"column": "", "direction": "desc"}.
watched_only boolean optionalvolitelnévoliteľnéválasztható

Return only watched competitors.

OutputVýstupVýstupKimenet

data object alwaysvždyvždymindig
data.total_hits integer

Total number of competitors.
data.competitors array of object

Competitors on the current page.
data.top_producers array

Top producers.
data.top_categories array

Top categories.
meta object
meta.watched_competitors object | array

Watched competitors keyed by their slug or shop ID.
page integer

app_biddingfox_list_events Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the project events, newest first. Paginated by 10 items.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
annotations_only boolean optionalvolitelnévoliteľnéválasztható

Return only events that have an annotation.
page integer optionalvolitelnévoliteľnéválasztható

Page number, defaults to 1.
search string optionalvolitelnévoliteľnéválasztható

Text to search for in the event name or body.
type string optionalvolitelnévoliteľnéválasztható

Event type filter. Multiple types can be separated by a pipe, e.g. "apply|settings_changed".

OutputVýstupVýstupKimenet

to integer
data array of object alwaysvždyvždymindig

Events on the current page, newest first.
data[].id integer alwaysvždyvždymindig
data[].name string
data[].text string
data[].type string
data[].sender string
data[].isUnread boolean
data[].origin_id string
data[].created_at string
data[].project_id integer alwaysvždyvždymindig
data[].origin_type string

Event category, e.g. apply or settings_changed.
data[].annotation_text string
from integer
total integer alwaysvždyvždymindig

Total number of items across all pages.
filters object | array

Applied filters.
per_page integer alwaysvždyvždymindig
last_page integer alwaysvždyvždymindig
current_page integer alwaysvždyvždymindig
next_page_url string
prev_page_url string

app_biddingfox_list_exports Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the exports of the project. By default it returns generated exports; with scheduled=true it returns scheduled exports. Bidding Fox export = a CSV/XLSX report by e-mail or fixed URL. Not the Mergado output feed (core get_export_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
scheduled boolean optionalvolitelnévoliteľnéválasztható

True returns scheduled exports instead of generated ones. Defaults to false.

OutputVýstupVýstupKimenet

exports array of object alwaysvždyvždymindig

Exports of the project.
exports[].id string | integer alwaysvždyvždymindig

Export ID.
exports[].name string
exports[].status string

created, queued, generating, done, deleted or failed.
exports[].periodic boolean

True when the export runs on a schedule.
exports[].schedule string

Cron expression of a scheduled export.
exports[].public_url string
exports[].download_url string
exports[].email_notificator object

E-mail notification settings.

app_biddingfox_list_product_filters Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the saved product filters of the project ordered by priority. The app's own saved filters — a different object from a Mergado query (core list_project_queries), with different ids.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

filters array of object alwaysvždyvždymindig

Product filters ordered by priority.
filters[].id integer alwaysvždyvždymindig
filters[].name string alwaysvždyvždymindig
filters[].filters object | array

Filter conditions.
filters[].priority integer
filters[].created_at string
filters[].project_id integer alwaysvždyvždymindig
filters[].updated_at string
filters[].products_count integer

Number of matching products at products_count_updated_at.
filters[].products_count_updated_at string

app_biddingfox_list_product_tags Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the product tags of the project, newest first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

tags array of object alwaysvždyvždymindig

Product tags, newest first.
tags[].id integer alwaysvždyvždymindig
tags[].name string alwaysvždyvždymindig
tags[].color string

Text colour, hex.
tags[].background string

Background colour, hex.
tags[].created_at string
tags[].project_id integer
tags[].updated_at string

app_biddingfox_list_products Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the products of the project with their statistics. Paginated by 20 items.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
date_from string optionalvolitelnévoliteľnéválasztható

Start of the statistics period in YYYY-MM-DD format. Defaults to 7 days ago.
date_to string optionalvolitelnévoliteľnéválasztható

End of the statistics period in YYYY-MM-DD format. Defaults to today.
page integer optionalvolitelnévoliteľnéválasztható

Page number, defaults to 1.

OutputVýstupVýstupKimenet

to integer
data array of object alwaysvždyvždymindig

Products on the current page.
data[].id string | integer alwaysvždyvždymindig

Product ID, use it as product_id in get_product.
data[].cpc number | string

Current cost per click.
data[].pno number | string
data[].url string
data[].name string
data[].item_id number | string

Item ID from the shop feed.
data[].price_vat number | string

Price including VAT.
data[].settings_id number | string

ID of the strategy that bids the product.
data[].shops_count number | string
data[].manufacturer string
data[].settings_name string
data[].price_position number | string

Position by price.
data[].bidded_position number | string

Current position in the bidding.
from integer
meta object | array

Aggregations over all matching products.
total integer alwaysvždyvždymindig

Total number of items across all pages.
filters object | array

Applied filter.
per_page integer alwaysvždyvždymindig
last_page integer alwaysvždyvždymindig
current_page integer alwaysvždyvždymindig
next_page_url string
prev_page_url string
stats_date_to string alwaysvždyvždymindig

End of the statistics period.
stats_date_from string alwaysvždyvždymindig

Start of the statistics period.

app_biddingfox_list_setting_metrics Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the daily metrics of all active strategies of the project. Without a period it returns the last 30 days.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
date_from string optionalvolitelnévoliteľnéválasztható

Start of the period in YYYY-MM-DD format. Defaults to 30 days ago.
date_to string optionalvolitelnévoliteľnéválasztható

End of the period in YYYY-MM-DD format. Defaults to today.

OutputVýstupVýstupKimenet

date_to string alwaysvždyvždymindig
metrics object | array alwaysvždyvždymindig

Metrics keyed by strategy ID. Each value has settings_name ("<priority>. <name>") and history - daily metrics keyed by date ([] when there are none).
date_from string alwaysvždyvždymindig

app_biddingfox_list_strategies Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Lists all bidding strategies of the project. PAID, per project. Only when CPC must follow live auction POSITIONS; CPC from the product price is the free create_bidding_rule. "Settings" here means bidding STRATEGIES.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array of object alwaysvždyvždymindig

Strategies ordered by priority.
data[].id integer alwaysvždyvždymindig

Strategy ID.
data[].pno number | string

Target PNO in percent.
data[].name string alwaysvždyvždymindig
data[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
data[].avg_cpc number
data[].budgets array of object
data[].filters array of integer

Product filter IDs.
data[].is_test boolean
data[].max_cpc number | string
data[].metrics object

Strategy metrics for the period.
data[].metrics.sum object

Totals for the period.
data[].metrics.last object | array

Metrics of the last day, [] when there are none.
data[].min_cpc number | string
data[].pno_sum number
data[].queries array

Mergado query IDs the strategy applies to.
data[].stop_at string
data[].apply_to string alwaysvždyvždymindig

all, filters or queries.
data[].cost_sum number
data[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
data[].start_at string
data[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
data[].with_vat integer | boolean
data[].sales_sum number
data[].vat_value integer
data[].clicks_sum number
data[].created_at string
data[].orders_sum number
data[].project_id integer alwaysvždyvždymindig
data[].updated_at string
data[].cron_enable string
data[].initial_cpc number | string
data[].price_ratio number | string
data[].cron_disable string
data[].conversion_sum number
data[].products_total number
data[].target_positions array
data[].is_on_all_products boolean
data[].max_cpc_search_ratio number | string
data[].max_cpc_percent_price number | string
date_to string

End of the statistics period, null = today.
date_from string

Start of the statistics period, null = last 30 days.

app_biddingfox_pause_strategies Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Pauses the given bidding strategies of the project (sets them inactive). A paused strategy keeps its configuration but stops changing CPC until it is started again with start_strategies. Returns the per-strategy result and the current strategies.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

ids array requiredpovinnépovinnékötelező

IDs of the strategies. Get them from the list_strategies tool.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

status enum alwaysvždyvždymindig

success = all items succeeded, warning = some failed, error = all failed.
results object | array alwaysvždyvždymindig

Per-item result (true = succeeded), keyed by strategy ID or by the index of the request item.
settings array of object alwaysvždyvždymindig

Current list of all project strategies after the change, including the statistics returned by list_strategies.
settings[].id integer alwaysvždyvždymindig

Strategy ID.
settings[].pno number | string

Target PNO in percent.
settings[].name string alwaysvždyvždymindig
settings[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
settings[].is_test boolean
settings[].max_cpc number | string
settings[].min_cpc number | string
settings[].queries array

Mergado query IDs the strategy applies to.
settings[].stop_at string
settings[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
settings[].start_at string
settings[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
settings[].with_vat integer | boolean
settings[].vat_value integer
settings[].created_at string
settings[].project_id integer alwaysvždyvždymindig
settings[].updated_at string
settings[].cron_enable string
settings[].initial_cpc number | string
settings[].price_ratio number | string
settings[].cron_disable string
settings[].target_positions array
settings[].max_cpc_search_ratio number | string
settings[].max_cpc_percent_price number | string

app_biddingfox_reorder_strategies Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Changes the priority of the bidding strategies of the project. The order of ids becomes the new priority: the first ID gets priority 1 (evaluated first). Send all strategy IDs of the project in the wanted order. Returns the per-strategy result and the current strategies.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

ids array requiredpovinnépovinnékötelező

All strategy IDs of the project in the wanted order. The first ID gets priority 1.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

status enum alwaysvždyvždymindig

success = all items succeeded, warning = some failed, error = all failed.
results object | array alwaysvždyvždymindig

Per-item result (true = succeeded), keyed by strategy ID or by the index of the request item.
settings array of object alwaysvždyvždymindig

Current list of all project strategies after the change, including the statistics returned by list_strategies.
settings[].id integer alwaysvždyvždymindig

Strategy ID.
settings[].pno number | string

Target PNO in percent.
settings[].name string alwaysvždyvždymindig
settings[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
settings[].is_test boolean
settings[].max_cpc number | string
settings[].min_cpc number | string
settings[].queries array

Mergado query IDs the strategy applies to.
settings[].stop_at string
settings[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
settings[].start_at string
settings[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
settings[].with_vat integer | boolean
settings[].vat_value integer
settings[].created_at string
settings[].project_id integer alwaysvždyvždymindig
settings[].updated_at string
settings[].cron_enable string
settings[].initial_cpc number | string
settings[].price_ratio number | string
settings[].cron_disable string
settings[].target_positions array
settings[].max_cpc_search_ratio number | string
settings[].max_cpc_percent_price number | string

app_biddingfox_start_strategies Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Starts (activates) the given paused bidding strategies of the project. An active strategy starts changing CPC of its products on the next bidding run, which affects ad spend. Returns the per-strategy result and the current strategies.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

ids array requiredpovinnépovinnékötelező

IDs of the strategies. Get them from the list_strategies tool.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

status enum alwaysvždyvždymindig

success = all items succeeded, warning = some failed, error = all failed.
results object | array alwaysvždyvždymindig

Per-item result (true = succeeded), keyed by strategy ID or by the index of the request item.
settings array of object alwaysvždyvždymindig

Current list of all project strategies after the change, including the statistics returned by list_strategies.
settings[].id integer alwaysvždyvždymindig

Strategy ID.
settings[].pno number | string

Target PNO in percent.
settings[].name string alwaysvždyvždymindig
settings[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
settings[].is_test boolean
settings[].max_cpc number | string
settings[].min_cpc number | string
settings[].queries array

Mergado query IDs the strategy applies to.
settings[].stop_at string
settings[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
settings[].start_at string
settings[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
settings[].with_vat integer | boolean
settings[].vat_value integer
settings[].created_at string
settings[].project_id integer alwaysvždyvždymindig
settings[].updated_at string
settings[].cron_enable string
settings[].initial_cpc number | string
settings[].price_ratio number | string
settings[].cron_disable string
settings[].target_positions array
settings[].max_cpc_search_ratio number | string
settings[].max_cpc_percent_price number | string

app_biddingfox_update_product_filter Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Overwrites the name and the conditions of an existing product filter. Both are always replaced by the supplied values, so send both, including unchanged conditions. The change affects every strategy that uses the filter. Returns the current list of project filters.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

filter_id integer requiredpovinnépovinnékötelező

ID of the filter to update. Get it from the list_product_filters tool.
filters object requiredpovinnépovinnékötelező

Complete new filter conditions, in the same format as returned by list_product_filters.
name string requiredpovinnépovinnékötelező

New filter name.
project_id string requiredpovinnépovinnékötelező

Project ID.

OutputVýstupVýstupKimenet

success boolean alwaysvždyvždymindig

False when at least one of the filters could not be changed.
products_filters array of object alwaysvždyvždymindig

Current list of project filters ordered by priority.
products_filters[].id integer alwaysvždyvždymindig
products_filters[].name string alwaysvždyvždymindig
products_filters[].filters object | array

Filter conditions.
products_filters[].priority integer
products_filters[].created_at string
products_filters[].project_id integer alwaysvždyvždymindig
products_filters[].updated_at string
products_filters[].products_count integer

Number of matching products at products_count_updated_at.
products_filters[].products_count_updated_at string

app_biddingfox_update_strategies Bidding Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Overwrites existing bidding strategies of the project. Each item replaces the whole strategy: fields that are not sent are reset to their defaults and budgets that are not sent are deleted. Read the current strategy with list_strategies and send it complete with only the wanted changes. Check the data with validate_strategies first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
settings array requiredpovinnépovinnékötelező

Array of complete strategy definitions. Each item must contain the id of an existing strategy.

OutputVýstupVýstupKimenet

status enum alwaysvždyvždymindig

success = all items succeeded, warning = some failed, error = all failed.
results object | array alwaysvždyvždymindig

Per-item result (true = succeeded), keyed by strategy ID or by the index of the request item.
settings array of object alwaysvždyvždymindig

Current list of all project strategies after the change, including the statistics returned by list_strategies.
settings[].id integer alwaysvždyvždymindig

Strategy ID.
settings[].pno number | string

Target PNO in percent.
settings[].name string alwaysvždyvždymindig
settings[].active boolean alwaysvždyvždymindig

False when the strategy is paused.
settings[].is_test boolean
settings[].max_cpc number | string
settings[].min_cpc number | string
settings[].queries array

Mergado query IDs the strategy applies to.
settings[].stop_at string
settings[].priority integer alwaysvždyvždymindig

Order of evaluation, 1 = highest priority.
settings[].start_at string
settings[].strategy string alwaysvždyvždymindig

always_first, last_top, pno or position.
settings[].with_vat integer | boolean
settings[].vat_value integer
settings[].created_at string
settings[].project_id integer alwaysvždyvždymindig
settings[].updated_at string
settings[].cron_enable string
settings[].initial_cpc number | string
settings[].price_ratio number | string
settings[].cron_disable string
settings[].target_positions array
settings[].max_cpc_search_ratio number | string
settings[].max_cpc_percent_price number | string

app_biddingfox_validate_project_settings Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Checks a project configuration payload without saving anything. Returns valid=true when the payload passes, otherwise valid=false together with the per-field errors. Use get_project_settings to read the current configuration first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
settings object requiredpovinnépovinnékötelező

The configuration payload to validate. Required keys: sales_source, costs_source and clicks_source, each one of analytics, heureka-conversion, zbozi-stats or ga4. Optional keys include reports_emails, url_remove_hash, url_remove_utm, url_regex_find, url_regex_replace, landing_page_plus_query, pairing_mergado_element, ga4_pairing_element, ga_dimensions, ga_source, ga_medium and default_vat.

OutputVýstupVýstupKimenet

valid boolean alwaysvždyvždymindig

True when the payload passes validation.
errors object | array alwaysvždyvždymindig

Validation messages keyed by field name, [] when valid.

app_biddingfox_validate_strategies Bidding Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Checks bidding strategy definitions without saving anything. Use it before create_strategies or update_strategies with the same data. Returns whether all strategies are valid and the validation messages.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

Project ID.
settings array requiredpovinnépovinnékötelező

Array of strategy definitions to check. Include id when checking a change of an existing strategy.

OutputVýstupVýstupKimenet

valid boolean alwaysvždyvždymindig

True when all strategies pass validation.
errors object | array alwaysvždyvždymindig

Validation messages keyed by strategy ID or item index (or "base" for request-level problems), [] when valid.

app_feedimageeditor_custom_images_delete Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently delete a custom image uploaded to the project (see uploaded_images_list for its custom_set_file_id). An image still used as a "customSet" layer in any template cannot be deleted — remove those layers first (templates_layers_delete). Returns the remaining uploaded images. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_custom_images_delete`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

custom_set_file_id integer requiredpovinnépovinnékötelező

custom_set_file_id of the uploaded image to delete, see uploaded_images_list
project_id integer requiredpovinnépovinnékötelező

project id
delete_palettes boolean optionalvolitelnévoliteľnéválasztható

required when custom palettes were extracted from the image: true (after the user confirmed) deletes them together with the image, false or missing deletes nothing

OutputVýstupVýstupKimenet

images array of object alwaysvždyvždymindig

list of the uploaded custom images (empty if none)
images[].url string alwaysvždyvždymindig

public URL of the uploaded image
images[].hash string alwaysvždyvždymindig

an image content hash
images[].width integer alwaysvždyvždymindig

image width in px
images[].author string alwaysvždyvždymindig

author or copyright holder of the image (null if unknown)
images[].height integer alwaysvždyvždymindig

image height in px
images[].license string alwaysvždyvždymindig

license of the image (null if unknown)
images[].thumbnail string

small preview as a base64 data URI (only when with_thumbnails is set, null otherwise)
images[].source_url string alwaysvždyvždymindig

URL the image comes from (null if unknown)
images[].uploaded_by string alwaysvždyvždymindig

who uploaded the image: "ai_agent" when uploaded via MCP, otherwise the id of the user (null if unknown)
images[].custom_set_id number alwaysvždyvždymindig

id of the project's custom image set the file belongs to
images[].orig_filename string alwaysvždyvždymindig

original file name
images[].used_in_templates array of integer alwaysvždyvždymindig

ids of templates where the image is placed as a customSet layer (empty if unused — such an image can be deleted with custom_images_delete)
images[].custom_set_file_id number alwaysvždyvždymindig

id of the uploaded file — pass as custom_set_id/custom_set_file_id to templates_layers_create (type: customSet) to place it on a template

app_feedimageeditor_custom_images_upload Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Store an image (e.g. a logo, badge or watermark) in the project's custom image set. The image must not exceed 10 MB and must be JPEG, PNG, WebP, SVG, GIF, TIFF or BMP (HEIC and AVIF are not supported). Provide exactly one source: image_url (the image is downloaded) or image_base64 (raw base64 or a data URI like data:image/png;base64,...; use this for images pasted into the chat or local files). Optional filename is stored as the image's original filename. Licence: when the image comes from the internet, use only images whose licence allows free commercial use including modification (e.g. CC0, public domain, Pexels / Unsplash / Pixabay licence). Do not offer images under a personal, all-rights-reserved, non-commercial (NC), no-derivatives (ND) or unclear licence, or with a licence requiring attribution (CC BY, CC BY-SA). Always tell the user where the image comes from (page URL, author) and its licence before uploading; whether to use it is the user's decision. Pass source_url, license and author; for SVG files with embedded licence metadata they are filled in automatically. Optional autocrop trims uniform borders (e.g. white or transparent margins) around the image before it is saved. This only uploads the image — it does not add it to any template. Check uploaded_images_list first to avoid uploading the same image twice. image_url must be a direct link to the image file itself (not an HTML page) on a public http/https host; URLs resolving to private or internal addresses are refused, and so are social networks, their CDNs and image search caches (e.g. facebook.com, instagram.com, pinterest.*, x.com, gstatic.com, bing.net) — use the original source of the image instead. The download is attempted once with no retry: hosts that block bots or hotlinking (e.g. Wikimedia, HTTP 429) fail with a raw error, so on failure try a different, more permissive host instead of repeating the same URL. Returns custom_set_id, custom_set_file_id and the public url of the stored image — pass custom_set_id/custom_set_file_id into templates_layers_create (type: 'customSet') to place the image on a template as a layer. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_custom_images_upload`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

ID of the project to upload the image into
author string optionalvolitelnévoliteľnéválasztható

optional author or copyright holder of the image
autocrop boolean optionalvolitelnévoliteľnéválasztható

optional, default false: trims uniform borders (e.g. white/transparent margins) around the image before saving; ignored for SVG
filename string optionalvolitelnévoliteľnéválasztható

optional original filename of the image (e.g. logo.png), stored as orig_filename
image_base64 string optionalvolitelnévoliteľnéválasztható

image file content as base64, raw or as a data URI (e.g. data:image/png;base64,iVBORw0...), max 10 MB of decoded image data; required unless image_url is given
image_url string optionalvolitelnévoliteľnéválasztható

direct public http/https URL of the image file to download (e.g. https://example.com/logo.png), max 10 MB; required unless image_base64 is given
license string optionalvolitelnévoliteľnéválasztható

optional license of the image (e.g. CC0, public domain, Pexels License)
source_url string optionalvolitelnévoliteľnéválasztható

optional URL of the page where the image comes from (e.g. its stock photo or Wikimedia page); defaults to image_url when omitted

OutputVýstupVýstupKimenet

url string alwaysvždyvždymindig

public URL of the uploaded image
custom_set_id number alwaysvždyvždymindig

id of the project's custom image set the file was uploaded into
custom_set_file_id number alwaysvždyvždymindig

id of the uploaded file — pass as custom_set_id/custom_set_file_id to templates_layers_create (type: customSet) to place it on a template

app_feedimageeditor_custom_palettes_create Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Create a new custom palette (brand colors) in the project. Required: project_id, name, and colors and/or an image. Either pass the colors explicitly (hex #RRGGBB, the most important first), or provide an image (e.g. the brand logo) via image_url or image_base64: the image is stored in the project's custom images (as custom_images_upload does, max 10 MB) and, when colors are omitted, its dominant colors are extracted into the palette. Instead of uploading again, an already uploaded image can be referenced by custom_set_file_id (see uploaded_images_list). The new palette always becomes the selected (primary) brand palette of the project (use custom_palettes_select to select another one). Check custom_palettes_list first to avoid duplicates. Returns all project palettes. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_custom_palettes_create`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

palette name, e.g. "Brand colors" or the brand name
project_id integer requiredpovinnépovinnékötelező

project id
colors array optionalvolitelnévoliteľnéválasztható

palette colors, hex #RRGGBB, the most important first (max 32); when omitted, they are extracted from the image
custom_set_file_id integer optionalvolitelnévoliteľnéválasztható

id of an already uploaded custom image (see uploaded_images_list) to use instead of image_url / image_base64
image_base64 string optionalvolitelnévoliteľnéválasztható

image content as base64, raw or as a data URI (e.g. data:image/png;base64,iVBORw0...), max 10 MB; alternative to image_url
image_url string optionalvolitelnévoliteľnéválasztható

direct public http/https URL of an image (e.g. the brand logo, max 10 MB) to store with the palette and extract the colors from

OutputVýstupVýstupKimenet

palettes array of object alwaysvždyvždymindig

all project custom palettes including the new one
palettes[].id integer alwaysvždyvždymindig

custom palette id
palettes[].name string alwaysvždyvždymindig

palette name
palettes[].colors array of string alwaysvždyvždymindig

palette colors, hex #RRGGBB, the most important (dominant) color first
palettes[].image_url string alwaysvždyvždymindig

public URL of that image, null if none
palettes[].is_selected boolean alwaysvždyvždymindig

true for the palette selected in the project settings — the primary brand colors
palettes[].custom_set_file_id integer alwaysvždyvždymindig

id of the uploaded custom image the palette was extracted from (e.g. a logo), null if none

app_feedimageeditor_custom_palettes_delete Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently delete a custom palette (brand colors) of the project (see custom_palettes_list for its id). If it was the selected palette, no palette stays selected. The image the palette was extracted from stays in the project custom images (remove it with custom_images_delete if wanted). Templates are not affected. Returns the remaining palettes. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_custom_palettes_delete`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

custom_palette_id integer requiredpovinnépovinnékötelező

id of the custom palette to delete, see custom_palettes_list
project_id integer requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

palettes array of object alwaysvždyvždymindig

remaining project custom palettes
palettes[].id integer alwaysvždyvždymindig

custom palette id
palettes[].name string alwaysvždyvždymindig

palette name
palettes[].colors array of string alwaysvždyvždymindig

palette colors, hex #RRGGBB, the most important (dominant) color first
palettes[].image_url string alwaysvždyvždymindig

public URL of that image, null if none
palettes[].is_selected boolean alwaysvždyvždymindig

true for the palette selected in the project settings — the primary brand colors
palettes[].custom_set_file_id integer alwaysvždyvždymindig

id of the uploaded custom image the palette was extracted from (e.g. a logo), null if none

app_feedimageeditor_custom_palettes_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List the custom palettes of the project — the project's BRAND COLORS. The palette with is_selected = true is the primary brand palette (selected in the project settings). Call this before designing a new template or layers: unless the user specifies colors, use these brand colors for backgrounds, texts, shapes and gradients (prefer the selected palette, colors are ordered from the most dominant). Check this list before calling custom_palettes_create to avoid creating the same palette twice. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_custom_palettes_list`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

palettes array of object alwaysvždyvždymindig

list of the project custom palettes (empty if none)
palettes[].id integer alwaysvždyvždymindig

custom palette id
palettes[].name string alwaysvždyvždymindig

palette name
palettes[].colors array of string alwaysvždyvždymindig

palette colors, hex #RRGGBB, the most important (dominant) color first
palettes[].image_url string alwaysvždyvždymindig

public URL of that image, null if none
palettes[].is_selected boolean alwaysvždyvždymindig

true for the palette selected in the project settings — the primary brand colors
palettes[].custom_set_file_id integer alwaysvždyvždymindig

id of the uploaded custom image the palette was extracted from (e.g. a logo), null if none

app_feedimageeditor_custom_palettes_select Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Select a custom palette (brand colors) as the primary brand palette of the project (see custom_palettes_list for its id). Only one palette can be selected; the previously selected one is unselected. Templates are not affected. Returns all project palettes. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_custom_palettes_select`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

custom_palette_id integer requiredpovinnépovinnékötelező

id of the custom palette to select, see custom_palettes_list
project_id integer requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

palettes array of object alwaysvždyvždymindig

all project custom palettes, the selected one with is_selected true
palettes[].id integer alwaysvždyvždymindig

custom palette id
palettes[].name string alwaysvždyvždymindig

palette name
palettes[].colors array of string alwaysvždyvždymindig

palette colors, hex #RRGGBB, the most important (dominant) color first
palettes[].image_url string alwaysvždyvždymindig

public URL of that image, null if none
palettes[].is_selected boolean alwaysvždyvždymindig

true for the palette selected in the project settings — the primary brand colors
palettes[].custom_set_file_id integer alwaysvždyvždymindig

id of the uploaded custom image the palette was extracted from (e.g. a logo), null if none

app_feedimageeditor_fonts_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List all available fonts for the project (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_fonts_list`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

fonts array of object alwaysvždyvždymindig

list of the project font families
fonts[].image string alwaysvždyvždymindig

family preview image url
fonts[].family string alwaysvždyvždymindig

font family name
fonts[].styles array of object alwaysvždyvždymindig

available styles of the family
fonts[].styles[].name string alwaysvždyvždymindig

style name (e.g. Regular, Bold)
fonts[].styles[].image string alwaysvždyvždymindig

style preview image url
fonts[].styles[].weight integer

font weight (variable fonts only)
fonts[].styles[].stretch string

font stretch (variable fonts only)
fonts[].styles[].text_fontfamily string alwaysvždyvždymindig

font name of this style, usable as text_fontfamily
fonts[].text_fontfamily string alwaysvždyvždymindig

representative font name of the family, usable as text_fontfamily

app_feedimageeditor_gradients_create Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Create a new gradient in the project. Required: project_id, type (linear | radial), stop_points (at least 2 color stops, offset in %). All coordinates are in % of the filled area (0-100): linear goes from (x1, y1) to (x2, y2), default left to right; radial has its center at (x1, y1), focal point at (x2, y2) and radius in %, default centered with radius 50. Returns the created gradient — use its id as gradient_id of a layer (templates_layers_create / templates_layers_update) or as a template background. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_gradients_create`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

project id
stop_points array requiredpovinnépovinnékötelező

color stops (at least 2)
type enum requiredpovinnépovinnékötelező

gradient type: linear | radial
opacity integer optionalvolitelnévoliteľnéválasztható

opacity of the whole gradient in % (default 100)
radius integer optionalvolitelnévoliteľnéválasztható

radial only: radius in % (default 50)
x1 integer optionalvolitelnévoliteľnéválasztható

linear: start point x in % of the width; radial: center x in % (default linear 0, radial 50)
x2 integer optionalvolitelnévoliteľnéválasztható

linear: end point x in % of the width; radial: focal point x in % (default linear 100, radial 50)
y1 integer optionalvolitelnévoliteľnéválasztható

linear: start point y in % of the height; radial: center y in % (default linear 0, radial 50)
y2 integer optionalvolitelnévoliteľnéválasztható

linear: end point y in % of the height; radial: focal point y in % (default linear 0, radial 50)

OutputVýstupVýstupKimenet

gradient object alwaysvždyvždymindig

the created gradient
gradient.id integer alwaysvždyvždymindig

gradient id — pass as gradient_id to a layer (templates_layers_create/update) or a template background
gradient.x1 integer alwaysvždyvždymindig

linear: start x / radial: center x, in %
gradient.x2 integer alwaysvždyvždymindig

linear: end x / radial: focal x, in %
gradient.y1 integer alwaysvždyvždymindig

linear: start y / radial: center y, in %
gradient.y2 integer alwaysvždyvždymindig

linear: end y / radial: focal y, in %
gradient.type string alwaysvždyvždymindig

linear | radial
gradient.radius integer alwaysvždyvždymindig

radial radius in %
gradient.opacity integer alwaysvždyvždymindig

opacity in %
gradient.project_id integer alwaysvždyvždymindig

project id
gradient.stop_points array of object alwaysvždyvždymindig

color stops
gradient.stop_points[].color string alwaysvždyvždymindig

stop color
gradient.stop_points[].offset number alwaysvždyvždymindig

stop position in %

app_feedimageeditor_gradients_delete Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently delete a gradient of the project (see gradients_list for its id). A gradient still used by any template (as a background or in a layer) cannot be deleted — change those templates/layers first. Returns the remaining gradients. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_gradients_delete`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

gradient_id integer requiredpovinnépovinnékötelező

id of the gradient to delete, see gradients_list
project_id integer requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

gradients array of object alwaysvždyvždymindig

remaining project gradients
gradients[].id integer alwaysvždyvždymindig

gradient id — pass as gradient_id to a layer (templates_layers_create/update) or a template background
gradients[].x1 integer alwaysvždyvždymindig

linear: start x / radial: center x, in %
gradients[].x2 integer alwaysvždyvždymindig

linear: end x / radial: focal x, in %
gradients[].y1 integer alwaysvždyvždymindig

linear: start y / radial: center y, in %
gradients[].y2 integer alwaysvždyvždymindig

linear: end y / radial: focal y, in %
gradients[].type string alwaysvždyvždymindig

linear | radial
gradients[].radius integer alwaysvždyvždymindig

radial radius in %
gradients[].opacity integer alwaysvždyvždymindig

opacity in %
gradients[].project_id integer alwaysvždyvždymindig

project id
gradients[].stop_points array of object alwaysvždyvždymindig

color stops
gradients[].stop_points[].color string alwaysvždyvždymindig

stop color
gradients[].stop_points[].offset number alwaysvždyvždymindig

stop position in %

app_feedimageeditor_gradients_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List the gradients defined in the project. A gradient id can be used as gradient_id of a layer (templates_layers_create / templates_layers_update) or as a template background. Check this list before calling gradients_create to reuse an existing gradient. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_gradients_list`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

gradients array of object alwaysvždyvždymindig

list of the project gradients (empty if none)
gradients[].id integer alwaysvždyvždymindig

gradient id — pass as gradient_id to a layer (templates_layers_create/update) or a template background
gradients[].x1 integer alwaysvždyvždymindig

linear: start x / radial: center x, in %
gradients[].x2 integer alwaysvždyvždymindig

linear: end x / radial: focal x, in %
gradients[].y1 integer alwaysvždyvždymindig

linear: start y / radial: center y, in %
gradients[].y2 integer alwaysvždyvždymindig

linear: end y / radial: focal y, in %
gradients[].type string alwaysvždyvždymindig

linear | radial
gradients[].radius integer alwaysvždyvždymindig

radial radius in %
gradients[].opacity integer alwaysvždyvždymindig

opacity in %
gradients[].project_id integer alwaysvždyvždymindig

project id
gradients[].stop_points array of object alwaysvždyvždymindig

color stops
gradients[].stop_points[].color string alwaysvždyvždymindig

stop color
gradients[].stop_points[].offset number alwaysvždyvždymindig

stop position in %

app_feedimageeditor_gradients_update Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Update an existing gradient of the project (see gradients_list for its id). Required: project_id, gradient_id. Send only the fields you want to change; omitted fields keep their current values. stop_points replaces ALL the existing stop points, so send the complete list. The change affects every template using the gradient (as a background or in a layer). Returns the updated gradient. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_gradients_update`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

gradient_id integer requiredpovinnépovinnékötelező

id of the gradient to update, see gradients_list
project_id integer requiredpovinnépovinnékötelező

project id
opacity integer optionalvolitelnévoliteľnéválasztható

opacity of the whole gradient in %
radius integer optionalvolitelnévoliteľnéválasztható

radial only: radius in %
stop_points array optionalvolitelnévoliteľnéválasztható

color stops (at least 2); replaces ALL the existing stop points, so send the complete list
type enum optionalvolitelnévoliteľnéválasztható

gradient type: linear | radial
x1 integer optionalvolitelnévoliteľnéválasztható

linear: start point x in % of the width; radial: center x in %
x2 integer optionalvolitelnévoliteľnéválasztható

linear: end point x in % of the width; radial: focal point x in %
y1 integer optionalvolitelnévoliteľnéválasztható

linear: start point y in % of the height; radial: center y in %
y2 integer optionalvolitelnévoliteľnéválasztható

linear: end point y in % of the height; radial: focal point y in %

OutputVýstupVýstupKimenet

gradient object alwaysvždyvždymindig

the updated gradient
gradient.id integer alwaysvždyvždymindig

gradient id — pass as gradient_id to a layer (templates_layers_create/update) or a template background
gradient.x1 integer alwaysvždyvždymindig

linear: start x / radial: center x, in %
gradient.x2 integer alwaysvždyvždymindig

linear: end x / radial: focal x, in %
gradient.y1 integer alwaysvždyvždymindig

linear: start y / radial: center y, in %
gradient.y2 integer alwaysvždyvždymindig

linear: end y / radial: focal y, in %
gradient.type string alwaysvždyvždymindig

linear | radial
gradient.radius integer alwaysvždyvždymindig

radial radius in %
gradient.opacity integer alwaysvždyvždymindig

opacity in %
gradient.project_id integer alwaysvždyvždymindig

project id
gradient.stop_points array of object alwaysvždyvždymindig

color stops
gradient.stop_points[].color string alwaysvždyvždymindig

stop color
gradient.stop_points[].offset number alwaysvždyvždymindig

stop position in %

app_feedimageeditor_project_settings_get Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

Get the project settings: output image format and compression, image refreshing, output URL form, visual similarity export, hiding rules, the selected custom palette, contact e-mail, the project categories and the advanced settings of sending the images to Mergado (max payload size, sent elements). Change them with project_settings_update. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_project_settings_get`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

palette_id integer alwaysvždyvždymindig

id of the selected predefined color palette, default 1 (custom palettes are selected with custom_palettes_select)
project_id integer alwaysvždyvždymindig

project id
who_are_you string alwaysvždyvždymindig

who is managing the project: agency | eshop | freelancer, null = not specified
contact_email string alwaysvždyvždymindig

contact e-mail of the project for the notifications, null = the e-mail of the project creator is used
disable_helper boolean alwaysvždyvždymindig

editor UI: do not show the helper
group_by_image boolean alwaysvždyvždymindig

group the products on the products list by image
ask_before_leave boolean alwaysvždyvždymindig

editor UI: ask to save the changes before leaving the editor
hide_by_is_empty boolean alwaysvždyvždymindig

hiding rule: hide products whose image has an empty content
hide_by_no_image boolean alwaysvždyvždymindig

hiding rule: hide products without an image
show_first_steps boolean alwaysvždyvždymindig

editor UI: show the first steps guide
custom_palette_id integer alwaysvždyvždymindig

id of the selected custom palette (primary brand colors), null if none — change it with custom_palettes_select
disable_wheelzoom boolean alwaysvždyvždymindig

editor UI: disable the mouse wheel zoom
products_per_page integer alwaysvždyvždymindig

number of products on the previews page in the editor: 3 | 4 | 6 | 8 | 9 | 12 | 16 | 18 | 24 | 32, default 9
force_remove_alpha boolean alwaysvždyvždymindig

remove the alpha channel from the image before sending it for background removal
hide_by_low_quality boolean alwaysvždyvždymindig

hiding rule: hide products with a low quality image
hide_by_status_code array of integer alwaysvždyvždymindig

hiding rule: hide products whose image URL returns one of these HTTP status codes (403, 404, 500, 0; 0 = unreachable), empty = off
output_image_format string alwaysvždyvždymindig

format of the generated output images: png | webp | jpeg | gif. Transparency is kept only in png, webp, gif. Changing it clears the already generated images of all templates.
projects_categories array of string alwaysvždyvždymindig

product categories the e-shop sells: fashion (Fashion), home_and_garden (Home and Garden), health (Health), kids (Kids), sports (Sports), beauty (Beauty), electronics (Electronics), pets (Pets), books (Books), cars (Cars), services_and_experiences (Services and experiences), other_category (Other); empty = not specified
skip_refresh_images boolean alwaysvždyvždymindig

download the source product images only when their URL changes (saves the storage, but a changed image content under the same URL is not detected)
disable_show_overlap boolean alwaysvždyvždymindig

editor UI: do not show the protection zone in the preview
hide_by_has_watermark boolean alwaysvždyvždymindig

hiding rule: hide products with watermarks
mergado_element_regex string alwaysvždyvždymindig

advanced: regular expression filtering the feed elements sent to Mergado when applying the rules (e.g. ^((?!PARAM|DESCRIPTION).)*$ excludes some elements), null = all elements
auto_template_priority boolean alwaysvždyvždymindig

reorder the templates automatically (enabling it reorders them right away)
hide_by_seo_large_file boolean alwaysvždyvždymindig

hiding rule: hide products with an image file too large in terms of SEO
mergado_xml_equivalent array of string alwaysvždyvždymindig

advanced: Mergado XML equivalents of the elements sent to Mergado when applying the rules (e.g. ITEM_ID, IMAGE, IMAGE_ALTERNATIVE, PRICE_VAT, NAME_EXACT), empty = all elements. Keep at least ITEM_ID and IMAGE
similarity_ids_element boolean alwaysvždyvždymindig

visual similarity: export the IDs of visually similar products to the output feed. Results appear in the feed elements FIE_VS_IDS after the Mergado feed is regenerated
hide_by_wrong_placement boolean alwaysvždyvždymindig

hiding rule: hide products with a wrong image placement
auto_compression_to_size integer alwaysvždyvždymindig

automatically compress the output images to at most this size in bytes, one of: 102400 | 204800 | 409600 | 2097152 | 5242880 | 8388608 | 16777216 | 20971520 | 31457280 (e.g. 102400 = 100 kB for SEO, 2097152 = 2 MB for Heureka), null = off. Only for compressible output formats
mergado_max_payload_size integer alwaysvždyvždymindig

advanced: max size in bytes of a single request sending the image URLs to Mergado when applying the rules (more than 1024 and less than 15000000), null = Mergado default. Lower it when applying fails with "payload too large"
output_image_compression integer alwaysvždyvždymindig

quality of the output images in % (1-100), default 95
short_url_with_extension boolean alwaysvždyvždymindig

use a shorter output image URL including a file extension according to output_image_format (some shopping engines require the extension)
hide_by_content_length_gt integer alwaysvždyvždymindig

hiding rule: hide products whose image file is larger than this value in kB, null = off
hide_by_content_length_lt integer alwaysvždyvždymindig

hiding rule: hide products whose image file is smaller than this value in kB, null = off
products_per_page_on_list integer alwaysvždyvždymindig

number of products per page on the products list, default 10
disable_mailgun_notifications boolean alwaysvždyvždymindig

do not send the e-mail notifications of this project
similarity_image_urls_element boolean alwaysvždyvždymindig

visual similarity: export the URLs of visually similar images to the output feed. Results appear in the feed elements FIE_VS_IMAGES_URL after the Mergado feed is regenerated

app_feedimageeditor_project_settings_update Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Update the project settings (see project_settings_get). Only the passed fields are changed, the others are kept. Changing output_image_format clears the already generated images of all templates — they are regenerated in the new format. The advanced mergado_* settings take effect on the next applying of the rules to Mergado. The selected custom palette is changed with custom_palettes_select. Returns all project settings. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_project_settings_update`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

project id
ask_before_leave boolean optionalvolitelnévoliteľnéválasztható

editor UI: ask to save the changes before leaving the editor
auto_compression_to_size enum optionalvolitelnévoliteľnéválasztható

automatically compress the output images to at most this size in bytes, one of: 102400 | 204800 | 409600 | 2097152 | 5242880 | 8388608 | 16777216 | 20971520 | 31457280 (e.g. 102400 = 100 kB for SEO, 2097152 = 2 MB for Heureka), null = off. Only for compressible output formats
auto_template_priority boolean optionalvolitelnévoliteľnéválasztható

reorder the templates automatically (enabling it reorders them right away)
contact_email string optionalvolitelnévoliteľnéválasztható

contact e-mail of the project for the notifications, null = the e-mail of the project creator is used
disable_helper boolean optionalvolitelnévoliteľnéválasztható

editor UI: do not show the helper
disable_mailgun_notifications boolean optionalvolitelnévoliteľnéválasztható

do not send the e-mail notifications of this project
disable_show_overlap boolean optionalvolitelnévoliteľnéválasztható

editor UI: do not show the protection zone in the preview
disable_wheelzoom boolean optionalvolitelnévoliteľnéválasztható

editor UI: disable the mouse wheel zoom
force_remove_alpha boolean optionalvolitelnévoliteľnéválasztható

remove the alpha channel from the image before sending it for background removal
group_by_image boolean optionalvolitelnévoliteľnéválasztható

group the products on the products list by image
hide_by_content_length_gt integer optionalvolitelnévoliteľnéválasztható

hiding rule: hide products whose image file is larger than this value in kB, null = off
hide_by_content_length_lt integer optionalvolitelnévoliteľnéválasztható

hiding rule: hide products whose image file is smaller than this value in kB, null = off
hide_by_has_watermark boolean optionalvolitelnévoliteľnéválasztható

hiding rule: hide products with watermarks
hide_by_is_empty boolean optionalvolitelnévoliteľnéválasztható

hiding rule: hide products whose image has an empty content
hide_by_low_quality boolean optionalvolitelnévoliteľnéválasztható

hiding rule: hide products with a low quality image
hide_by_no_image boolean optionalvolitelnévoliteľnéválasztható

hiding rule: hide products without an image
hide_by_seo_large_file boolean optionalvolitelnévoliteľnéválasztható

hiding rule: hide products with an image file too large in terms of SEO
hide_by_status_code array optionalvolitelnévoliteľnéválasztható

hiding rule: hide products whose image URL returns one of these HTTP status codes (403, 404, 500, 0; 0 = unreachable), empty = off; replaces the current list
hide_by_wrong_placement boolean optionalvolitelnévoliteľnéválasztható

hiding rule: hide products with a wrong image placement
mergado_element_regex string optionalvolitelnévoliteľnéválasztható

advanced: regular expression filtering the feed elements sent to Mergado when applying the rules (e.g. ^((?!PARAM|DESCRIPTION).)*$ excludes some elements), null = all elements
mergado_max_payload_size integer optionalvolitelnévoliteľnéválasztható

advanced: max size in bytes of a single request sending the image URLs to Mergado when applying the rules (more than 1024 and less than 15000000), null = Mergado default. Lower it when applying fails with "payload too large"
mergado_xml_equivalent array optionalvolitelnévoliteľnéválasztható

advanced: Mergado XML equivalents of the elements sent to Mergado when applying the rules (e.g. ITEM_ID, IMAGE, IMAGE_ALTERNATIVE, PRICE_VAT, NAME_EXACT), empty = all elements. Keep at least ITEM_ID and IMAGE; replaces the current list
output_image_compression integer optionalvolitelnévoliteľnéválasztható

quality of the output images in % (1-100), default 95
output_image_format enum optionalvolitelnévoliteľnéválasztható

format of the generated output images: png | webp | jpeg | gif. Transparency is kept only in png, webp, gif. Changing it clears the already generated images of all templates.
palette_id integer optionalvolitelnévoliteľnéválasztható

id of the selected predefined color palette, default 1 (custom palettes are selected with custom_palettes_select)
products_per_page enum optionalvolitelnévoliteľnéválasztható

number of products on the previews page in the editor: 3 | 4 | 6 | 8 | 9 | 12 | 16 | 18 | 24 | 32, default 9
products_per_page_on_list integer optionalvolitelnévoliteľnéválasztható

number of products per page on the products list, default 10
projects_categories array optionalvolitelnévoliteľnéválasztható

product categories the e-shop sells: fashion (Fashion), home_and_garden (Home and Garden), health (Health), kids (Kids), sports (Sports), beauty (Beauty), electronics (Electronics), pets (Pets), books (Books), cars (Cars), services_and_experiences (Services and experiences), other_category (Other); empty = not specified; replaces the current list
short_url_with_extension boolean optionalvolitelnévoliteľnéválasztható

use a shorter output image URL including a file extension according to output_image_format (some shopping engines require the extension)
show_first_steps boolean optionalvolitelnévoliteľnéválasztható

editor UI: show the first steps guide
similarity_ids_element boolean optionalvolitelnévoliteľnéválasztható

visual similarity: export the IDs of visually similar products to the output feed. Results appear in the feed elements FIE_VS_IDS after the Mergado feed is regenerated
similarity_image_urls_element boolean optionalvolitelnévoliteľnéválasztható

visual similarity: export the URLs of visually similar images to the output feed. Results appear in the feed elements FIE_VS_IMAGES_URL after the Mergado feed is regenerated
skip_refresh_images boolean optionalvolitelnévoliteľnéválasztható

download the source product images only when their URL changes (saves the storage, but a changed image content under the same URL is not detected)
who_are_you enum optionalvolitelnévoliteľnéválasztható

who is managing the project: agency | eshop | freelancer, null = not specified

OutputVýstupVýstupKimenet

palette_id integer alwaysvždyvždymindig

id of the selected predefined color palette, default 1 (custom palettes are selected with custom_palettes_select)
project_id integer alwaysvždyvždymindig

project id
who_are_you string alwaysvždyvždymindig

who is managing the project: agency | eshop | freelancer, null = not specified
contact_email string alwaysvždyvždymindig

contact e-mail of the project for the notifications, null = the e-mail of the project creator is used
disable_helper boolean alwaysvždyvždymindig

editor UI: do not show the helper
group_by_image boolean alwaysvždyvždymindig

group the products on the products list by image
ask_before_leave boolean alwaysvždyvždymindig

editor UI: ask to save the changes before leaving the editor
hide_by_is_empty boolean alwaysvždyvždymindig

hiding rule: hide products whose image has an empty content
hide_by_no_image boolean alwaysvždyvždymindig

hiding rule: hide products without an image
show_first_steps boolean alwaysvždyvždymindig

editor UI: show the first steps guide
custom_palette_id integer alwaysvždyvždymindig

id of the selected custom palette (primary brand colors), null if none — change it with custom_palettes_select
disable_wheelzoom boolean alwaysvždyvždymindig

editor UI: disable the mouse wheel zoom
products_per_page integer alwaysvždyvždymindig

number of products on the previews page in the editor: 3 | 4 | 6 | 8 | 9 | 12 | 16 | 18 | 24 | 32, default 9
force_remove_alpha boolean alwaysvždyvždymindig

remove the alpha channel from the image before sending it for background removal
hide_by_low_quality boolean alwaysvždyvždymindig

hiding rule: hide products with a low quality image
hide_by_status_code array of integer alwaysvždyvždymindig

hiding rule: hide products whose image URL returns one of these HTTP status codes (403, 404, 500, 0; 0 = unreachable), empty = off
output_image_format string alwaysvždyvždymindig

format of the generated output images: png | webp | jpeg | gif. Transparency is kept only in png, webp, gif. Changing it clears the already generated images of all templates.
projects_categories array of string alwaysvždyvždymindig

product categories the e-shop sells: fashion (Fashion), home_and_garden (Home and Garden), health (Health), kids (Kids), sports (Sports), beauty (Beauty), electronics (Electronics), pets (Pets), books (Books), cars (Cars), services_and_experiences (Services and experiences), other_category (Other); empty = not specified
skip_refresh_images boolean alwaysvždyvždymindig

download the source product images only when their URL changes (saves the storage, but a changed image content under the same URL is not detected)
disable_show_overlap boolean alwaysvždyvždymindig

editor UI: do not show the protection zone in the preview
hide_by_has_watermark boolean alwaysvždyvždymindig

hiding rule: hide products with watermarks
mergado_element_regex string alwaysvždyvždymindig

advanced: regular expression filtering the feed elements sent to Mergado when applying the rules (e.g. ^((?!PARAM|DESCRIPTION).)*$ excludes some elements), null = all elements
auto_template_priority boolean alwaysvždyvždymindig

reorder the templates automatically (enabling it reorders them right away)
hide_by_seo_large_file boolean alwaysvždyvždymindig

hiding rule: hide products with an image file too large in terms of SEO
mergado_xml_equivalent array of string alwaysvždyvždymindig

advanced: Mergado XML equivalents of the elements sent to Mergado when applying the rules (e.g. ITEM_ID, IMAGE, IMAGE_ALTERNATIVE, PRICE_VAT, NAME_EXACT), empty = all elements. Keep at least ITEM_ID and IMAGE
similarity_ids_element boolean alwaysvždyvždymindig

visual similarity: export the IDs of visually similar products to the output feed. Results appear in the feed elements FIE_VS_IDS after the Mergado feed is regenerated
hide_by_wrong_placement boolean alwaysvždyvždymindig

hiding rule: hide products with a wrong image placement
auto_compression_to_size integer alwaysvždyvždymindig

automatically compress the output images to at most this size in bytes, one of: 102400 | 204800 | 409600 | 2097152 | 5242880 | 8388608 | 16777216 | 20971520 | 31457280 (e.g. 102400 = 100 kB for SEO, 2097152 = 2 MB for Heureka), null = off. Only for compressible output formats
mergado_max_payload_size integer alwaysvždyvždymindig

advanced: max size in bytes of a single request sending the image URLs to Mergado when applying the rules (more than 1024 and less than 15000000), null = Mergado default. Lower it when applying fails with "payload too large"
output_image_compression integer alwaysvždyvždymindig

quality of the output images in % (1-100), default 95
short_url_with_extension boolean alwaysvždyvždymindig

use a shorter output image URL including a file extension according to output_image_format (some shopping engines require the extension)
hide_by_content_length_gt integer alwaysvždyvždymindig

hiding rule: hide products whose image file is larger than this value in kB, null = off
hide_by_content_length_lt integer alwaysvždyvždymindig

hiding rule: hide products whose image file is smaller than this value in kB, null = off
products_per_page_on_list integer alwaysvždyvždymindig

number of products per page on the products list, default 10
disable_mailgun_notifications boolean alwaysvždyvždymindig

do not send the e-mail notifications of this project
similarity_image_urls_element boolean alwaysvždyvždymindig

visual similarity: export the URLs of visually similar images to the output feed. Results appear in the feed elements FIE_VS_IMAGES_URL after the Mergado feed is regenerated

app_feedimageeditor_size_delete Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently delete the size from project. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_size_delete`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

project id
size_id integer requiredpovinnépovinnékötelező

size_id to delete, see sizes_list for project

OutputVýstupVýstupKimenet

sizes array of object alwaysvždyvždymindig

list of the project sizes and predefined sizes
sizes[].id string alwaysvždyvždymindig

size id to pass as size_id: numeric id of a size saved in the project, or the preset trans_string if the preset is not saved in the project yet
sizes[].name string

size name, null for presets not saved in the project yet
sizes[].width number alwaysvždyvždymindig

size width
sizes[].format string alwaysvždyvždymindig

channel format of the preset (e.g. facebook, google), or "custom" for project custom sizes
sizes[].height number alwaysvždyvždymindig

size height
sizes[].templates array of object alwaysvždyvždymindig

templates in the project already using this size
sizes[].templates[].id number alwaysvždyvždymindig

template id
sizes[].templates[].name string alwaysvždyvždymindig

template name
sizes[].project_id number alwaysvždyvždymindig

project id
sizes[].trans_string string

preset translation string, null for custom sizes
sizes[].used_in_templates array of integer alwaysvždyvždymindig

ids of templates using this size (empty if unused — such a project size can be deleted with size_delete)

app_feedimageeditor_sizes_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List the output sizes available in a project: predefined presets (sizes for the project output format first, then other formats) and custom sizes already saved in the project. Each item has an `id` to pass as `size_id` to `templates_create` or `templates_update`. Presets are only tagged with a channel `format` (e.g. `facebook`, `google`) and dimensions, not a placement (e.g. `story` vs. `feed`), so for a specific placement you may need to determine the right pixel size yourself and pass width/height instead. If asked for specific channel, prefer the channel over the custom sizes already saved in the project, but be sure width and height is exactly what asked. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_sizes_list`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id

OutputVýstupVýstupKimenet

sizes array of object alwaysvždyvždymindig

list of the project sizes and predefined sizes
sizes[].id string alwaysvždyvždymindig

size id to pass as size_id: numeric id of a size saved in the project, or the preset trans_string if the preset is not saved in the project yet
sizes[].name string

size name, null for presets not saved in the project yet
sizes[].width number alwaysvždyvždymindig

size width
sizes[].format string alwaysvždyvždymindig

channel format of the preset (e.g. facebook, google), or "custom" for project custom sizes
sizes[].height number alwaysvždyvždymindig

size height
sizes[].templates array of object alwaysvždyvždymindig

templates in the project already using this size
sizes[].templates[].id number alwaysvždyvždymindig

template id
sizes[].templates[].name string alwaysvždyvždymindig

template name
sizes[].project_id number alwaysvždyvždymindig

project id
sizes[].trans_string string

preset translation string, null for custom sizes
sizes[].used_in_templates array of integer alwaysvždyvždymindig

ids of templates using this size (empty if unused — such a project size can be deleted with size_delete)

app_feedimageeditor_templates_copy_from_project_to_project Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Copy one main template (or, if `template_id` is omitted, every main template in `from_project_id`) into another project (`project_id`), including its size, layers, and AI settings. Only main templates are copied — alternative templates (`is_alt`) are NOT copied and are not supported by this tool. **This writes new templates into the destination project — it does not just read data.** Typically used when a new project/client should reuse an existing template setup. Copies are created inactive, at the end of the template order, named with the prefix `>> <source project id> >> `, and without a product selection (`queries` is empty), so they apply to no products until you set `queries` with `templates_update`. Feed elements used by dynamic layers are not checked: preview a destination product (`templates_previews`) to catch empty elements or a wrong currency in static texts, then propose the selection, order and activation to the user. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_copy_from_project_to_project`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

from_project_id number requiredpovinnépovinnékötelező

source project id
project_id number requiredpovinnépovinnékötelező

destination project id
template_id number optionalvolitelnévoliteľnéválasztható

Main template id to be copied (alternative template ids are not supported). If null, copies all the main templates from the project.

OutputVýstupVýstupKimenet

imported_templates array alwaysvždyvždymindig

list of "name (id)[layer count]" strings, one per template imported into the destination project

app_feedimageeditor_templates_create Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Create a new template in a project: name, output size (width/height, or omit to use a project default), background color, an optional AI effect (Upscale, Outpainting, or Background removal), and the product selection (queries) it applies to. **`queries` is required and must contain Mergado query ids that exist in this project — they are not FIE ids and cannot be guessed.** Before calling, get them from the Mergado MCP `list_project_queries` (same `project_id`) and pick the query matching the products the user wants; for all products use the project's all-products query (in Mergado usually named `♥ALLPRODUCTS♥`). If no query fits, ask the user which product selection to use rather than inventing an id. As for size, you may create a new size, or use existing with size_id from `sizes_list`, or you may also keep size of the images as it is (for this case there cannot be more layers, only the product source image). When asking for the size by its width and height (non-numeric size_id) from `sizes_list` of the specific channel (alza, facebook, google, ...) prefer the size with matching channel, but be sure the width and height is exactly what asked. Unless the user specifies the background color, use the project's brand colors from `custom_palettes_list` (prefer the selected palette). With `is_alt: true` an ALTERNATIVE template is created instead: it is applied to the products' alternative (additional) images, not the main image. It has no `queries` (forbidden); instead pass `bindings` = the main templates (from `templates_list`) whose products it applies to, each with the alternative image levels (`levels_mode`: all|first|last|selected + `levels` for selected, 0 = the first alternative image). Without bindings it is not applied to any product. Then add its layers with `templates_layers_create` (`is_alt: true`). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_create`.) PAID, per project. EDITS the photos already in the feed — watermark and background removal, upscale, outpainting, autocrop, price tags, logos — published at new URLs. Needed for any change to the picture itself; changing which URL the feed carries is a free core rule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

Name of the new template
project_id number requiredpovinnépovinnékötelező

project id
ai_type enum optionalvolitelnévoliteľnéválasztható

AI type of the template. upscale (only images smaller than 600×600 px are processed)
background string optionalvolitelnévoliteľnéválasztható

Background color in hex format, e.g. #ffffff
bindings array optionalvolitelnévoliteľnéválasztható

Alternative templates only (`is_alt: true`). Main templates the alternative template is bound to, each with the alternative image levels it applies to. Replaces all the current bindings; [] unbinds the alternative template from every main template (it is then not applied at all).
height number optionalvolitelnévoliteľnéválasztható

Height of the template (max 4096)
is_active boolean optionalvolitelnévoliteľnéválasztható

Whether the template should be active
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = create an alternative template (applied to the products' alternative images; bind it to main templates with `bindings`, no `queries`). Default false = main template.
keep_original_size boolean optionalvolitelnévoliteľnéválasztható

Keep each product's original image size instead of a fixed output size. Only the product source image is supported in this mode, no extra layers. Cannot be combined with `width`/`height` or `size_id`
queries array optionalvolitelnévoliteľnéválasztható

Mergado query ids (product selections) the template applies to, e.g. [123]. Get valid ids for this project from the Mergado MCP `list_project_queries` first — any other id is rejected. Required for main templates, forbidden for alternative templates (`is_alt: true`).
size_id string | number optionalvolitelnévoliteľnéválasztható

Id of an existing size preset to use as output size, see `sizes_list`. Cannot be combined with `width`/`height` or `keep_original_size`
width number optionalvolitelnévoliteľnéválasztható

Width of the template (max 4096)

OutputVýstupVýstupKimenet

id number alwaysvždyvždymindig

template id
name string alwaysvždyvždymindig

template name
type integer alwaysvždyvždymindig

ai template type
active integer alwaysvždyvždymindig

is template active
is_alt boolean

true for an alternative template (absent for main templates)
queries array of integer

list of template product query ids (main templates only)
bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
bindings[].template_id integer alwaysvždyvždymindig

main template id
priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
active_to string

scheduled template active_to (main templates only)
active_from string

scheduled template active_from (main templates only)

app_feedimageeditor_templates_delete Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently delete a template from a project. This cannot be un-done. Confirm with the user before calling; consider `templates_copy_from_project_to_project` first if the template might still be needed elsewhere. With `is_alt: true` deletes an alternative template (its layers and bindings too). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_delete`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id to be deleted
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

deleted boolean alwaysvždyvždymindig

whether the template was deleted

app_feedimageeditor_templates_detail Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

Get one template's configuration: size, background, product selection (queries), scheduled active window (`active_from`/`active_to`), priority, and how the product image is placed into the template (`enlarge`, `enlarge_by`, `crop`, `protection_zone`, `translate_x`/`translate_y`, `is_autocrop` — see `outputSchema` for their meaning). The raw response carries many more fields than documented (`effect_id`, `effect_sensitivity`, collage/shadow/reflection settings, etc.) — treat anything not in `outputSchema` as unreliable/undocumented. In particular, the AI effect is only exposed as an undocumented numeric `type` — it is not returned as the same `ai_type` string (Upscale/Outpainting/Background removal) used to set it, and `effect_id`/`effect_sensitivity` stay `null` even when an effect is active, so don't rely on any of these to report a template's AI effect to the user. After changing a template's product selection via the Mergado-rule workaround, expect this to show stale data for a while (cache/sync lag, not a failed change). Use after `templates_list` to inspect a specific template before changing it. Templates can be edited in parallel by another client (the web editor or another agent), so this result is only a snapshot: call it again right before each write to the template instead of reusing an earlier result. With `is_alt: true` returns an alternative template (no `queries`/`active_from`/`active_to`, but `bindings`). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_detail`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id to be viewed
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

id number alwaysvždyvždymindig

template id
crop integer alwaysvždyvždymindig

crop image (0/1): when 1, a product image bigger than the template size (after `enlarge_by`) is cropped to it; when 0 (and `enlarge` = 1), it is downscaled to fit instead
name string alwaysvždyvždymindig

template name
type integer alwaysvždyvždymindig

ai template type
active integer alwaysvždyvždymindig

is template active
is_alt boolean

true for an alternative template (absent for main templates)
enlarge integer alwaysvždyvždymindig

is the product image resized to the template size (0/1); when 0, `enlarge_by`, `protection_zone` and the downscale-instead-of-crop behaviour are not applied and the image is placed in its original size
queries array of integer

list of template product query ids (main templates only)
size_id number alwaysvždyvždymindig

assigned size id, null if keep_original_size is set or no size is assigned yet
bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
bindings[].template_id integer alwaysvždyvždymindig

main template id
priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
active_to string

scheduled template active_to (main templates only)
background string alwaysvždyvždymindig

background color, hex format
enlarge_by enum alwaysvždyvždymindig

how the product image is resized to the template size (only when `enlarge` = 1), always keeping the aspect ratio: `fit` = fit the whole image inside the output dimensions, `width` = match the output width, `height` = match the output height, `smaller` = match by the image's smaller dimension, `bigger` = match by the image's bigger dimension; null = no resizing
active_from string

scheduled template active_from (main templates only)
is_autocrop integer alwaysvždyvždymindig

autocrop (0/1): trims uniform borders (e.g. white/transparent margins) around the product so it fills the available area better
translate_x integer alwaysvždyvždymindig

horizontal shift of the product image in px from its centered position (positive = right, negative = left)
translate_y integer alwaysvždyvždymindig

vertical shift of the product image in px from its centered position (positive = down, negative = up)
is_keep_size integer alwaysvždyvždymindig

is the template using each product's original image size instead of a fixed size (0/1)
shapes_count integer alwaysvždyvždymindig

number of layers on the template
protection_zone integer alwaysvždyvždymindig

protection zone in px applied on each side of the product image relative to the template size: positive = the image is shrunk and framed with the background color, negative = the image is enlarged over the template edges (with Outpainting, a negative value lets the AI extend the image). Ignored (0) when max image width/height is set

app_feedimageeditor_templates_duplicate Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Create a copy of an existing template in the same project, including its size, layers, AI settings, and product selection. The copy is appended after the original in priority order. **The response currently echoes the source template's id, not the new copy's** — always confirm the new template's actual id with `templates_list` afterward before referencing it in another call. Use before experimental changes you may want to revert, or to build an A/B variant. With `is_alt: true` duplicates an alternative template, including its layers and `bindings` (main templates and levels). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_duplicate`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id to be duplicated
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

id number alwaysvždyvždymindig

template id
crop integer alwaysvždyvždymindig

crop image (0/1): when 1, a product image bigger than the template size (after `enlarge_by`) is cropped to it; when 0 (and `enlarge` = 1), it is downscaled to fit instead
name string alwaysvždyvždymindig

template name
type integer alwaysvždyvždymindig

ai template type
active integer alwaysvždyvždymindig

is template active
is_alt boolean

true for an alternative template (absent for main templates)
enlarge integer alwaysvždyvždymindig

is the product image resized to the template size (0/1); when 0, `enlarge_by`, `protection_zone` and the downscale-instead-of-crop behaviour are not applied and the image is placed in its original size
queries array of integer

list of template product query ids (main templates only)
size_id number alwaysvždyvždymindig

assigned size id, null if keep_original_size is set or no size is assigned yet
bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
bindings[].template_id integer alwaysvždyvždymindig

main template id
priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
active_to string

scheduled template active_to (main templates only)
background string alwaysvždyvždymindig

background color, hex format
enlarge_by enum alwaysvždyvždymindig

how the product image is resized to the template size (only when `enlarge` = 1), always keeping the aspect ratio: `fit` = fit the whole image inside the output dimensions, `width` = match the output width, `height` = match the output height, `smaller` = match by the image's smaller dimension, `bigger` = match by the image's bigger dimension; null = no resizing
active_from string

scheduled template active_from (main templates only)
is_autocrop integer alwaysvždyvždymindig

autocrop (0/1): trims uniform borders (e.g. white/transparent margins) around the product so it fills the available area better
translate_x integer alwaysvždyvždymindig

horizontal shift of the product image in px from its centered position (positive = right, negative = left)
translate_y integer alwaysvždyvždymindig

vertical shift of the product image in px from its centered position (positive = down, negative = up)
is_keep_size integer alwaysvždyvždymindig

is the template using each product's original image size instead of a fixed size (0/1)
shapes_count integer alwaysvždyvždymindig

number of layers on the template
protection_zone integer alwaysvždyvždymindig

protection zone in px applied on each side of the product image relative to the template size: positive = the image is shrunk and framed with the background color, negative = the image is enlarged over the template edges (with Outpainting, a negative value lets the AI extend the image). Ignored (0) when max image width/height is set

app_feedimageeditor_templates_get_size Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

Get a template's (or with `is_alt: true` an alternative template's) current output size — explicit width/height, or the preset it uses. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_get_size`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

id integer alwaysvždyvždymindig

size id, null when isKeepSize is true
name string alwaysvždyvždymindig

size name, null when isKeepSize is true
width integer alwaysvždyvždymindig

size width in px, null when isKeepSize is true
height integer alwaysvždyvždymindig

size height in px, null when isKeepSize is true
isKeepSize boolean alwaysvždyvždymindig

true when the template keeps the original image size (id, name, width and height are then null)

app_feedimageeditor_templates_get_status Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

Report a template's image generation progress for the products currently assigned to it: how many images rendered OK, failed, or are missing, plus pending re-render/re-download counts (only for active templates). Also returns the template's activity (`is_active`, scheduled `active_from`/`active_to`), product selection (`queries`) and `priority` (1 = highest). Use after creating, activating, or changing a template's product selection, before assuming its output images are ready. **How products get assigned:** products are assigned to templates only after the Mergado rule runs on the project, and each product goes to exactly one template — the highest-priority active template whose queries match it. So `total_products: 0` does not necessarily mean an error: the template may be inactive, the Mergado rule may not have run yet since the last change, or a higher-priority template with an overlapping product selection may have taken all its products (check with `templates_list` and change the order with `templates_reorder`). With `is_alt: true` reports an alternative template instead: how many alternative images it rendered OK (`status_ok`) or failed to render (`status_error`) out of `total_processed_alt_images` — the alternative images it applies to by its `bindings`. Only active alternative templates bound to active main templates are counted, each alternative image goes to the highest-priority alternative template that applies to it. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_get_status`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

type integer

ai template type (main templates only)
is_alt boolean

true for an alternative template (absent for main templates)
queries array of integer

list of template product query ids (main templates only)
bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
bindings[].template_id integer alwaysvždyvždymindig

main template id
priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only; null for an alternative template without bindings
active_to string

scheduled end of template activity (Y-m-d H:i:s, Europe/Prague), null if not scheduled (main templates only)
is_active boolean alwaysvždyvždymindig

is template active
status_ok number alwaysvždyvždymindig

count of products with a successfully rendered image; alternative templates: count of successfully rendered alternative images
project_id number alwaysvždyvždymindig

project id
active_from string

scheduled start of template activity (Y-m-d H:i:s, Europe/Prague), null if not scheduled (main templates only)
template_id number alwaysvždyvždymindig

template id
status_error number alwaysvždyvždymindig

count of products whose image failed to render; alternative templates: count of alternative images that failed to render
total_images number

total images rendered for the template (main templates only)
template_name string alwaysvždyvždymindig

template name
empty_elements number

count of products with empty feed element data (main templates only)
missing_images number

count of products without any image (main templates only)
total_products number

total products assigned to the template (main templates only)
checked_elements array

feed elements checked for empty data (main templates only)
total_alt_images number

total alternative images for the template (main templates only)
alt_images_status_ok number

count of the template's products' alternative images successfully rendered by its alternative templates (main templates only)
should_rerender_count number

count of products awaiting re-render, when the template is active
alt_images_status_error number

count of the template's products' alternative images that failed to render by its alternative templates (main templates only)
should_redownload_count number

count of images awaiting re-download, when the template is active
total_processed_alt_images number alwaysvždyvždymindig

total alternative images processed (main template: by its alternative templates; alternative template: by this alternative template)
visual_similarity_to_be_processed number

count of pending visual similarity tasks, when enabled

app_feedimageeditor_templates_layers_create Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Add a new layer to a template's canvas. Returns the new layer with all its fields and all template layers in their new stacking order with the basic fields only (id, type, name, priority, is_alt). Right before calling, re-read templates_layers_list and templates_get_size: another client (web editor, agent) may edit the template in parallel. Required fields by type: - text, textWithElements: text_content, text_fontsize; dynamicText (feed value as text): text_xml_element, text_fontsize; rating: rating_xml_element, text_fontsize; - other text layers with a text_content: text_fontsize and text_fontfamily too; - imageFromElements (image from a feed URL): image_xml_element; customSet (uploaded image): custom_set_id and custom_set_file_id from custom_images_upload; badge (built-in badge/sticker): set_id and set_file_id from external_image_search; - line, polygon, bezier, curvedText, textInsideShape: points (see templates_layers_points_guide). Text layers support emoji in text_content (e.g. "🔥 Sale"). Text layers support Pango markup in text_content (https://docs.gtk.org/Pango/pango_markup.html): , , , <s>, , , <big>, , <tt> and with attributes like foreground, background, font_weight, font_size, font_family (e.g. "-30 % Sale"); with markup, escape literal &, < and > as &, <, >. Markup caveats: line breaks (\n) inside markup render only with text_wrap = true; font_family takes a family name (e.g. 'Roboto'), not a fonts_list name like 'Roboto-Black' — for weight use font_weight (e.g. font_weight='900'). Every *_xml_element must exist in the project — never guess it. Colors (text, fill, stroke, gradients): unless the user specifies them, use the project's brand colors from custom_palettes_list (prefer the selected palette) and keep text readable against its background. Basic shapes (circle, ellipse, rectangle, square, rounded rectangle, corner/right triangle) MUST use the built-in shape types circle, ellipse, rectangle (square = equal width/height, rounded: corner_radius), triangle1 (right angle bottom right), triangle2 (right angle bottom left), even with no text inside (just omit text_content; fill = color, rotate/mirror with angle, is_flip, is_flop). Use polygon / bezier / textInsideShape only for outlines these types cannot draw (e.g. isosceles triangle, star, hexagon, arrow). Geometry (all types except dashedFrame): x/y/width/height are required, x/y is the layer CENTER. Unless asked otherwise the whole layer must fit the canvas: first scale width/height down to <= canvas width/height (keep the aspect ratio for images; moving x/y alone is not enough), then pick width / 2 <= x <= canvas width - width / 2 and height / 2 <= y <= canvas height - height / 2. dashedFrame (dashed border) always spans the whole canvas: width = line THICKNESS in px (e.g. 10), not the frame width; send x, y, height = 0; style it with color, dash_length, dash_density (gap) and margin_x / margin_y (inset). Stacking: a lower priority is rendered on top. Dynamic (feed-bound) layers — textWithElements, dynamicText, imageFromElements, rating — always stay above static ones (enforced). Omit priority to put the new layer on top of its group; move it later with templates_layers_reorder. sourceImage (also called product layer / product image / source image) is the static product image layer, at most one per template, usually the bottom layer (treat it as the bottom when not listed); other static layers such as a background may sit below it. Point-based layers (line, polygon, bezier, curvedText, textInsideShape): points are relative to the layer CENTER (positive y goes DOWN) and width/height must cover them; read templates_layers_points_guide first for the point format, sizing and examples. Clip mask (optional, all types except dashedFrame, incl. sourceImage): clip_mask = filled mask objects over the layer box; only the covered parts stay visible (union of all objects), invert_clip_mask = true cuts the covered parts out instead. The mask never draws anything. Unlike points, mask x/y is the object CENTER relative to the layer TOP-LEFT corner (x = width / 2, y = height / 2 is the middle); angle rotates clockwise. - rect: width, height (left half of a 400x300 layer: [{type:"rect",x:100,y:150,width:200,height:300}]); ellipse: width, height; circle: width = diameter (round photo in a 400x400 layer: [{type:"circle",x:200,y:200,width:400}]); - polygon: >= 3 points relative to the object center, closes itself (triangle in a 400x400 layer: [{type:"polygon",x:200,y:200,points:[{x:0,y:-200},{x:200,y:200},{x:-200,y:200}]}]); - bezier: >= 2 points {x, y, cx, cy} relative to the object center, smooth segments, cx/cy belongs to the end point, closes itself; polygon/bezier may have strokeWidth to widen the outline; - text: textContent, fontFamily (text_fontfamily values), fontSize — the layer shows through the letters (inverted: letters cut out). Prefer corner_radius over a clip mask for simple rounded rectangles. Alternative templates (is_alt: true, template_id = alternative template id): same as above, except textInsideShape, invert_clip_mask and text_padding are not supported. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_layers_create`.) PAID, per project. EDITS the photos already in the feed — watermark and background removal, upscale, outpainting, autocrop, price tags, logos — published at new URLs. Needed for any change to the picture itself; changing which URL the feed carries is a free core rule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

height number requiredpovinnépovinnékötelező

layer height; unless stated otherwise, must be <= canvas height (see templates_get_size) — scale the layer down if it would not fit; ignored for dashedFrame (send 0)
project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id, see templates_list
type enum requiredpovinnépovinnékötelező

shape type: circle = circle with optional text inside (kind of text layer); preferred for any plain circle; ellipse = ellipse with optional text inside (kind of text layer); preferred for any plain ellipse; rectangle = rectangle with optional text inside (kind of text layer); preferred for any plain rectangle/square; triangle1 = right triangle, right angle bottom right, with optional text inside (kind of text layer); preferred for plain right triangles; triangle2 = right triangle, right angle bottom left, with optional text inside (kind of text layer); preferred for plain right triangles; text = static text (kind of text layer); badge = built-in badge/sticker image (kind of image layer); needs set_id and set_file_id from external_image_search; dynamicText = text taken from a feed element value (kind of text layer, but text is from Mergado element); needs text_xml_element; textWithElements = static text with feed element placeholders, e.g. "Price: %PRICE_VAT%" (kind of text layer); imageFromElements = image loaded from a feed element URL (kind of image layer); customSet = image from a custom image set (kind of image layer); brush = freehand brush stroke; bezier = bezier curve path; curvedText = text along a curve (kind of text layer); circleText = text along a circle (kind of text layer); dashedFrame = dashed border around the whole canvas; x/y/height are ignored, width = line thickness, set color, dash_length, dash_density (gap) and margin_x/margin_y (inset); polygon = polygon defined by points; not for plain circles/rectangles/right triangles (use circle, rectangle, triangle1/2); line = straight line; textInsideShape = text inside a custom polygon shape (kind of text layer); externalImageSource = image from an external source (kind of image layer); rating = star rating taken from a feed element value (kind of text layer); sourceImage = the source product image (special kind of image layer)
width number requiredpovinnépovinnékötelező

layer width; unless stated otherwise, must be <= canvas width (see templates_get_size) — scale the layer down if it would not fit; for dashedFrame it is the line THICKNESS in px (e.g. 10), not the frame width
x number requiredpovinnépovinnékötelező

x position of the layer center; unless stated otherwise, keep the whole layer inside the canvas: width / 2 <= x <= canvas width - width / 2 (see templates_get_size); ignored for dashedFrame (send 0)
y number requiredpovinnépovinnékötelező

y position of the layer center; unless stated otherwise, keep the whole layer inside the canvas: height / 2 <= y <= canvas height - height / 2 (see templates_get_size); ignored for dashedFrame (send 0)
angle number optionalvolitelnévoliteľnéválasztható

rotation angle in degrees (0-360)
background string optionalvolitelnévoliteľnéválasztható

background color (hex)
clip_mask array optionalvolitelnévoliteľnéválasztható

clip mask of the layer: a list of filled mask objects; only the parts of the layer covered by at least one of them stay visible (with invert_clip_mask the covered parts are cut out instead). Omit for no mask (see the templates_layers_create description)
color string optionalvolitelnévoliteľnéválasztható

fill color (hex)
corner_radius number optionalvolitelnévoliteľnéválasztható

corner radius
custom_set_file_id number optionalvolitelnévoliteľnéválasztható

custom image set file id, required for type: customSet
custom_set_id number optionalvolitelnévoliteľnéválasztható

custom image set id
dash_density number optionalvolitelnévoliteľnéválasztható

dashedFrame only: length of the gap between two dashes in px (default 5; smaller = denser)
dash_length number optionalvolitelnévoliteľnéválasztható

dashedFrame only: length of one dash in px (default 60)
gradient_id number optionalvolitelnévoliteľnéválasztható

gradient id
has_reflection boolean optionalvolitelnévoliteľnéválasztható

whether the layer has a reflection effect
image_file_id number optionalvolitelnévoliteľnéválasztható

image file id
image_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the image, required for type: imageFromElements. Must be one of the elements available for the project.
invert_clip_mask boolean optionalvolitelnévoliteľnéválasztható

invert the clip_mask: hide the parts of the layer covered by the mask objects and keep the rest (default false = keep only the covered parts)
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.
is_aspect_size_ratio boolean optionalvolitelnévoliteľnéválasztható

keep aspect ratio when resizing
is_flip boolean optionalvolitelnévoliteľnéválasztható

flip vertically
is_flop boolean optionalvolitelnévoliteľnéválasztható

flip horizontally
is_hidden boolean optionalvolitelnévoliteľnéválasztható

whether the layer is hidden
is_locked boolean optionalvolitelnévoliteľnéválasztható

whether the layer is locked in the editor
is_remove_background boolean optionalvolitelnévoliteľnéválasztható

remove background of the layer image (e.g. custom set image)
layer_id number optionalvolitelnévoliteľnéválasztható

layer id to be updated, see templates_layers_list
letter_case enum optionalvolitelnévoliteľnéválasztható

letter case transform: 0 = keep, 1 = strtoupper, 2 = strtolower, 3 = ucfirst, 4 = lcfirst, 5 = ucwords
letter_spacing number optionalvolitelnévoliteľnéválasztható

letter spacing
line_cap enum optionalvolitelnévoliteľnéválasztható

line cap style: 2 = round, 3 = square
line_join enum optionalvolitelnévoliteľnéválasztható

line join style: 2 = round, 1 = miter
line_spacing number optionalvolitelnévoliteľnéválasztható

line spacing
margin_x number optionalvolitelnévoliteľnéválasztható

dashedFrame only: inset of the frame from the left and right canvas edges in px (default 0)
margin_y number optionalvolitelnévoliteľnéválasztható

dashedFrame only: inset of the frame from the top and bottom canvas edges in px (default 0)
name string optionalvolitelnévoliteľnéválasztható

layer name
opacity number optionalvolitelnévoliteľnéválasztható

opacity (0-100)
points array optionalvolitelnévoliteľnéválasztható

points of the shape, required for types: bezier, line, polygon, curvedText, textInsideShape (see templates_layers_points_guide for how to build them)
priority number optionalvolitelnévoliteľnéválasztható

priority; stacking position: 1 = top, a high number (e.g. 999) = bottom, below the product image (sourceImage), where the layer may be hidden behind the product. The other layers keep their order and priorities are renumbered;
rating_count_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the rating count. Must be one of the elements available for the project.
rating_hide_empty boolean optionalvolitelnévoliteľnéválasztható

hide empty stars
rating_max_value number optionalvolitelnévoliteľnéválasztható

maximum possible rating value from the feed
rating_min_stars number optionalvolitelnévoliteľnéválasztható

minimum number of stars to display
rating_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the rating value, required for type: rating. Must be one of the elements available for the project.
reflection_angle number optionalvolitelnévoliteľnéválasztható

reflection angle
reflection_flip boolean optionalvolitelnévoliteľnéválasztható

flip the reflection
reflection_offset number optionalvolitelnévoliteľnéválasztható

reflection offset
reflection_opacity number optionalvolitelnévoliteľnéválasztható

reflection opacity
scale number optionalvolitelnévoliteľnéválasztható

scale factor
set_file_id number optionalvolitelnévoliteľnéválasztható

built-in badge file id from external_image_search, required for type: badge
set_id number optionalvolitelnévoliteľnéválasztható

built-in badge set id from external_image_search, required for type: badge
shadow_color string optionalvolitelnévoliteľnéválasztható

shadow color (hex)
shadow_opacity number optionalvolitelnévoliteľnéválasztható

shadow opacity (0-100)
shadow_sigma number optionalvolitelnévoliteľnéválasztható

shadow blur sigma
shadow_xoffset number optionalvolitelnévoliteľnéválasztható

shadow x offset
shadow_yoffset number optionalvolitelnévoliteľnéválasztható

shadow y offset
star_symbol enum optionalvolitelnévoliteľnéválasztható

star symbol index
stroke_color string optionalvolitelnévoliteľnéválasztható

shape stroke color (hex)
stroke_width number optionalvolitelnévoliteľnéválasztható

shape stroke width
text_align enum optionalvolitelnévoliteľnéválasztható

horizontal text alignment: -1 = left, 0 = center, 1 = right
text_background_color string optionalvolitelnévoliteľnéválasztható

text background color (hex)
text_background_type enum optionalvolitelnévoliteľnéválasztható

text background shape type
text_color string optionalvolitelnévoliteľnéválasztható

text color (hex)
text_content string optionalvolitelnévoliteľnéválasztható

text content, required for type: text, textWithElements
text_decoration enum optionalvolitelnévoliteľnéválasztható

text decoration: 1 = no, 3 = overline, 4 = linethrough, 2 = underline
text_decoration_color string optionalvolitelnévoliteľnéválasztható

text decoration color (hex)
text_decoration_lineoverlap number optionalvolitelnévoliteľnéválasztható

text decoration line overlap (0-10)
text_decoration_linethickness number optionalvolitelnévoliteľnéválasztható

text decoration line thickness (0-10)
text_direction enum optionalvolitelnévoliteľnéválasztható

text direction: 0 = clockwise, 1 = counter-clockwise
text_fontfamily string optionalvolitelnévoliteľnéválasztható

font family
text_fontsize number optionalvolitelnévoliteľnéválasztható

font size in px (4-500), required for type: text, dynamicText, textWithElements, rating
text_orientation enum optionalvolitelnévoliteľnéválasztható

text orientation: 0 = horizontal, 1 = vertical
text_overflow enum optionalvolitelnévoliteľnéválasztható

text overflow behaviour: 0 = keep, 1 = fontsize, 2 = layersize
text_padding number optionalvolitelnévoliteľnéválasztható

text padding
text_stroke_color string optionalvolitelnévoliteľnéválasztható

text stroke color (hex)
text_stroke_underlayer enum optionalvolitelnévoliteľnéválasztható

is text stroke under the text (0/1) keeping the original font thickness
text_stroke_width number optionalvolitelnévoliteľnéválasztható

text stroke width
text_valign enum optionalvolitelnévoliteľnéválasztható

vertical text alignment: -1 = start, 0 = middle, 1 = end
text_wrap boolean optionalvolitelnévoliteľnéválasztható

wrap text onto multiple lines
text_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the text content, required for type: dynamicText. Must be one of the elements available for the project.
text_xml_element_formatter object optionalvolitelnévoliteľnéválasztható

formatter applied to the text_xml_element value, for type: dynamicText

OutputVýstupVýstupKimenet

layer object alwaysvždyvždymindig

the newly created layer with all its fields
layer.x integer alwaysvždyvždymindig

x position
layer.y integer alwaysvždyvždymindig

y position
layer.id number alwaysvždyvždymindig

layer id
layer.name string

layer name
layer.type string alwaysvždyvždymindig

layer type
layer.angle integer alwaysvždyvždymindig

rotation angle
layer.color string

fill color, hex format
layer.index string

internal layer index identifier
layer.lines array

line segment data
layer.scale number alwaysvždyvždymindig

scale factor
layer.width integer

layer width (for dashedFrame: line thickness in px)
layer.height integer

layer height
layer.points array

shape point coordinates
layer.set_id number

image set id
layer.is_flip integer alwaysvždyvždymindig

is layer flipped vertically (0/1)
layer.is_flop integer alwaysvždyvždymindig

is layer flipped horizontally (0/1)
layer.opacity integer

opacity 0-100
layer.line_cap integer

line cap style code
layer.margin_x integer

dashedFrame: inset from the left and right canvas edges in px
layer.margin_y integer

dashedFrame: inset from the top and bottom canvas edges in px
layer.priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top, higher value = drawn below. Dynamic layers use 1–200 (1 = topmost layer) and are always above static layers, which start at 201 (201 = topmost static layer)
layer.clip_mask array

clip mask objects (type rect|circle|ellipse|polygon|bezier|text, x/y = object center relative to the layer top-left corner, width, height, angle, points relative to the object center, textContent/fontFamily/fontSize); null = no mask
layer.is_hidden integer

is layer hidden (0/1)
layer.is_locked integer

is layer locked (0/1)
layer.line_join integer

line join style code
layer.text_wrap integer

is text wrap enabled (0/1)
layer.is_dynamic integer alwaysvždyvždymindig

is layer bound to a feed element (0/1)
layer.text_align integer

horizontal text alignment code
layer.text_color string

text color, hex format
layer.dash_length integer

dashedFrame: length of one dash in px
layer.gradient_id number

gradient id
layer.letter_case integer

letter case transform code
layer.set_file_id number

image set file id
layer.star_symbol integer

star symbol index
layer.template_id number alwaysvždyvždymindig

template id (the alternative template id for layers of an alternative template)
layer.text_valign integer

vertical text alignment code
layer.dash_density integer

dashedFrame: length of the gap between two dashes in px
layer.is_draggable integer alwaysvždyvždymindig

is layer draggable in the editor (0/1)
layer.line_spacing integer

line spacing
layer.shadow_color string

shadow color, hex format
layer.shadow_sigma integer

shadow blur sigma
layer.stroke_color string

shape stroke color, hex format
layer.stroke_width integer

shape stroke width
layer.text_content string

static text content
layer.text_padding integer

text padding
layer.brush_strokes array

brush stroke data
layer.corner_radius integer

corner radius
layer.custom_set_id number

custom image set id
layer.image_file_id number

image file id
layer.text_fontsize integer

text font size
layer.text_overflow integer

text overflow handling code
layer.has_reflection integer

does layer have a reflection effect (0/1)
layer.letter_spacing integer

letter spacing
layer.shadow_opacity integer

shadow opacity 0-100
layer.shadow_xoffset integer

shadow x offset
layer.shadow_yoffset integer

shadow y offset
layer.text_direction integer

text direction: 0=clockwise, 1=counter-clockwise
layer.reflection_flip integer

is the reflection flipped (0/1)
layer.text_decoration integer

text decoration code
layer.text_fontfamily string

text font family, see text_fontfamily in fonts_list
layer.invert_clip_mask integer

is the clip mask inverted (0/1): 0 = only the parts covered by clip_mask stay visible, 1 = the covered parts are cut out
layer.rating_max_value number

maximum possible rating value from the feed
layer.rating_min_stars number

minimum number of stars to display
layer.reflection_angle integer

reflection angle
layer.text_orientation integer

text orientation: 0=horizontal, 1=vertical
layer.text_xml_element string

feed XML element bound to the text content
layer.image_xml_element string

feed XML element bound to the image
layer.rating_hide_empty integer

hide empty stars (0/1)
layer.reflection_offset integer

reflection offset
layer.text_stroke_color string

text stroke color, hex format
layer.text_stroke_width integer

text stroke width
layer.custom_set_file_id number

custom image set file id
layer.rating_xml_element string

feed XML element bound to the rating value
layer.reflection_opacity integer

reflection opacity
layer.is_aspect_size_ratio integer

does layer keep aspect ratio (0/1)
layer.is_remove_background integer

e.g. custom set image may be implemented with removed background (0/1)
layer.text_background_type string

text background shape: none|ellipse|circle|rectangle|image|rectangle-each-line
layer.external_image_prompt string

prompt used to generate the external image
layer.text_background_color string

text background color, hex format
layer.text_decoration_color string

text decoration color, hex format
layer.text_stroke_underlayer integer

is text stroke under the text (0/1) keeping the original font thickness
layer.rating_count_xml_element string

feed XML element bound to the rating count
layer.text_xml_element_formatter string

formatter applied to the text_xml_element value
layer.text_decoration_lineoverlap integer

text decoration line overlap
layer.text_decoration_linethickness integer

text decoration line thickness
layers array of object alwaysvždyvždymindig

all the template layers in their new stacking order, including the newly created one, with the basic fields only (use templates_layers_list for all the fields)
layers[].id number alwaysvždyvždymindig

layer id
layers[].name string

layer name
layers[].type string alwaysvždyvždymindig

layer type
layers[].is_alt boolean alwaysvždyvždymindig

is the layer in an alternative template
layers[].priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top. Dynamic layers use 1–200, static layers start at 201

app_feedimageeditor_templates_layers_delete Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Permanently delete one layer from a template. Get the layer_id from `templates_layers_list` first — only layers of the given template can be deleted. This cannot be undone: confirm with the user before calling, naming the layer (its type and text/content), not just its id. To delete several layers, call this tool once per layer. Returns `deleted_layer` (the layer's state right before deletion, enough to recreate it with `templates_layers_create` if needed) and `layers` (the template's remaining layers in stacking order with the basic fields only: id, type, name, priority, is_alt); the priorities of the remaining layers are not renumbered. The template can be edited in parallel by another client (the web editor or another agent): right before calling, re-read the layers with `templates_layers_list` and check the layer still exists and is the one the user confirmed — layer ids and contents may have changed since you last looked. For a layer of an alternative template pass `is_alt: true` (layer ids of main and alternative templates are separate). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_layers_delete`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

layer_id integer requiredpovinnépovinnékötelező

Id of the layer to delete. See `templates_layers_list`.
project_id integer requiredpovinnépovinnékötelező

Project id.
template_id integer requiredpovinnépovinnékötelező

Id of the template the layer belongs to. See `templates_list`.
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

layers array of object alwaysvždyvždymindig

The remaining template layers in stacking order (ascending priority, first = top) with the basic fields only (use templates_layers_list for all the fields).
layers[].id number alwaysvždyvždymindig

layer id
layers[].name string

layer name
layers[].type string alwaysvždyvždymindig

layer type
layers[].is_alt boolean alwaysvždyvždymindig

is the layer in an alternative template
layers[].priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top. Dynamic layers use 1–200, static layers start at 201
deleted_layer object alwaysvždyvždymindig

The deleted layer as it was right before deletion.
deleted_layer.x integer alwaysvždyvždymindig

x position
deleted_layer.y integer alwaysvždyvždymindig

y position
deleted_layer.id number alwaysvždyvždymindig

layer id
deleted_layer.name string

layer name
deleted_layer.type string alwaysvždyvždymindig

layer type
deleted_layer.angle integer alwaysvždyvždymindig

rotation angle
deleted_layer.color string

fill color, hex format
deleted_layer.index string

internal layer index identifier
deleted_layer.lines array

line segment data
deleted_layer.scale number alwaysvždyvždymindig

scale factor
deleted_layer.width integer

layer width (for dashedFrame: line thickness in px)
deleted_layer.height integer

layer height
deleted_layer.points array

shape point coordinates
deleted_layer.set_id number

image set id
deleted_layer.is_flip integer alwaysvždyvždymindig

is layer flipped vertically (0/1)
deleted_layer.is_flop integer alwaysvždyvždymindig

is layer flipped horizontally (0/1)
deleted_layer.opacity integer

opacity 0-100
deleted_layer.line_cap integer

line cap style code
deleted_layer.margin_x integer

dashedFrame: inset from the left and right canvas edges in px
deleted_layer.margin_y integer

dashedFrame: inset from the top and bottom canvas edges in px
deleted_layer.priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top, higher value = drawn below. Dynamic layers use 1–200 (1 = topmost layer) and are always above static layers, which start at 201 (201 = topmost static layer)
deleted_layer.clip_mask array

clip mask objects (type rect|circle|ellipse|polygon|bezier|text, x/y = object center relative to the layer top-left corner, width, height, angle, points relative to the object center, textContent/fontFamily/fontSize); null = no mask
deleted_layer.is_hidden integer

is layer hidden (0/1)
deleted_layer.is_locked integer

is layer locked (0/1)
deleted_layer.line_join integer

line join style code
deleted_layer.text_wrap integer

is text wrap enabled (0/1)
deleted_layer.is_dynamic integer alwaysvždyvždymindig

is layer bound to a feed element (0/1)
deleted_layer.text_align integer

horizontal text alignment code
deleted_layer.text_color string

text color, hex format
deleted_layer.dash_length integer

dashedFrame: length of one dash in px
deleted_layer.gradient_id number

gradient id
deleted_layer.letter_case integer

letter case transform code
deleted_layer.set_file_id number

image set file id
deleted_layer.star_symbol integer

star symbol index
deleted_layer.template_id number alwaysvždyvždymindig

template id (the alternative template id for layers of an alternative template)
deleted_layer.text_valign integer

vertical text alignment code
deleted_layer.dash_density integer

dashedFrame: length of the gap between two dashes in px
deleted_layer.is_draggable integer alwaysvždyvždymindig

is layer draggable in the editor (0/1)
deleted_layer.line_spacing integer

line spacing
deleted_layer.shadow_color string

shadow color, hex format
deleted_layer.shadow_sigma integer

shadow blur sigma
deleted_layer.stroke_color string

shape stroke color, hex format
deleted_layer.stroke_width integer

shape stroke width
deleted_layer.text_content string

static text content
deleted_layer.text_padding integer

text padding
deleted_layer.brush_strokes array

brush stroke data
deleted_layer.corner_radius integer

corner radius
deleted_layer.custom_set_id number

custom image set id
deleted_layer.image_file_id number

image file id
deleted_layer.text_fontsize integer

text font size
deleted_layer.text_overflow integer

text overflow handling code
deleted_layer.has_reflection integer

does layer have a reflection effect (0/1)
deleted_layer.letter_spacing integer

letter spacing
deleted_layer.shadow_opacity integer

shadow opacity 0-100
deleted_layer.shadow_xoffset integer

shadow x offset
deleted_layer.shadow_yoffset integer

shadow y offset
deleted_layer.text_direction integer

text direction: 0=clockwise, 1=counter-clockwise
deleted_layer.reflection_flip integer

is the reflection flipped (0/1)
deleted_layer.text_decoration integer

text decoration code
deleted_layer.text_fontfamily string

text font family, see text_fontfamily in fonts_list
deleted_layer.invert_clip_mask integer

is the clip mask inverted (0/1): 0 = only the parts covered by clip_mask stay visible, 1 = the covered parts are cut out
deleted_layer.rating_max_value number

maximum possible rating value from the feed
deleted_layer.rating_min_stars number

minimum number of stars to display
deleted_layer.reflection_angle integer

reflection angle
deleted_layer.text_orientation integer

text orientation: 0=horizontal, 1=vertical
deleted_layer.text_xml_element string

feed XML element bound to the text content
deleted_layer.image_xml_element string

feed XML element bound to the image
deleted_layer.rating_hide_empty integer

hide empty stars (0/1)
deleted_layer.reflection_offset integer

reflection offset
deleted_layer.text_stroke_color string

text stroke color, hex format
deleted_layer.text_stroke_width integer

text stroke width
deleted_layer.custom_set_file_id number

custom image set file id
deleted_layer.rating_xml_element string

feed XML element bound to the rating value
deleted_layer.reflection_opacity integer

reflection opacity
deleted_layer.is_aspect_size_ratio integer

does layer keep aspect ratio (0/1)
deleted_layer.is_remove_background integer

e.g. custom set image may be implemented with removed background (0/1)
deleted_layer.text_background_type string

text background shape: none|ellipse|circle|rectangle|image|rectangle-each-line
deleted_layer.external_image_prompt string

prompt used to generate the external image
deleted_layer.text_background_color string

text background color, hex format
deleted_layer.text_decoration_color string

text decoration color, hex format
deleted_layer.text_stroke_underlayer integer

is text stroke under the text (0/1) keeping the original font thickness
deleted_layer.rating_count_xml_element string

feed XML element bound to the rating count
deleted_layer.text_xml_element_formatter string

formatter applied to the text_xml_element value
deleted_layer.text_decoration_lineoverlap integer

text decoration line overlap
deleted_layer.text_decoration_linethickness integer

text decoration line thickness

app_feedimageeditor_templates_layers_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List a template's layers (text, feed elements, graphics, shapes, emoji, uploaded images) in their current stacking order. The first layer is on top; a lower priority means higher in the stack. Call before `templates_layers_reorder` to see the current order and layer count, and again afterward to confirm the result actually applied. Templates can be edited in parallel by another client (the web editor or another agent), so this result is only a snapshot: call it again right before each layer write (`templates_layers_create`, `templates_layers_update`, `templates_layers_delete`, `templates_layers_reorder`) instead of reusing an earlier result. With `is_alt: true` lists the layers of an alternative template (pass the same `is_alt` to the other `templates_layers_*` tools: layer ids of main and alternative templates are separate). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_layers_list`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template_id
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

layers array of object alwaysvždyvždymindig

list of the template layers
layers[].x integer alwaysvždyvždymindig

x position
layers[].y integer alwaysvždyvždymindig

y position
layers[].id number alwaysvždyvždymindig

layer id
layers[].name string

layer name
layers[].type string alwaysvždyvždymindig

layer type
layers[].angle integer alwaysvždyvždymindig

rotation angle
layers[].color string

fill color, hex format
layers[].index string

internal layer index identifier
layers[].lines array

line segment data
layers[].scale number alwaysvždyvždymindig

scale factor
layers[].width integer

layer width (for dashedFrame: line thickness in px)
layers[].height integer

layer height
layers[].points array

shape point coordinates
layers[].set_id number

image set id
layers[].is_flip integer alwaysvždyvždymindig

is layer flipped vertically (0/1)
layers[].is_flop integer alwaysvždyvždymindig

is layer flipped horizontally (0/1)
layers[].opacity integer

opacity 0-100
layers[].line_cap integer

line cap style code
layers[].margin_x integer

dashedFrame: inset from the left and right canvas edges in px
layers[].margin_y integer

dashedFrame: inset from the top and bottom canvas edges in px
layers[].priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top, higher value = drawn below. Dynamic layers use 1–200 (1 = topmost layer) and are always above static layers, which start at 201 (201 = topmost static layer)
layers[].clip_mask array

clip mask objects (type rect|circle|ellipse|polygon|bezier|text, x/y = object center relative to the layer top-left corner, width, height, angle, points relative to the object center, textContent/fontFamily/fontSize); null = no mask
layers[].is_hidden integer

is layer hidden (0/1)
layers[].is_locked integer

is layer locked (0/1)
layers[].line_join integer

line join style code
layers[].text_wrap integer

is text wrap enabled (0/1)
layers[].is_dynamic integer alwaysvždyvždymindig

is layer bound to a feed element (0/1)
layers[].text_align integer

horizontal text alignment code
layers[].text_color string

text color, hex format
layers[].dash_length integer

dashedFrame: length of one dash in px
layers[].gradient_id number

gradient id
layers[].letter_case integer

letter case transform code
layers[].set_file_id number

image set file id
layers[].star_symbol integer

star symbol index
layers[].template_id number alwaysvždyvždymindig

template id (the alternative template id for layers of an alternative template)
layers[].text_valign integer

vertical text alignment code
layers[].dash_density integer

dashedFrame: length of the gap between two dashes in px
layers[].is_draggable integer alwaysvždyvždymindig

is layer draggable in the editor (0/1)
layers[].line_spacing integer

line spacing
layers[].shadow_color string

shadow color, hex format
layers[].shadow_sigma integer

shadow blur sigma
layers[].stroke_color string

shape stroke color, hex format
layers[].stroke_width integer

shape stroke width
layers[].text_content string

static text content
layers[].text_padding integer

text padding
layers[].brush_strokes array

brush stroke data
layers[].corner_radius integer

corner radius
layers[].custom_set_id number

custom image set id
layers[].image_file_id number

image file id
layers[].text_fontsize integer

text font size
layers[].text_overflow integer

text overflow handling code
layers[].has_reflection integer

does layer have a reflection effect (0/1)
layers[].letter_spacing integer

letter spacing
layers[].shadow_opacity integer

shadow opacity 0-100
layers[].shadow_xoffset integer

shadow x offset
layers[].shadow_yoffset integer

shadow y offset
layers[].text_direction integer

text direction: 0=clockwise, 1=counter-clockwise
layers[].reflection_flip integer

is the reflection flipped (0/1)
layers[].text_decoration integer

text decoration code
layers[].text_fontfamily string

text font family, see text_fontfamily in fonts_list
layers[].invert_clip_mask integer

is the clip mask inverted (0/1): 0 = only the parts covered by clip_mask stay visible, 1 = the covered parts are cut out
layers[].rating_max_value number

maximum possible rating value from the feed
layers[].rating_min_stars number

minimum number of stars to display
layers[].reflection_angle integer

reflection angle
layers[].text_orientation integer

text orientation: 0=horizontal, 1=vertical
layers[].text_xml_element string

feed XML element bound to the text content
layers[].image_xml_element string

feed XML element bound to the image
layers[].rating_hide_empty integer

hide empty stars (0/1)
layers[].reflection_offset integer

reflection offset
layers[].text_stroke_color string

text stroke color, hex format
layers[].text_stroke_width integer

text stroke width
layers[].custom_set_file_id number

custom image set file id
layers[].rating_xml_element string

feed XML element bound to the rating value
layers[].reflection_opacity integer

reflection opacity
layers[].is_aspect_size_ratio integer

does layer keep aspect ratio (0/1)
layers[].is_remove_background integer

e.g. custom set image may be implemented with removed background (0/1)
layers[].text_background_type string

text background shape: none|ellipse|circle|rectangle|image|rectangle-each-line
layers[].external_image_prompt string

prompt used to generate the external image
layers[].text_background_color string

text background color, hex format
layers[].text_decoration_color string

text decoration color, hex format
layers[].text_stroke_underlayer integer

is text stroke under the text (0/1) keeping the original font thickness
layers[].rating_count_xml_element string

feed XML element bound to the rating count
layers[].text_xml_element_formatter string

formatter applied to the text_xml_element value
layers[].text_decoration_lineoverlap integer

text decoration line overlap
layers[].text_decoration_linethickness integer

text decoration line thickness

app_feedimageeditor_templates_layers_points_guide Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

How to build `points` (and width/height) of the point-based layers line, polygon, bezier, curvedText and textInsideShape. Read it before creating such a layer or changing its points with templates_layers_create / templates_layers_update. No project id needed. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_layers_points_guide`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

This tool does not describe its output.Tento nástroj nepopisuje svůj výstup.Tento nástroj nepopisuje svoj výstup.Ez az eszköz nem írja le a kimenetét.

app_feedimageeditor_templates_layers_reorder Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Change the stacking order of a template's layers. Pass layer ids in ordered_layer_ids from top to bottom: the first id is rendered on top, the last one at the bottom (covered by all layers above it). The array must contain every layer of the template exactly once. All dynamic layers (`is_dynamic: true`, bound to feed data) must come before all static layers, because dynamic layers are always drawn above static ones; any other order is rejected. The template can be edited in parallel (the web editor or another agent), so build ordered_layer_ids from a `templates_layers_list` call made right before this one. For an alternative template pass `is_alt: true`. Returns all template layers in their new order with the basic fields only (id, type, name, priority, is_alt). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_layers_reorder`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

ordered_layer_ids array requiredpovinnépovinnékötelező

Every layer id of the template exactly once, ordered from top (first) to bottom (last). Dynamic layers must come before static layers. See `templates_layers_list` to get layer `id`s and `is_dynamic`.
project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template_id
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.

OutputVýstupVýstupKimenet

layers array of object alwaysvždyvždymindig

list of the template layers in their new order with the basic fields only (use templates_layers_list for all the fields)
layers[].id number alwaysvždyvždymindig

layer id
layers[].name string

layer name
layers[].type string alwaysvždyvždymindig

layer type
layers[].is_alt boolean alwaysvždyvždymindig

is the layer in an alternative template
layers[].priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top. Dynamic layers use 1–200, static layers start at 201

app_feedimageeditor_templates_layers_update Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Update an existing layer's properties (position, size, text, styling — same fields as templates_layers_create). Returns the updated layer with all its fields and all template layers in their stacking order with the basic fields only (id, type, name, priority, is_alt). The layer is uniquely identified by its layer_id (see id returned by templates_layers_list). Required: project_id, layer_id. Optional: template_id (validated against the layer if given). For a layer of an alternative template pass is_alt: true (layer ids of main and alternative templates are separate; textInsideShape, invert_clip_mask and text_padding are not supported there). Send only the fields you want to change; omitted fields keep their current values. `type` cannot be changed. Text layers support emoji in text_content (e.g. "🔥 Sale"). Text layers support Pango markup in text_content (https://docs.gtk.org/Pango/pango_markup.html): , , , <s>, , , <big>, , <tt> and with attributes like foreground, background, font_weight, font_size, font_family (e.g. "-30 % Sale"); with markup, escape literal &, < and > as &, <, >. Markup caveats: line breaks (\n) inside markup render only with text_wrap = true; font_family takes a family name (e.g. 'Roboto'), not a fonts_list name like 'Roboto-Black' — for weight use font_weight (e.g. font_weight='900'). line, polygon, bezier, curvedText and textInsideShape layers: points replaces ALL the points of the shape (same format as in templates_layers_create, see templates_layers_points_guide; relative to the layer center), so send the complete list, and send width/height that fit the new points too. Points of other layer types cannot be changed. textInsideShape text lines are measured again when points, text_fontsize or line_spacing change. clip_mask replaces the whole mask (same format as in templates_layers_create), so send the complete list; send [] to remove it. The mask is NOT rescaled when width/height change: scale its x/y/width/height/points by the same ratio and send it too. invert_clip_mask can be changed alone. dashedFrame layers always span the whole canvas: change width (line thickness in px), color, dash_length (dash length in px), dash_density (gap between dashes in px) and margin_x / margin_y (inset from the canvas edges in px); x, y and height have no effect. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_layers_update`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

layer_id number requiredpovinnépovinnékötelező

layer id to be updated, see templates_layers_list
project_id number requiredpovinnépovinnékötelező

project id
angle number optionalvolitelnévoliteľnéválasztható

rotation angle in degrees (0-360)
background string optionalvolitelnévoliteľnéválasztható

background color (hex)
clip_mask array optionalvolitelnévoliteľnéválasztható

clip mask of the layer: a list of filled mask objects; only the parts of the layer covered by at least one of them stay visible (with invert_clip_mask the covered parts are cut out instead). Replaces the whole mask, send the complete list; send [] to remove the mask. The mask is not rescaled when width/height change — send a rescaled clip_mask too (see the templates_layers_create description)
color string optionalvolitelnévoliteľnéválasztható

fill color (hex)
corner_radius number optionalvolitelnévoliteľnéválasztható

corner radius
custom_set_file_id number optionalvolitelnévoliteľnéválasztható

custom image set file id, required for type: customSet
custom_set_id number optionalvolitelnévoliteľnéválasztható

custom image set id
dash_density number optionalvolitelnévoliteľnéválasztható

dashedFrame only: length of the gap between two dashes in px (default 5; smaller = denser)
dash_length number optionalvolitelnévoliteľnéválasztható

dashedFrame only: length of one dash in px (default 60)
gradient_id number optionalvolitelnévoliteľnéválasztható

gradient id
has_reflection boolean optionalvolitelnévoliteľnéválasztható

whether the layer has a reflection effect
height number optionalvolitelnévoliteľnéválasztható

layer height; ignored for dashedFrame (send 0)
image_file_id number optionalvolitelnévoliteľnéválasztható

image file id
image_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the image, required for type: imageFromElements. Must be one of the elements available for the project.
invert_clip_mask boolean optionalvolitelnévoliteľnéválasztható

invert the clip_mask: hide the parts of the layer covered by the mask objects and keep the rest (default false = keep only the covered parts)
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.
is_aspect_size_ratio boolean optionalvolitelnévoliteľnéválasztható

keep aspect ratio when resizing
is_flip boolean optionalvolitelnévoliteľnéválasztható

flip vertically
is_flop boolean optionalvolitelnévoliteľnéválasztható

flip horizontally
is_hidden boolean optionalvolitelnévoliteľnéválasztható

whether the layer is hidden
is_locked boolean optionalvolitelnévoliteľnéválasztható

whether the layer is locked in the editor
is_remove_background boolean optionalvolitelnévoliteľnéválasztható

remove background of the layer image (e.g. custom set image)
letter_case enum optionalvolitelnévoliteľnéválasztható

letter case transform: 0 = keep, 1 = strtoupper, 2 = strtolower, 3 = ucfirst, 4 = lcfirst, 5 = ucwords
letter_spacing number optionalvolitelnévoliteľnéválasztható

letter spacing
line_cap enum optionalvolitelnévoliteľnéválasztható

line cap style: 2 = round, 3 = square
line_join enum optionalvolitelnévoliteľnéválasztható

line join style: 2 = round, 1 = miter
line_spacing number optionalvolitelnévoliteľnéválasztható

line spacing
margin_x number optionalvolitelnévoliteľnéválasztható

dashedFrame only: inset of the frame from the left and right canvas edges in px (default 0)
margin_y number optionalvolitelnévoliteľnéválasztható

dashedFrame only: inset of the frame from the top and bottom canvas edges in px (default 0)
name string optionalvolitelnévoliteľnéválasztható

layer name
opacity number optionalvolitelnévoliteľnéválasztható

opacity (0-100)
points array optionalvolitelnévoliteľnéválasztható

points of the shape, only for types: bezier, line, polygon, curvedText, textInsideShape (see templates_layers_points_guide for how to build them); replaces all the points, send width/height (and x/y) that fit the new points too
priority number optionalvolitelnévoliteľnéválasztható

priority; stacking position: 1 = top, a high number (e.g. 999) = bottom, below the product image (sourceImage), where the layer may be hidden behind the product. The other layers keep their order and priorities are renumbered;
rating_count_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the rating count. Must be one of the elements available for the project.
rating_hide_empty boolean optionalvolitelnévoliteľnéválasztható

hide empty stars
rating_max_value number optionalvolitelnévoliteľnéválasztható

maximum possible rating value from the feed
rating_min_stars number optionalvolitelnévoliteľnéválasztható

minimum number of stars to display
rating_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the rating value, required for type: rating. Must be one of the elements available for the project.
reflection_angle number optionalvolitelnévoliteľnéválasztható

reflection angle
reflection_flip boolean optionalvolitelnévoliteľnéválasztható

flip the reflection
reflection_offset number optionalvolitelnévoliteľnéválasztható

reflection offset
reflection_opacity number optionalvolitelnévoliteľnéválasztható

reflection opacity
scale number optionalvolitelnévoliteľnéválasztható

scale factor
set_file_id number optionalvolitelnévoliteľnéválasztható

built-in badge file id from external_image_search, required for type: badge
set_id number optionalvolitelnévoliteľnéválasztható

built-in badge set id from external_image_search, required for type: badge
shadow_color string optionalvolitelnévoliteľnéválasztható

shadow color (hex)
shadow_opacity number optionalvolitelnévoliteľnéválasztható

shadow opacity (0-100)
shadow_sigma number optionalvolitelnévoliteľnéválasztható

shadow blur sigma
shadow_xoffset number optionalvolitelnévoliteľnéválasztható

shadow x offset
shadow_yoffset number optionalvolitelnévoliteľnéválasztható

shadow y offset
star_symbol enum optionalvolitelnévoliteľnéválasztható

star symbol index
stroke_color string optionalvolitelnévoliteľnéválasztható

shape stroke color (hex)
stroke_width number optionalvolitelnévoliteľnéválasztható

shape stroke width
template_id number optionalvolitelnévoliteľnéválasztható

template id, see templates_list
text_align enum optionalvolitelnévoliteľnéválasztható

horizontal text alignment: -1 = left, 0 = center, 1 = right
text_background_color string optionalvolitelnévoliteľnéválasztható

text background color (hex)
text_background_type enum optionalvolitelnévoliteľnéválasztható

text background shape type
text_color string optionalvolitelnévoliteľnéválasztható

text color (hex)
text_content string optionalvolitelnévoliteľnéválasztható

text content, required for type: text, textWithElements
text_decoration enum optionalvolitelnévoliteľnéválasztható

text decoration: 1 = no, 3 = overline, 4 = linethrough, 2 = underline
text_decoration_color string optionalvolitelnévoliteľnéválasztható

text decoration color (hex)
text_decoration_lineoverlap number optionalvolitelnévoliteľnéválasztható

text decoration line overlap (0-10)
text_decoration_linethickness number optionalvolitelnévoliteľnéválasztható

text decoration line thickness (0-10)
text_direction enum optionalvolitelnévoliteľnéválasztható

text direction: 0 = clockwise, 1 = counter-clockwise
text_fontfamily string optionalvolitelnévoliteľnéválasztható

font family
text_fontsize number optionalvolitelnévoliteľnéválasztható

font size in px (4-500), required for type: text, dynamicText, textWithElements, rating
text_orientation enum optionalvolitelnévoliteľnéválasztható

text orientation: 0 = horizontal, 1 = vertical
text_overflow enum optionalvolitelnévoliteľnéválasztható

text overflow behaviour: 0 = keep, 1 = fontsize, 2 = layersize
text_padding number optionalvolitelnévoliteľnéválasztható

text padding
text_stroke_color string optionalvolitelnévoliteľnéválasztható

text stroke color (hex)
text_stroke_underlayer enum optionalvolitelnévoliteľnéválasztható

is text stroke under the text (0/1) keeping the original font thickness
text_stroke_width number optionalvolitelnévoliteľnéválasztható

text stroke width
text_valign enum optionalvolitelnévoliteľnéválasztható

vertical text alignment: -1 = start, 0 = middle, 1 = end
text_wrap boolean optionalvolitelnévoliteľnéválasztható

wrap text onto multiple lines
text_xml_element string optionalvolitelnévoliteľnéválasztható

feed XML element for the text content, required for type: dynamicText. Must be one of the elements available for the project.
text_xml_element_formatter object optionalvolitelnévoliteľnéválasztható

formatter applied to the text_xml_element value, for type: dynamicText
type enum optionalvolitelnévoliteľnéválasztható

shape type: circle = circle with optional text inside (kind of text layer); preferred for any plain circle; ellipse = ellipse with optional text inside (kind of text layer); preferred for any plain ellipse; rectangle = rectangle with optional text inside (kind of text layer); preferred for any plain rectangle/square; triangle1 = right triangle, right angle bottom right, with optional text inside (kind of text layer); preferred for plain right triangles; triangle2 = right triangle, right angle bottom left, with optional text inside (kind of text layer); preferred for plain right triangles; text = static text (kind of text layer); badge = built-in badge/sticker image (kind of image layer); needs set_id and set_file_id from external_image_search; dynamicText = text taken from a feed element value (kind of text layer, but text is from Mergado element); needs text_xml_element; textWithElements = static text with feed element placeholders, e.g. "Price: %PRICE_VAT%" (kind of text layer); imageFromElements = image loaded from a feed element URL (kind of image layer); customSet = image from a custom image set (kind of image layer); brush = freehand brush stroke; bezier = bezier curve path; curvedText = text along a curve (kind of text layer); circleText = text along a circle (kind of text layer); dashedFrame = dashed border around the whole canvas; x/y/height are ignored, width = line thickness, set color, dash_length, dash_density (gap) and margin_x/margin_y (inset); polygon = polygon defined by points; not for plain circles/rectangles/right triangles (use circle, rectangle, triangle1/2); line = straight line; textInsideShape = text inside a custom polygon shape (kind of text layer); externalImageSource = image from an external source (kind of image layer); rating = star rating taken from a feed element value (kind of text layer); sourceImage = the source product image (special kind of image layer)
width number optionalvolitelnévoliteľnéválasztható

layer width; for dashedFrame it is the line THICKNESS in px (e.g. 10), not the frame width
x number optionalvolitelnévoliteľnéválasztható

x position of the layer center; ignored for dashedFrame (send 0)
y number optionalvolitelnévoliteľnéválasztható

y position of the layer center; ignored for dashedFrame (send 0)

OutputVýstupVýstupKimenet

layer object alwaysvždyvždymindig

the updated layer with all its fields
layer.x integer alwaysvždyvždymindig

x position
layer.y integer alwaysvždyvždymindig

y position
layer.id number alwaysvždyvždymindig

layer id
layer.name string

layer name
layer.type string alwaysvždyvždymindig

layer type
layer.angle integer alwaysvždyvždymindig

rotation angle
layer.color string

fill color, hex format
layer.index string

internal layer index identifier
layer.lines array

line segment data
layer.scale number alwaysvždyvždymindig

scale factor
layer.width integer

layer width (for dashedFrame: line thickness in px)
layer.height integer

layer height
layer.points array

shape point coordinates
layer.set_id number

image set id
layer.is_flip integer alwaysvždyvždymindig

is layer flipped vertically (0/1)
layer.is_flop integer alwaysvždyvždymindig

is layer flipped horizontally (0/1)
layer.opacity integer

opacity 0-100
layer.line_cap integer

line cap style code
layer.margin_x integer

dashedFrame: inset from the left and right canvas edges in px
layer.margin_y integer

dashedFrame: inset from the top and bottom canvas edges in px
layer.priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top, higher value = drawn below. Dynamic layers use 1–200 (1 = topmost layer) and are always above static layers, which start at 201 (201 = topmost static layer)
layer.clip_mask array

clip mask objects (type rect|circle|ellipse|polygon|bezier|text, x/y = object center relative to the layer top-left corner, width, height, angle, points relative to the object center, textContent/fontFamily/fontSize); null = no mask
layer.is_hidden integer

is layer hidden (0/1)
layer.is_locked integer

is layer locked (0/1)
layer.line_join integer

line join style code
layer.text_wrap integer

is text wrap enabled (0/1)
layer.is_dynamic integer alwaysvždyvždymindig

is layer bound to a feed element (0/1)
layer.text_align integer

horizontal text alignment code
layer.text_color string

text color, hex format
layer.dash_length integer

dashedFrame: length of one dash in px
layer.gradient_id number

gradient id
layer.letter_case integer

letter case transform code
layer.set_file_id number

image set file id
layer.star_symbol integer

star symbol index
layer.template_id number alwaysvždyvždymindig

template id (the alternative template id for layers of an alternative template)
layer.text_valign integer

vertical text alignment code
layer.dash_density integer

dashedFrame: length of the gap between two dashes in px
layer.is_draggable integer alwaysvždyvždymindig

is layer draggable in the editor (0/1)
layer.line_spacing integer

line spacing
layer.shadow_color string

shadow color, hex format
layer.shadow_sigma integer

shadow blur sigma
layer.stroke_color string

shape stroke color, hex format
layer.stroke_width integer

shape stroke width
layer.text_content string

static text content
layer.text_padding integer

text padding
layer.brush_strokes array

brush stroke data
layer.corner_radius integer

corner radius
layer.custom_set_id number

custom image set id
layer.image_file_id number

image file id
layer.text_fontsize integer

text font size
layer.text_overflow integer

text overflow handling code
layer.has_reflection integer

does layer have a reflection effect (0/1)
layer.letter_spacing integer

letter spacing
layer.shadow_opacity integer

shadow opacity 0-100
layer.shadow_xoffset integer

shadow x offset
layer.shadow_yoffset integer

shadow y offset
layer.text_direction integer

text direction: 0=clockwise, 1=counter-clockwise
layer.reflection_flip integer

is the reflection flipped (0/1)
layer.text_decoration integer

text decoration code
layer.text_fontfamily string

text font family, see text_fontfamily in fonts_list
layer.invert_clip_mask integer

is the clip mask inverted (0/1): 0 = only the parts covered by clip_mask stay visible, 1 = the covered parts are cut out
layer.rating_max_value number

maximum possible rating value from the feed
layer.rating_min_stars number

minimum number of stars to display
layer.reflection_angle integer

reflection angle
layer.text_orientation integer

text orientation: 0=horizontal, 1=vertical
layer.text_xml_element string

feed XML element bound to the text content
layer.image_xml_element string

feed XML element bound to the image
layer.rating_hide_empty integer

hide empty stars (0/1)
layer.reflection_offset integer

reflection offset
layer.text_stroke_color string

text stroke color, hex format
layer.text_stroke_width integer

text stroke width
layer.custom_set_file_id number

custom image set file id
layer.rating_xml_element string

feed XML element bound to the rating value
layer.reflection_opacity integer

reflection opacity
layer.is_aspect_size_ratio integer

does layer keep aspect ratio (0/1)
layer.is_remove_background integer

e.g. custom set image may be implemented with removed background (0/1)
layer.text_background_type string

text background shape: none|ellipse|circle|rectangle|image|rectangle-each-line
layer.external_image_prompt string

prompt used to generate the external image
layer.text_background_color string

text background color, hex format
layer.text_decoration_color string

text decoration color, hex format
layer.text_stroke_underlayer integer

is text stroke under the text (0/1) keeping the original font thickness
layer.rating_count_xml_element string

feed XML element bound to the rating count
layer.text_xml_element_formatter string

formatter applied to the text_xml_element value
layer.text_decoration_lineoverlap integer

text decoration line overlap
layer.text_decoration_linethickness integer

text decoration line thickness
layers array of object alwaysvždyvždymindig

all the template layers in their stacking order with the basic fields only (use templates_layers_list for all the fields)
layers[].id number alwaysvždyvždymindig

layer id
layers[].name string

layer name
layers[].type string alwaysvždyvždymindig

layer type
layers[].is_alt boolean alwaysvždyvždymindig

is the layer in an alternative template
layers[].priority integer alwaysvždyvždymindig

layer stacking order (z-index); lower value = drawn on top. Dynamic layers use 1–200, static layers start at 201

app_feedimageeditor_templates_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List all templates in a project, with name, output size, assigned product selection (query ids), AI type, and active/inactive state. Call this first to see what already exists before creating, modifying, or reordering templates. With `is_alt: true` lists the ALTERNATIVE templates instead (applied to the products' alternative images), each with its `bindings` (main templates and alternative image levels it applies to). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_list`.) PAID, per project. EDITS the photos already in the feed — watermark and background removal, upscale, outpainting, autocrop, price tags, logos — published at new URLs. Needed for any change to the picture itself; changing which URL the feed carries is a free core rule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = list the alternative templates (with their `bindings`) instead of the main templates

OutputVýstupVýstupKimenet

templates array of object alwaysvždyvždymindig

list of the project templates
templates[].id number alwaysvždyvždymindig

template id
templates[].name string alwaysvždyvždymindig

template name
templates[].type integer alwaysvždyvždymindig

ai template type
templates[].active integer alwaysvždyvždymindig

is template active
templates[].is_alt boolean

true for an alternative template (absent for main templates)
templates[].queries array of integer

list of template product query ids (main templates only)
templates[].bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
templates[].bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
templates[].bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
templates[].bindings[].template_id integer alwaysvždyvždymindig

main template id
templates[].priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
templates[].active_to string

scheduled template active_to (main templates only)
templates[].active_from string

scheduled template active_from (main templates only)

app_feedimageeditor_templates_previews Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

Render preview images of a template applied to products — either one specific product (`product_id`, or the product(s) matching `item_id`), or up to `limit` (default 10) products assigned to the template (`template_id`), most recently rendered first. At least one of `product_id`, `item_id` or `template_id` is required (`product_id` and `item_id` can't be combined); without `template_id`, the template currently assigned to the product is used. With `product_id`, only that one preview is returned (`limit` is ignored). Previews are returned as image content blocks you can look at directly (one per product, each preceded by a caption with its product id); products not rendered yet are composed on demand, at most 5 per request — the rest is returned only as an url (`has_image` false), call the tool again with their `product_id` to get them. **Without `product_id`/`item_id`, the result may be empty for freshly created, just-reconfigured or inactive templates** (products haven't been assigned to the template yet) — an empty result doesn't necessarily mean "no matching products". Prefer passing an explicit `product_id` (from Mergado's `list_project_products`) for a reliable result, especially right after creating or changing a template. ALTERNATIVE templates (`is_alt: true`, `template_id` = alternative template id, required): rendered on the products' alternative images. Without `product_id`/`item_id` the products of the bound main template (`main_template_id`, default: the first of its `bindings`) having alternative images are used; each preview uses the first alternative image the binding's levels apply to, or the alternative image `level` when given (0 = the first alternative image). `level` in the result is null when the product has no such alternative image (no preview then). `url` is null for alternative templates. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_previews`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` (required then) is an alternative template id; it is previewed on the products' alternative images
item_id string optionalvolitelnévoliteľnéválasztható

item id to get preview. Required unless `product_id` or `template_id` is given.
level integer optionalvolitelnévoliteľnéválasztható

Alternative templates only: preview on the alternative image of this level (0 = the first alternative image) instead of the first level the binding applies to.
limit number optionalvolitelnévoliteľnéválasztható

Maximum number of preview images. Always 1 when `product_id` is given.
main_template_id integer optionalvolitelnévoliteľnéválasztható

Alternative templates only: the bound main template (see `bindings` of the alternative template) whose products and levels are previewed. Default: the first binding.
max_size integer optionalvolitelnévoliteľnéválasztható

Maximum width/height in px of the attached preview images, between 16 and 512. Applies only when `return_base64` is true.
product_id number optionalvolitelnévoliteľnéválasztható

product id to get preview. Required unless `item_id` or `template_id` is given.
return_base64 boolean optionalvolitelnévoliteľnéválasztható

Attach each preview as an MCP image content block (directly viewable, no download or decoding needed). Products not rendered yet are composed on demand, at most 5 per request. Set to false to get only `url`s.
template_id number optionalvolitelnévoliteľnéválasztható

template id to be previewed. When omitted, the template assigned to the product (`product_id`/`item_id`) is used.

OutputVýstupVýstupKimenet

previews array of object alwaysvždyvždymindig

preview images of the template rendered on products
previews[].url string alwaysvždyvždymindig

URL rendering the template on the product (may not be reachable from the agent environment); null for alternative templates
previews[].level integer

alternative templates only: level of the product's alternative image the preview is rendered on (0 = the first alternative image); null when the product has no alternative image the alternative template applies to
previews[].has_image boolean alwaysvždyvždymindig

true when the preview is attached as an image content block of this response
previews[].product_id integer alwaysvždyvždymindig

product the template is rendered on
previews[].template_id integer alwaysvždyvždymindig

template rendered on the product

app_feedimageeditor_templates_reorder Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Set the priority order of the templates in a project. Pass template ids in new_templates_order_ids from highest to lowest priority: the first id gets priority 1, the next 2, and so on. When several templates' product selections overlap for the same product, this order decides which template's output wins — templates earlier in the array take precedence. The array must contain either every template id in the project, or exactly every active template id (inactive templates are then kept after them in their current relative order). Get the ids, `active` flags and current `priority` from `templates_list` first. Returns all project templates sorted by their new priority. With `is_alt: true` orders the ALTERNATIVE templates (ids from `templates_list` with `is_alt: true`) the same way: when several alternative templates are bound to the same main template and level, the earlier one wins. The order is stored on the alternative template's bindings, so alternative templates without `bindings` stay last. (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_reorder`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

new_templates_order_ids array requiredpovinnépovinnékötelező

Template ids ordered from highest priority (first) to lowest (last), without duplicates. Must contain every template id of the project, or exactly every active template id (inactive ones are appended in their current order). Get the ids from `templates_list`.
project_id integer requiredpovinnépovinnékötelező

Project id.
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = new_templates_order_ids are alternative template ids (see `templates_list` with `is_alt: true`) and the alternative templates are reordered

OutputVýstupVýstupKimenet

templates array of object alwaysvždyvždymindig

All project templates sorted by their new priority (ascending, first = highest priority).
templates[].id number alwaysvždyvždymindig

template id
templates[].name string alwaysvždyvždymindig

template name
templates[].type integer alwaysvždyvždymindig

ai template type
templates[].active integer alwaysvždyvždymindig

is template active
templates[].is_alt boolean

true for an alternative template (absent for main templates)
templates[].queries array of integer

list of template product query ids (main templates only)
templates[].bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
templates[].bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
templates[].bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
templates[].bindings[].template_id integer alwaysvždyvždymindig

main template id
templates[].priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
templates[].active_to string

scheduled template active_to (main templates only)
templates[].active_from string

scheduled template active_from (main templates only)

app_feedimageeditor_templates_update Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Update editable fields of an existing template in one call: name, product selection (`queries`), background color, AI effect (`ai_type`), AI feed enrichment (`ai_params_enabled`), and how the product image is placed on the canvas (`enlarge`, `enlarge_by`, `crop`, `protection_zone`, `max_image_width`/`max_image_height`, `translate_x`/`translate_y`, `flip`, `flop`, `rotation`, `is_autocrop`). output size (`width`/`height`, `size_id` or `keep_original_size`), and activity (`active` to start/pause immediately, or `active_from`/`active_to` to schedule). Partial update — only the fields you pass are changed, everything else is kept. Read the current values first with `templates_detail`. **`queries` must contain Mergado query ids that exist in this project** — get them from the Mergado MCP `list_project_queries` (same `project_id`); passing `queries` replaces the whole selection. Size: pass either both `width` and `height`, or `size_id` (see `sizes_list`), or `keep_original_size: true` — **`keep_original_size` hides all layers of the template**; layer placement is relative to the canvas, so check `templates_layers_list` and `templates_previews` after a size change. Activity: `active` cannot be combined with `active_from`/`active_to` in the same call; setting `active` clears any schedule; setting `active_from`/`active_to` also sets `active` right away according to whether the template falls within the schedule now. Visual similarity and layers are NOT changed here — use `templates_visual_similarity` and the `templates_layers_*` tools. With `is_alt: true` an ALTERNATIVE template is updated: `queries`, `ai_params_enabled`, `crop` and `active_from`/`active_to` are not available there; instead `bindings` sets the main templates it is bound to and the alternative image levels it applies to (replaces all current bindings — read them first with `templates_detail`). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_update`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

template id to be updated
active boolean optionalvolitelnévoliteľnéválasztható

Start (true) or pause (false) the template immediately; also clears any `active_from`/`active_to` schedule. Cannot be combined with `active_from`/`active_to`
active_from string optionalvolitelnévoliteľnéválasztható

Scheduled start: date/time from which the template becomes active. Format: Y-m-d H:i:s. Cannot be combined with `active`. Passing only `active_to` clears `active_from`
active_to string optionalvolitelnévoliteľnéválasztható

Scheduled end: date/time until which the template stays active. Format: Y-m-d H:i:s, must not be in the past and must be after `active_from`. Cannot be combined with `active`. Passing only `active_from` clears `active_to`
ai_params_enabled boolean optionalvolitelnévoliteľnéválasztható

Enable AI feed enrichment: attributes generated from the product's main image are written to Mergado into the elements AI_ATTRIBUTES (e.g. color, material, style) and AI_VISUAL (e.g. background, angle, image quality), each value with a confidence 0–1. To use them in the output feed, create Mergado rules.
ai_type enum optionalvolitelnévoliteľnéválasztható

AI effect of the template; null turns the effect off. upscale (only images smaller than 600×600 px are processed)
background string optionalvolitelnévoliteľnéválasztható

Background color in hex format, e.g. #ffffff (optionally with alpha, e.g. #ffffff00)
bindings array optionalvolitelnévoliteľnéválasztható

Alternative templates only (`is_alt: true`). Main templates the alternative template is bound to, each with the alternative image levels it applies to. Replaces all the current bindings; [] unbinds the alternative template from every main template (it is then not applied at all).
crop boolean optionalvolitelnévoliteľnéválasztható

When true, a product image bigger than the template size is cropped to it; when false (and `enlarge` is true), it is downscaled to fit instead
enlarge boolean optionalvolitelnévoliteľnéválasztható

Resize the product image to the template size; when false, `enlarge_by`, `protection_zone` and the downscale-instead-of-crop behaviour are not applied
enlarge_by enum optionalvolitelnévoliteľnéválasztható

How the product image is resized (only when `enlarge` is true), keeping the aspect ratio: `fit` = fit the whole image inside, `width` = match the output width, `height` = match the output height, `smaller` = match by the smaller dimension, `bigger` = match by the bigger dimension
flip boolean optionalvolitelnévoliteľnéválasztható

Mirror the product image vertically (upside down)
flop boolean optionalvolitelnévoliteľnéválasztható

Mirror the product image horizontally (left-right)
height integer optionalvolitelnévoliteľnéválasztható

Output height in pixels (max 4096); must be passed together with `width`. Cannot be combined with `size_id` or `keep_original_size`
is_alt boolean optionalvolitelnévoliteľnéválasztható

true = `template_id` is an ALTERNATIVE template id (see `templates_list` with `is_alt: true`). Alternative templates render the products' alternative (additional) images instead of the main image; they have their own layers and are bound to main templates (`bindings`), which pick the products and the alternative image levels they apply to. Default false = main template.
is_autocrop boolean optionalvolitelnévoliteľnéválasztható

Trim uniform borders (e.g. white/transparent margins) around the product so it fills the available area better
keep_original_size boolean optionalvolitelnévoliteľnéválasztható

Only `true` is accepted: keep each product's original image size instead of a fixed output size. Layers are not supported in this mode and will be hidden. To switch back to a fixed size, pass `width`/`height` or `size_id`
max_image_height integer optionalvolitelnévoliteľnéválasztható

Maximum height of the product image on the canvas in px; null = no limit
max_image_width integer optionalvolitelnévoliteľnéválasztható

Maximum width of the product image on the canvas in px; null = no limit
name string optionalvolitelnévoliteľnéválasztható

New name of the template (max 96 characters)
protection_zone integer optionalvolitelnévoliteľnéválasztható

Protection zone in px on each side of the product image: positive = image is shrunk and framed with the background color, negative = image is enlarged over the template edges (with Outpainting, the AI extends the image). Ignored when max image width/height is set
queries array optionalvolitelnévoliteľnéválasztható

Mergado query ids (product selections) the template applies to, e.g. [123]. Replaces the current selection. Get valid ids for this project from the Mergado MCP `list_project_queries` first — any other id is rejected.
rotation number optionalvolitelnévoliteľnéválasztható

Rotation of the product image in degrees (-360 to 360)
size_id string | number optionalvolitelnévoliteľnéválasztható

Id of an existing size preset to use as output size, see `sizes_list`. Cannot be combined with `width`/`height` or `keep_original_size`
translate_x integer optionalvolitelnévoliteľnéválasztható

Horizontal shift of the product image in px from its centered position (positive = right, negative = left)
translate_y integer optionalvolitelnévoliteľnéválasztható

Vertical shift of the product image in px from its centered position (positive = down, negative = up)
width integer optionalvolitelnévoliteľnéválasztható

Output width in pixels (max 4096); must be passed together with `height`. Cannot be combined with `size_id` or `keep_original_size`

OutputVýstupVýstupKimenet

id number alwaysvždyvždymindig

template id
crop integer alwaysvždyvždymindig

crop image (0/1): when 1, a product image bigger than the template size (after `enlarge_by`) is cropped to it; when 0 (and `enlarge` = 1), it is downscaled to fit instead
name string alwaysvždyvždymindig

template name
type integer alwaysvždyvždymindig

ai template type
active integer alwaysvždyvždymindig

is template active
is_alt boolean

true for an alternative template (absent for main templates)
enlarge integer alwaysvždyvždymindig

is the product image resized to the template size (0/1); when 0, `enlarge_by`, `protection_zone` and the downscale-instead-of-crop behaviour are not applied and the image is placed in its original size
queries array of integer

list of template product query ids (main templates only)
size_id number alwaysvždyvždymindig

assigned size id, null if keep_original_size is set or no size is assigned yet
bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
bindings[].template_id integer alwaysvždyvždymindig

main template id
priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
active_to string

scheduled template active_to (main templates only)
background string alwaysvždyvždymindig

background color, hex format
enlarge_by enum alwaysvždyvždymindig

how the product image is resized to the template size (only when `enlarge` = 1), always keeping the aspect ratio: `fit` = fit the whole image inside the output dimensions, `width` = match the output width, `height` = match the output height, `smaller` = match by the image's smaller dimension, `bigger` = match by the image's bigger dimension; null = no resizing
active_from string

scheduled template active_from (main templates only)
is_autocrop integer alwaysvždyvždymindig

autocrop (0/1): trims uniform borders (e.g. white/transparent margins) around the product so it fills the available area better
translate_x integer alwaysvždyvždymindig

horizontal shift of the product image in px from its centered position (positive = right, negative = left)
translate_y integer alwaysvždyvždymindig

vertical shift of the product image in px from its centered position (positive = down, negative = up)
is_keep_size integer alwaysvždyvždymindig

is the template using each product's original image size instead of a fixed size (0/1)
shapes_count integer alwaysvždyvždymindig

number of layers on the template
protection_zone integer alwaysvždyvždymindig

protection zone in px applied on each side of the product image relative to the template size: positive = the image is shrunk and framed with the background color, negative = the image is enlarged over the template edges (with Outpainting, a negative value lets the AI extend the image). Ignored (0) when max image width/height is set

app_feedimageeditor_templates_visual_similarity Feed Image Editor Writes dataZapisuje dataZapisuje dátaAdatot ír

Enable or disable visual similarity matching for a main template: finds products with visually similar images elsewhere in the feed and links them to each product. `visual_similarity_threshold` sets the minimum similarity score (0-1), `visual_similarity_n` how many similar products to attach (1-20, default 5), `visual_similarity_templateids` restricts the search to images produced by specific main templates. Only main templates are supported — alternative templates (`is_alt`) cannot be used, neither as `template_id` nor in `visual_similarity_templateids`. The results are written to the feed elements FIE_VS_IDS and FIE_VS_IMAGES_URL only when the export is enabled in the settings (`project_settings_update`: `similarity_ids_element`, `similarity_image_urls_element`). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_templates_visual_similarity`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
template_id number requiredpovinnépovinnékötelező

main template id on which enabled visual similarity (alternative template ids are not supported)
visual_similarity_enabled boolean requiredpovinnépovinnékötelező

is Visual Similarity enabled
visual_similarity_n integer optionalvolitelnévoliteľnéválasztható

similar images count 1-20
visual_similarity_templateids array optionalvolitelnévoliteľnéválasztható

list of main template ids where to find similar images (alternative template ids are not supported); required when visual_similarity_enabled is true
visual_similarity_threshold number optionalvolitelnévoliteľnéválasztható

threshold 0-1

OutputVýstupVýstupKimenet

id number alwaysvždyvždymindig

template id
crop integer alwaysvždyvždymindig

crop image (0/1): when 1, a product image bigger than the template size (after `enlarge_by`) is cropped to it; when 0 (and `enlarge` = 1), it is downscaled to fit instead
name string alwaysvždyvždymindig

template name
type integer alwaysvždyvždymindig

ai template type
active integer alwaysvždyvždymindig

is template active
is_alt boolean

true for an alternative template (absent for main templates)
enlarge integer alwaysvždyvždymindig

is the product image resized to the template size (0/1); when 0, `enlarge_by`, `protection_zone` and the downscale-instead-of-crop behaviour are not applied and the image is placed in its original size
queries array of integer

list of template product query ids (main templates only)
size_id number alwaysvždyvždymindig

assigned size id, null if keep_original_size is set or no size is assigned yet
bindings array of object

alternative templates only: main templates the alternative template is bound to, with the alternative image levels it applies to
bindings[].levels array alwaysvždyvždymindig

0-based alternative image levels for levels_mode `selected`, otherwise null
bindings[].levels_mode enum alwaysvždyvždymindig

which alternative images (levels) the alternative template is applied to
bindings[].template_id integer alwaysvždyvždymindig

main template id
priority integer alwaysvždyvždymindig

template priority order, starting from 1 (1 = highest priority). Alternative templates are ordered among the alternative templates only
active_to string

scheduled template active_to (main templates only)
background string alwaysvždyvždymindig

background color, hex format
enlarge_by enum alwaysvždyvždymindig

how the product image is resized to the template size (only when `enlarge` = 1), always keeping the aspect ratio: `fit` = fit the whole image inside the output dimensions, `width` = match the output width, `height` = match the output height, `smaller` = match by the image's smaller dimension, `bigger` = match by the image's bigger dimension; null = no resizing
active_from string

scheduled template active_from (main templates only)
is_autocrop integer alwaysvždyvždymindig

autocrop (0/1): trims uniform borders (e.g. white/transparent margins) around the product so it fills the available area better
translate_x integer alwaysvždyvždymindig

horizontal shift of the product image in px from its centered position (positive = right, negative = left)
translate_y integer alwaysvždyvždymindig

vertical shift of the product image in px from its centered position (positive = down, negative = up)
is_keep_size integer alwaysvždyvždymindig

is the template using each product's original image size instead of a fixed size (0/1)
shapes_count integer alwaysvždyvždymindig

number of layers on the template
protection_zone integer alwaysvždyvždymindig

protection zone in px applied on each side of the product image relative to the template size: positive = the image is shrunk and framed with the background color, negative = the image is enlarged over the template edges (with Outpainting, a negative value lets the AI extend the image). Ignored (0) when max image width/height is set

app_feedimageeditor_uploaded_images_list Feed Image Editor Read-onlyPouze čteníIba čítanieCsak olvasás

List custom images (e.g. logos or watermarks) already uploaded to the project. Returns custom_set_id/custom_set_file_id for each image — pass those into templates_layers_create (type: 'customSet') to place the image on a template as a layer. Check this list before calling custom_images_upload to avoid uploading the same image twice. Set with_thumbnails to also get a small base64 data URI preview (max 128px, first 20 images only). (Tool names above are bare; in Mergado's MCP prepend `app_feedimageeditor_`, e.g. `app_feedimageeditor_uploaded_images_list`.)

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id number requiredpovinnépovinnékötelező

project id
with_thumbnails boolean optionalvolitelnévoliteľnéválasztható

include a small base64 thumbnail of each image (first 20 images only), default false

OutputVýstupVýstupKimenet

images array of object alwaysvždyvždymindig

list of the uploaded custom images (empty if none)
images[].url string alwaysvždyvždymindig

public URL of the uploaded image
images[].hash string alwaysvždyvždymindig

an image content hash
images[].width integer alwaysvždyvždymindig

image width in px
images[].author string alwaysvždyvždymindig

author or copyright holder of the image (null if unknown)
images[].height integer alwaysvždyvždymindig

image height in px
images[].license string alwaysvždyvždymindig

license of the image (null if unknown)
images[].thumbnail string

small preview as a base64 data URI (only when with_thumbnails is set, null otherwise)
images[].source_url string alwaysvždyvždymindig

URL the image comes from (null if unknown)
images[].uploaded_by string alwaysvždyvždymindig

who uploaded the image: "ai_agent" when uploaded via MCP, otherwise the id of the user (null if unknown)
images[].custom_set_id number alwaysvždyvždymindig

id of the project's custom image set the file belongs to
images[].orig_filename string alwaysvždyvždymindig

original file name
images[].used_in_templates array of integer alwaysvždyvždymindig

ids of templates where the image is placed as a customSet layer (empty if unused — such an image can be deleted with custom_images_delete)
images[].custom_set_file_id number alwaysvždyvždymindig

id of the uploaded file — pass as custom_set_id/custom_set_file_id to templates_layers_create (type: customSet) to place it on a template

app_mergadodepots_get_eshop_review Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Fetch one eshop (seller) review by platform and id; only needed to re-fetch a review already found by search_eshop_reviews. Errors if the eshop has no such review.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

external_id string requiredpovinnépovinnékötelező

The review's id on its platform — returned as `id` by the search tools.
source enum requiredpovinnépovinnékötelező

Review platform the review comes from.
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig
url string
cons array of string
pros array of string
state string
rating number
seller object
seller.id string
seller.url string
seller.name string
summary string
order_id string
platform enum alwaysvždyvždymindig

Review platform a review was collected from.
reviewer object
reviewer.id string
reviewer.name string
reviewer.is_anonymous boolean
url_type string
subscores array of object
subscores[].name string alwaysvždyvždymindig
subscores[].type enum alwaysvždyvždymindig

Scale a seller subscore value is expressed in. Values are passed through from the source untouched; the type tells the caller how to read them.
subscores[].value string alwaysvždyvždymindig
created_at string alwaysvždyvždymindig
ordered_at string
recommends boolean
updated_at string
shop_reaction string
shop_reaction_state string
is_verified_purchase boolean

app_mergadodepots_get_product_review Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Fetch one product review by platform and id; only needed to re-fetch a review already found by search_product_reviews. Errors if the eshop has no such review.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

external_id string requiredpovinnépovinnékötelező

The review's id on its platform — returned as `id` by the search tools.
source enum requiredpovinnépovinnékötelező

Review platform the review comes from.
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig
url string
cons array of string
pros array of string
state string
title string
images array of string
rating number
country string
product object
product.ean string
product.url string
product.name string
product.item_id string
product.product_id string
summary string
language string
order_id string
platform enum alwaysvždyvždymindig

Review platform a review was collected from.
reviewer object
reviewer.id string
reviewer.name string
reviewer.is_anonymous boolean
url_type string
created_at string alwaysvždyvždymindig
recommends boolean
updated_at string
is_verified_purchase boolean

app_mergadodepots_list_review_sources Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Show per platform whether its data is being downloaded for the eshop and whether the download is healthy; `unavailable` means not connected in the Mergado keychain (for `availability_feed`: no feed URL entered in the Depots app).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

result array of object alwaysvždyvždymindig
result[].state enum alwaysvždyvždymindig

`enabled` = downloading, `disabled` = switched off by the user, `failing` = every download errors, `unavailable` = not connected in the Mergado keychain (for `availability_feed`: no feed URL entered in Depots yet).
result[].source enum alwaysvždyvždymindig

Every platform the fetcher can pull from (reviews or metrics).
result[].enabled boolean alwaysvždyvždymindig
result[].failure_reasons array of object
result[].failure_reasons[].code string alwaysvždyvždymindig
result[].failure_reasons[].detail string
result[].last_fetched_at string

Last successful download of this source's data (UTC); null if never.

app_mergadodepots_search_ads_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's daily Google Ads per-product metrics (clicks, impressions, cost, conversions, CTR, CPC, ROAS), newest first; one row per product x day. Days with zero impressions have no row and the newest day is partial.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
product_item_id string optionalvolitelnévoliteľnéválasztható

Filter to one product by its Merchant Center offer id — the product id in the Mergado feed.

OutputVýstupVýstupKimenet

limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
metrics array of object alwaysvždyvždymindig
metrics[].ctr number
metrics[].cost number
metrics[].date string alwaysvždyvždymindig
metrics[].roas number
metrics[].clicks integer
metrics[].source string
metrics[].eshop_id string alwaysvždyvždymindig
metrics[].stored_at string
metrics[].average_cpc number
metrics[].conversions number
metrics[].cost_micros integer
metrics[].customer_id string alwaysvždyvždymindig
metrics[].impressions integer
metrics[].currency_code string
metrics[].product_brand string
metrics[].product_title string
metrics[].product_item_id string alwaysvždyvždymindig
metrics[].conversions_value number
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_analytics_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List daily Google Analytics landing-page metrics, newest day first. Session-scoped: every figure belongs to the page a visit *started* on, so it describes what that entry page produced, not what the product on it earned — a visitor landing here and buying something else still counts on this row. `sessions` is the traffic number; `pageviews_in_session` counts pages those sessions viewed anywhere on the site, so never present it as views of this page — and it can be lower than `sessions`, because GA4 starts a session on any event rather than only on a pageview, so a `pages_per_session` below 1 is not an error.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
url string optionalvolitelnévoliteľnéválasztható

Landing-page URL to filter to. Absolute or a bare path, any capitalisation, tracking parameters included — it is normalized before matching.
window integer optionalvolitelnévoliteľnéválasztható

Last N complete days ending yesterday: 1, 7, 30 or 90.

OutputVýstupVýstupKimenet

limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
metrics array of object alwaysvždyvždymindig
metrics[].date string alwaysvždyvždymindig
metrics[].source string
metrics[].eshop_id string alwaysvždyvždymindig
metrics[].sessions integer
metrics[].new_users integer
metrics[].stored_at string
metrics[].add_to_carts integer
metrics[].landing_page string alwaysvždyvždymindig
metrics[].normalized_path string alwaysvždyvždymindig
metrics[].engaged_sessions integer
metrics[].purchase_revenue number
metrics[].ecommerce_purchases integer
metrics[].pageviews_in_session integer
metrics[].user_engagement_duration number
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_eshop_reviews Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List reviews of the eshop as a whole (seller reviews, not products), newest first. Use when the user asks how their shop is rated.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

created_from string optionalvolitelnévoliteľnéválasztható

Only reviews created at/after this ISO 8601 date-time; no timezone means UTC.
created_to string optionalvolitelnévoliteľnéválasztható

Only reviews created at/before this ISO 8601 date-time; no timezone means UTC.
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
source enum optionalvolitelnévoliteľnéválasztható

Review platform to filter by (`heureka.cz`, `heureka.sk`, `zbozi.cz`); omit to search all platforms.

OutputVýstupVýstupKimenet

type string
limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
reviews array of object alwaysvždyvždymindig
reviews[].id string alwaysvždyvždymindig
reviews[].url string
reviews[].cons array of string
reviews[].pros array of string
reviews[].state string
reviews[].rating number
reviews[].seller object
reviews[].seller.id string
reviews[].seller.url string
reviews[].seller.name string
reviews[].summary string
reviews[].order_id string
reviews[].platform enum alwaysvždyvždymindig

Review platform a review was collected from.
reviews[].reviewer object
reviews[].reviewer.id string
reviews[].reviewer.name string
reviews[].reviewer.is_anonymous boolean
reviews[].url_type string
reviews[].subscores array of object
reviews[].subscores[].name string alwaysvždyvždymindig
reviews[].subscores[].type enum alwaysvždyvždymindig

Scale a seller subscore value is expressed in. Values are passed through from the source untouched; the type tells the caller how to read them.
reviews[].subscores[].value string alwaysvždyvždymindig
reviews[].created_at string alwaysvždyvždymindig
reviews[].ordered_at string
reviews[].recommends boolean
reviews[].updated_at string
reviews[].shop_reaction string
reviews[].shop_reaction_state string
reviews[].is_verified_purchase boolean
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_product_reviews Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's product reviews from all platforms in one unified format, newest first. Use when the user asks what customers say about their products.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

created_from string optionalvolitelnévoliteľnéválasztható

Only reviews created at/after this ISO 8601 date-time; no timezone means UTC.
created_to string optionalvolitelnévoliteľnéválasztható

Only reviews created at/before this ISO 8601 date-time; no timezone means UTC.
ean string optionalvolitelnévoliteľnéválasztható

Filter to one product by its EAN.
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
source enum optionalvolitelnévoliteľnéválasztható

Review platform to filter by (`heureka.cz`, `heureka.sk`, `zbozi.cz`); omit to search all platforms.
url string optionalvolitelnévoliteľnéválasztható

Filter to one product by its URL on the eshop (not the review platform's URL).

OutputVýstupVýstupKimenet

type string
limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
reviews array of object alwaysvždyvždymindig
reviews[].id string alwaysvždyvždymindig
reviews[].url string
reviews[].cons array of string
reviews[].pros array of string
reviews[].state string
reviews[].title string
reviews[].images array of string
reviews[].rating number
reviews[].country string
reviews[].product object
reviews[].product.ean string
reviews[].product.url string
reviews[].product.name string
reviews[].product.item_id string
reviews[].product.product_id string
reviews[].summary string
reviews[].language string
reviews[].order_id string
reviews[].platform enum alwaysvždyvždymindig

Review platform a review was collected from.
reviews[].reviewer object
reviews[].reviewer.id string
reviews[].reviewer.name string
reviews[].reviewer.is_anonymous boolean
reviews[].url_type string
reviews[].created_at string alwaysvždyvždymindig
reviews[].recommends boolean
reviews[].updated_at string
reviews[].is_verified_purchase boolean
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_search_console_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's daily Google Search Console per-page metrics (clicks, impressions, CTR, position), newest first; one row per page URL x day. The last ~3 days are missing until Google finalizes them.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
url string optionalvolitelnévoliteľnéválasztható

Filter to one page by its URL exactly as Google Search Console reports it — normally the product URL in the Mergado feed.

OutputVýstupVýstupKimenet

limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
metrics array of object alwaysvždyvždymindig
metrics[].ctr number
metrics[].url string alwaysvždyvždymindig
metrics[].date string alwaysvždyvždymindig
metrics[].clicks integer
metrics[].source string
metrics[].eshop_id string alwaysvždyvždymindig
metrics[].position number
metrics[].site_url string alwaysvždyvždymindig
metrics[].stored_at string
metrics[].impressions integer
metrics[].position_impressions number
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_search_console_queries Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the Google search queries (keywords) the eshop's pages appear for over the trailing 30 days, most clicked first. Filter by `url` for one product's keywords or by `query` for the pages ranking on a keyword; only Google's top queries are present.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
query string optionalvolitelnévoliteľnéválasztható

Filter to one Google search query (exact text).
url string optionalvolitelnévoliteľnéválasztható

Filter to one page by its URL exactly as Google Search Console reports it — normally the product URL in the Mergado feed.

OutputVýstupVýstupKimenet

limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
queries array of object alwaysvždyvždymindig
queries[].ctr number
queries[].url string alwaysvždyvždymindig
queries[].query string alwaysvždyvždymindig
queries[].clicks integer
queries[].source string
queries[].eshop_id string alwaysvždyvždymindig
queries[].position number
queries[].site_url string alwaysvždyvždymindig
queries[].stored_at string
queries[].window_to string alwaysvždyvždymindig
queries[].impressions integer
queries[].window_from string alwaysvždyvždymindig
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_sklik_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's daily Sklik per-product metrics (clicks, impressions, cost in CZK, conversions, items sold, CTR, CPC, ROAS) for the product ads served from its Zboží.cz feed, newest first; one row per product x day. Days with zero impressions have no row and the newest day is partial.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
product_item_id string optionalvolitelnévoliteľnéválasztható

Filter to one product by its feed item id — the product id in the Mergado feed.

OutputVýstupVýstupKimenet

limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
metrics array of object alwaysvždyvždymindig
metrics[].ctr number
metrics[].cost number
metrics[].date string alwaysvždyvždymindig
metrics[].roas number
metrics[].clicks integer
metrics[].source string
metrics[].eshop_id string alwaysvždyvždymindig
metrics[].stored_at string
metrics[].items_sold integer
metrics[].premise_id string alwaysvždyvždymindig
metrics[].average_cpc number
metrics[].conversions number
metrics[].impressions integer
metrics[].product_title string
metrics[].product_item_id string alwaysvždyvždymindig
metrics[].conversions_value number
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_stock Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's current stock per product from its availability feed: pieces in total, online and at branches, delivery times, and today's sold/restocked pieces. Products missing are out of stock (only stocked ones are tracked).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
item_id string optionalvolitelnévoliteľnéválasztható

Filter to one product by its availability-feed ITEM_ID — the product id in the Mergado feed.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.

OutputVýstupVýstupKimenet

items array of object alwaysvždyvždymindig
items[].day string alwaysvždyvždymindig
items[].depots array of object
items[].depots[].depot_id string alwaysvždyvždymindig
items[].depots[].pickup_time string
items[].depots[].stock_quantity integer
items[].depots[].pickup_order_deadline string
items[].source string
items[].in_feed boolean
items[].item_id string alwaysvždyvždymindig

The product's `ITEM_ID` in the availability feed — the product id in the Mergado feed.
items[].eshop_id string alwaysvždyvždymindig
items[].updated_at string
items[].delivery_time string

The feed's `<delivery_time>`, verbatim.
items[].sold_quantity integer

Pieces the stock dropped by during `day`, summed over downloads.
items[].order_deadline string

The `orderDeadline` of `<delivery_time>`, verbatim.
items[].stock_quantity integer

Pieces in stock in total — online plus branches.
items[].restocked_quantity integer

Pieces the stock rose by during `day`, summed over downloads.
items[].stock_quantity_max integer
items[].stock_quantity_min integer
items[].stock_quantity_open integer

`stock_quantity` at the start of `day`.
items[].depot_stock_quantity integer

Pieces at brick-and-mortar branches, summed over `depots`.
items[].online_stock_quantity integer

Pieces ready for immediate dispatch (the item's `<stock_quantity>`).
items[].stock_quantity_last_known integer

The latest piece count the feed stated; while it states none, the next change is measured from this.
limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
total_results integer alwaysvždyvždymindig

app_mergadodepots_search_stock_history Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's daily stock per product, newest day first: level at the start and end of the day, min/max, and pieces sold and restocked. A product with no row on a day was out of stock all day, unless no product has a row that day (a gap).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Only days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
item_id string optionalvolitelnévoliteľnéválasztható

Filter to one product by its availability-feed ITEM_ID — the product id in the Mergado feed.
limit integer optionalvolitelnévoliteľnéválasztható

Max reviews per page.
offset integer optionalvolitelnévoliteľnéválasztható

Results to skip, for paging beyond the first page.
window integer optionalvolitelnévoliteľnéválasztható

Last N days ending today (1, 7, 30 or 90); overrides date_from/date_to.

OutputVýstupVýstupKimenet

days array of object alwaysvždyvždymindig
days[].date string alwaysvždyvždymindig
days[].source string
days[].item_id string alwaysvždyvždymindig

The product's `ITEM_ID` in the availability feed — the product id in the Mergado feed.
days[].eshop_id string alwaysvždyvždymindig
days[].stored_at string
days[].sold_quantity integer
days[].stock_quantity integer
days[].restocked_quantity integer
days[].stock_quantity_max integer
days[].stock_quantity_min integer
days[].stock_quantity_open integer
days[].depot_stock_quantity integer
days[].online_stock_quantity integer
limit integer alwaysvždyvždymindig
offset integer alwaysvždyvždymindig
total_results integer alwaysvždyvždymindig

app_mergadodepots_set_review_source_enabled Mergado Depots Writes dataZapisuje dataZapisuje dátaAdatot ír

Turn downloading of one platform's data on or off (future downloads only). User tokens need write access; fails if the platform isn't connected in the keychain.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

enabled boolean requiredpovinnépovinnékötelező

true to download the platform's data, false to stop.
source enum requiredpovinnépovinnékötelező

Platform to switch: `heureka` (covers heureka.cz and heureka.sk), `zbozi`, `google_ads` (product ad metrics), `google_search_console` (organic search metrics), `google_analytics` (landing-page traffic and sales), `sklik` (Sklik product ad metrics), `availability_feed` (stock from the eshop's availability feed), or `google_merchant_center` (product and account issues).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

state enum alwaysvždyvždymindig

`enabled` = downloading, `disabled` = switched off by the user, `failing` = every download errors, `unavailable` = not connected in the Mergado keychain (for `availability_feed`: no feed URL entered in Depots yet).
source enum alwaysvždyvždymindig

Every platform the fetcher can pull from (reviews or metrics).
enabled boolean alwaysvždyvždymindig
failure_reasons array of object
failure_reasons[].code string alwaysvždyvždymindig
failure_reasons[].detail string
last_fetched_at string

Last successful download of this source's data (UTC); null if never.

app_mergadodepots_summarize_ads_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Total Google Ads metrics per product over a period for an explicit list of product ids, summed in Elasticsearch (ratios recomputed from totals). Prefer it over search_ads_metrics for overall or comparative performance of known products.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

product_item_ids array requiredpovinnépovinnékötelező

Merchant Center offer ids (the product ids in the Mergado feed) to summarize — up to 10000. Get them from the eshop's feed/query tooling or from search_ads_metrics results.
date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

summaries array of object alwaysvždyvždymindig
summaries[].ctr number alwaysvždyvždymindig
summaries[].cost number alwaysvždyvždymindig
summaries[].roas number alwaysvždyvždymindig
summaries[].clicks integer alwaysvždyvždymindig
summaries[].average_cpc number alwaysvždyvždymindig
summaries[].conversions number alwaysvždyvždymindig
summaries[].impressions integer alwaysvždyvždymindig
summaries[].product_item_id string alwaysvždyvždymindig
summaries[].conversions_value number alwaysvždyvždymindig
summaries[].days_with_traffic integer alwaysvždyvždymindig

app_mergadodepots_summarize_analytics_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Total Google Analytics metrics per landing page over a period, summed in Elasticsearch, with conversion rate, revenue per session, average order value and the cart rates recomputed from those sums. Prefer it for "which products convert / earn most per visit" questions. One entry per requested URL, in the order given, with `url` echoed verbatim and `normalized_path` naming the landing page it resolved to. Entries sharing a `normalized_path` are one page under several spellings, so read `totals` rather than adding entries up — it counts each page once. A URL with no entry had no traffic or matched nothing stored. Check `coverage` before trusting gaps: it is the share of the eshop's sessions the given URLs account for, so a low value means the URLs are wrong rather than that the pages had no traffic.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

urls array requiredpovinnépovinnékötelező

Landing-page URLs to summarize — up to 10000. Get them from the eshop's feed/query tooling (the products' URLs).
date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
window integer optionalvolitelnévoliteľnéválasztható

Last N complete days ending yesterday: 1, 7, 30 or 90.

OutputVýstupVýstupKimenet

totals object alwaysvždyvždymindig

Summed metrics, with every ratio recomputed from those sums. Ratios are never averaged across days or rows — a quiet day would otherwise weigh as much as a busy one. Each is ``null`` when its denominator is zero.
totals.sessions integer alwaysvždyvždymindig
totals.new_users integer alwaysvždyvždymindig
totals.add_to_carts integer alwaysvždyvždymindig
totals.conversion_rate number alwaysvždyvždymindig
totals.engagement_rate number alwaysvždyvždymindig
totals.add_to_cart_rate number alwaysvždyvždymindig
totals.engaged_sessions integer alwaysvždyvždymindig
totals.purchase_revenue number alwaysvždyvždymindig
totals.pages_per_session number alwaysvždyvždymindig
totals.average_order_value number alwaysvždyvždymindig
totals.ecommerce_purchases integer alwaysvždyvždymindig
totals.revenue_per_session number alwaysvždyvždymindig
totals.pageviews_in_session integer alwaysvždyvždymindig
totals.cart_to_purchase_rate number alwaysvždyvždymindig
totals.average_engagement_time number alwaysvždyvždymindig
coverage number alwaysvždyvždymindig
summaries array of object alwaysvždyvždymindig
summaries[].url string alwaysvždyvždymindig
summaries[].sessions integer alwaysvždyvždymindig
summaries[].new_users integer alwaysvždyvždymindig
summaries[].add_to_carts integer alwaysvždyvždymindig
summaries[].conversion_rate number alwaysvždyvždymindig
summaries[].engagement_rate number alwaysvždyvždymindig
summaries[].normalized_path string alwaysvždyvždymindig
summaries[].add_to_cart_rate number alwaysvždyvždymindig
summaries[].engaged_sessions integer alwaysvždyvždymindig
summaries[].purchase_revenue number alwaysvždyvždymindig
summaries[].days_with_traffic integer alwaysvždyvždymindig
summaries[].pages_per_session number alwaysvždyvždymindig
summaries[].average_order_value number alwaysvždyvždymindig
summaries[].ecommerce_purchases integer alwaysvždyvždymindig
summaries[].revenue_per_session number alwaysvždyvždymindig
summaries[].pageviews_in_session integer alwaysvždyvždymindig
summaries[].cart_to_purchase_rate number alwaysvždyvždymindig
summaries[].average_engagement_time number alwaysvždyvždymindig

app_mergadodepots_summarize_search_console_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Total organic Google Search metrics per page over a period for an explicit list of page URLs, summed in Elasticsearch (CTR recomputed, position impression-weighted). Prefer it for "most visited / most shown but rarely clicked products" questions.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

urls array requiredpovinnépovinnékötelező

Page URLs to summarize — up to 10000. Get them from the eshop's feed/query tooling (the products' URLs) or from search results.
date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

summaries array of object alwaysvždyvždymindig
summaries[].ctr number alwaysvždyvždymindig
summaries[].url string alwaysvždyvždymindig
summaries[].clicks integer alwaysvždyvždymindig
summaries[].position number alwaysvždyvždymindig
summaries[].impressions integer alwaysvždyvždymindig
summaries[].days_with_traffic integer alwaysvždyvždymindig

app_mergadodepots_summarize_sklik_metrics Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Total Sklik product metrics per product over a period for an explicit list of product ids, summed in Elasticsearch (ratios recomputed from totals). Prefer it over search_sklik_metrics for overall or comparative performance of known products.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

product_item_ids array requiredpovinnépovinnékötelező

Feed item ids (the product ids in the Mergado feed) to summarize — up to 10000. Get them from the eshop's feed/query tooling or from search_sklik_metrics results.
date_from string optionalvolitelnévoliteľnéválasztható

Only metric days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only metric days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.

OutputVýstupVýstupKimenet

summaries array of object alwaysvždyvždymindig
summaries[].ctr number alwaysvždyvždymindig
summaries[].cost number alwaysvždyvždymindig
summaries[].roas number alwaysvždyvždymindig
summaries[].clicks integer alwaysvždyvždymindig
summaries[].items_sold integer alwaysvždyvždymindig
summaries[].average_cpc number alwaysvždyvždymindig
summaries[].conversions number alwaysvždyvždymindig
summaries[].impressions integer alwaysvždyvždymindig
summaries[].product_item_id string alwaysvždyvždymindig
summaries[].conversions_value number alwaysvždyvždymindig
summaries[].days_with_traffic integer alwaysvždyvždymindig

app_mergadodepots_summarize_stock Mergado Depots Read-onlyPouze čteníIba čítanieCsak olvasás

Stock movement per product over a period for an explicit list of ids: stock at the start and end and its difference, pieces sold and restocked, and on how many days each happened. Inferred from levels only; ids without a row were out of stock.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

item_ids array requiredpovinnépovinnékötelező

Item ids (the product ids in the Mergado feed) to summarize — up to 10000.
date_from string optionalvolitelnévoliteľnéválasztható

Only days on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only days on or before this date (YYYY-MM-DD).
eshop_id string optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) id the call targets. Omit with a shop or project token — it defaults to the token's own eshop. Required with a user token (resolve it via Mergado's list_user_eshops); access to the eshop is verified with Mergado.
window integer optionalvolitelnévoliteľnéválasztható

Last N days ending today (1, 7, 30 or 90); overrides date_from/date_to.

OutputVýstupVýstupKimenet

date_to string alwaysvždyvždymindig
date_from string alwaysvždyvždymindig
summaries array of object alwaysvždyvždymindig
summaries[].item_id string alwaysvždyvždymindig
summaries[].sold_days integer alwaysvždyvždymindig

Days on which the stock dropped at least once.
summaries[].sold_quantity integer alwaysvždyvždymindig

Pieces the stock dropped by, summed over the period.
summaries[].restocked_days integer alwaysvždyvždymindig

Days on which the stock rose at least once.
summaries[].restocked_quantity integer alwaysvždyvždymindig

Pieces the stock rose by, summed over the period.
summaries[].stock_quantity_end integer alwaysvždyvždymindig

Pieces in stock at the end of the period (the latest download for today).
summaries[].stock_quantity_diff integer alwaysvždyvždymindig

`stock_quantity_end - stock_quantity_start`.
summaries[].stock_quantity_start integer alwaysvždyvždymindig

Pieces in stock at the start of the period; 0 if out of stock.
days_with_data integer alwaysvždyvždymindig

app_ordelogyproducts_create_campaign Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates a LIVE marketplace campaign — on success a full product-feed sync is enqueued immediately and offers start listing on the marketplace. Only call after validate_campaign_data passes AND the user explicitly confirmed they want the campaign live; to hand over for review in the app instead, use save_campaign_draft. Campaign names must be unique per eshop.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

Campaign data in the wizard shape: name, target_datasource{id, storefront?, user_documents?, additional_storefronts?, shipping_group?, reconnect_to_existing_offers?}, source_datasource{type, project, query}, mapped_elements {MARKETPLACES_ELEMENT: feed element name or list}, global_elements, availability_feed{url | product_feed_url}. Source valid values from get_campaign_requirements and describe_mergado_project; query ids and feed element names from the Mergado hub's list_project_queries / list_project_elements.
draft_id integer optionalvolitelnévoliteľnéválasztható

Draft the campaign was assembled from — deleted automatically once the campaign is created.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
ignore_missing_products boolean optionalvolitelnévoliteľnéválasztható

Skip the check that availability-feed products match the product feed — the wizard's 'continue anyway' confirmation.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_delete_pause_scheduler Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Cancels the campaign's scheduled sales pause; if sales are currently paused by the scheduler, they resume immediately.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_describe_mergado_project Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

What the Marketplaces app makes of one Mergado project: whether its output format is usable as a campaign product feed (`product_feed_type` MERGADO/GMC, else null), the derived `product_feed_url` for `availability_feed`, and an automatic `mapped_elements` proposal to start from (verify it with validate_campaign_data). The proposal exists only for Mergado Marketplaces and GMC output formats — for any other format (`suggested_mapping_error`, e.g. Heureka) build the mapping yourself: take the required and identifier Marketplaces elements from get_campaign_requirements, sample the feed with sample_project_element_values and match on names AND values (values disambiguate look-alikes — which price includes VAT, EAN vs internal code), then present the complete proposed mapping to the user for review before validating. If no feed element convincingly matches a required Marketplaces element, do NOT force the closest look-alike — tell the user what's missing and ask. Mapping from the feed is ALWAYS the primary goal; a global_elements value (e.g. HANDLING_TIME/CONDITION) is only the fallback when the feed truly has no usable element, never the default. Raw project data comes from the Mergado hub tools: list_shop_projects (project ids), list_project_queries (`source_datasource.query` ids), list_project_elements (valid `mapped_elements` feed element names). Read-only despite its annotation.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

Mergado project ID — resolve it via the Mergado hub's list_shop_projects.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
include_suggested_mapping boolean optionalvolitelnévoliteľnéválasztható

Also compute the automatic Marketplaces-element → feed-element mapping proposal (slower — samples element values from the feed).

OutputVýstupVýstupKimenet

project_id integer alwaysvždyvždymindig
product_feed_url string
product_feed_type enum
suggested_mapping object
suggested_mapping_error string

app_ordelogyproducts_get_campaign Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Full settings of one export campaign: source Mergado project and query, element mapping, global elements, storefront(s), shipping group, availability feed and pause state. `campaign_data` has the exact input shape of validate_campaign_data / save_campaign_draft / create_campaign — to replicate a campaign to a new Kaufland storefront, copy it and set a new unique name, the new storefront and its shipping_group (see get_campaign_requirements). Prices and texts are sent to the marketplace unconverted: when the new storefront's currency (compare `storefront_currency`) or language differs, switch source_datasource to a project/query made for that country (hub list_shop_projects) — ask the user which one, never reuse the original. VAT rates differ per country, so re-check VAT too. Allegro countries are additional_storefronts of one campaign, not separate campaigns. Then validate it.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

campaign_id integer alwaysvždyvždymindig
marketplace string alwaysvždyvždymindig
campaign_data object alwaysvždyvždymindig

Mirrors NewCampaignModel — reusable as campaign / draft input.
campaign_data.name string alwaysvždyvždymindig
campaign_data.global_elements object alwaysvždyvždymindig
campaign_data.mapped_elements object alwaysvždyvždymindig
campaign_data.pause_price_sync boolean
campaign_data.availability_feed object alwaysvždyvždymindig
campaign_data.availability_feed.url string
campaign_data.availability_feed.product_feed_url string
campaign_data.source_datasource object alwaysvždyvždymindig
campaign_data.source_datasource.type string alwaysvždyvždymindig
campaign_data.source_datasource.query string alwaysvždyvždymindig
campaign_data.source_datasource.project string alwaysvždyvždymindig
campaign_data.target_datasource object alwaysvždyvždymindig
campaign_data.target_datasource.id integer alwaysvždyvždymindig
campaign_data.target_datasource.storefront string
campaign_data.target_datasource.shipping_group object
campaign_data.target_datasource.shipping_group.id integer alwaysvždyvždymindig
campaign_data.target_datasource.shipping_group.name string alwaysvždyvždymindig
campaign_data.target_datasource.user_documents object
campaign_data.target_datasource.user_documents.shipping_rates string alwaysvždyvždymindig
campaign_data.target_datasource.user_documents.return_policies string alwaysvždyvždymindig
campaign_data.target_datasource.user_documents.implied_warranties string alwaysvždyvždymindig
campaign_data.target_datasource.user_documents.warranty_information string
campaign_data.target_datasource.additional_storefronts array of string
pause_scheduler object
pause_scheduler.pause_to string
pause_scheduler.pause_from string alwaysvždyvždymindig
pause_offers_sync boolean alwaysvždyvždymindig
storefront_currency string

app_ordelogyproducts_get_campaign_drafts Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

The eshop's saved campaign drafts (id, wizard step, name, marketplace, last modification; max 3 per eshop). Pass draft_id to fetch one draft with its full data blob — use that to resume work on it.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

draft_id integer optionalvolitelnévoliteľnéválasztható

Return this single draft including its full data blob; omit to list all drafts.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

id integer
data object
step integer
drafts array of object
last_modified string

app_ordelogyproducts_get_campaign_history Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

The campaign's event history: syncs, settings changes, errors — what happened and when. Call when the user says something used to work or asks what changed. Paginated — page through for more.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
date_from string optionalvolitelnévoliteľnéválasztható

Only events on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only events on or before this date (YYYY-MM-DD).
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
history_type string optionalvolitelnévoliteľnéválasztható

Event type group filter; one of: EDIT_CAMPAIGN, EDIT_OFFER, OFFER_STATUSES_SYNC, AVAILABILITY_FEED_SYNC, PRODUCT_FEED_SYNC, PRODUCT_LISTING, PRODUCT_EDITING, ADD_MISSING_PARAMETERS, CONNECTION_STATUS, CAMPAIGN_STATISTICS, PAUSING_OFFERS.
limit integer optionalvolitelnévoliteľnéválasztható

Events per page (1-50).
page integer optionalvolitelnévoliteľnéválasztható

Results page, 1-based.
severity_type string optionalvolitelnévoliteľnéválasztható

Severity group filter; one of: FAILED, EDIT, SUCCESS, UNCHANGED.

OutputVýstupVýstupKimenet

history array of object alwaysvždyvždymindig
history[].data string | object
history[].date string alwaysvždyvždymindig
history[].record string alwaysvždyvždymindig
pagination object alwaysvždyvždymindig
pagination.per_page integer alwaysvždyvždymindig
pagination.total_results integer alwaysvždyvždymindig

app_ordelogyproducts_get_campaign_last_syncs Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Timestamps of the campaign's last successful product-feed, availability-feed and offer-statuses syncs. Call when the user asks whether data is fresh, when the last export ran, or why the marketplace shows stale prices/stock.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

campaign_id integer alwaysvždyvždymindig
product_feed string
offer_statuses string
availability_feed string

app_ordelogyproducts_get_campaign_requirements Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Everything one marketplace connection requires for a valid campaign: required and identifier elements, global elements (campaign-wide fallback values — map elements from the feed first; go global only when the feed has no usable element), storefront choices, whether Allegro user documents / additional storefronts are needed (with the actual document choices), allowed CONDITION values, availability-feed suggestions and — for Kaufland with `storefront` set — shipping groups. Call right after list_connections when preparing a campaign. Sections that fail to load appear in `section_errors`.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

connection_id integer requiredpovinnépovinnékötelező

Marketplace connection ID — resolve it via list_connections.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
storefront string optionalvolitelnévoliteľnéválasztható

Kaufland storefront (country) code, e.g. CZ — when provided, the response also includes the shipping groups available on it.

OutputVýstupVýstupKimenet

marketplace string alwaysvždyvždymindig
storefronts array of string
connection_id integer alwaysvždyvždymindig
section_errors object
user_documents object
global_elements array of object alwaysvždyvždymindig
global_elements[].name string alwaysvždyvždymindig
global_elements[].required boolean alwaysvždyvždymindig
shipping_groups array of string
condition_values array of string
required_elements array of string alwaysvždyvždymindig
identifier_elements array of string alwaysvždyvždymindig
storefront_required boolean alwaysvždyvždymindig
user_documents_required boolean alwaysvždyvždymindig
availability_feed_suggestions array of string
additional_storefronts_required boolean alwaysvždyvždymindig

app_ordelogyproducts_get_campaign_stocks Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Stock levels of the campaign's non-deleted offers, keyed by PRODUCT_ID or EAN. Without `identifier` returns the paginated bulk list (with by=ean, offers without an EAN are skipped); with `identifier` returns that single product's stock (404 if not found). Call when the user asks how many pieces are exported to a marketplace. For GMC campaigns stock means availability text, not a piece count — the raw value may still be a number when the availability feed carries numeric STOCK/STOCK_QUANTITY; convert it when reporting: 0=out_of_stock, 1=in_stock, 2=backorder, 3=preorder, 4=limited_availability, other positive=in_stock, negative=out_of_stock.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
by enum optionalvolitelnévoliteľnéválasztható

Which product identifier to use: 'product_id' = the source-feed PRODUCT_ID, 'ean' = the offer's EAN.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
identifier string optionalvolitelnévoliteľnéválasztható

Look up a single product by this identifier value (a PRODUCT_ID or an EAN, per `by`); omit for the paginated bulk list.
limit integer optionalvolitelnévoliteľnéválasztható

Items per page in bulk mode (1-1000).
page integer optionalvolitelnévoliteľnéválasztható

Results page, 1-based.

OutputVýstupVýstupKimenet

ean string
items array of object
items[].ean string
items[].stock integer
items[].product_id string
stock integer
pagination object
pagination.per_page integer alwaysvždyvždymindig
pagination.total_results integer alwaysvždyvždymindig
product_id string
campaign_id integer alwaysvždyvždymindig

app_ordelogyproducts_get_campaign_validation Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Validator errors for one export campaign, grouped by error code with counts and English messages. Call when the user asks why offers are invalid, rejected or missing from a marketplace. Resolve campaign_id via list_campaigns first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

errors array of object alwaysvždyvždymindig
errors[].count integer alwaysvždyvždymindig
errors[].is_warning boolean alwaysvždyvždymindig
errors[].app_message string
errors[].app_error_code integer | string
campaign_id integer alwaysvždyvždymindig

app_ordelogyproducts_get_gmc_account_issues Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Account-level Google Merchant Center issues (suspensions, policy problems) recorded by the periodic account check. Call when GMC exports fail without campaign-level validation errors. Errors with 404 when the eshop has no GMC connection.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

account_issues array of object alwaysvždyvždymindig
account_issues[].title string alwaysvždyvždymindig
account_issues[].detail string
account_issues[].severity string alwaysvždyvždymindig
account_issues[].issue_code string alwaysvždyvždymindig
account_issues[].last_detected_at string
account_issues[].documentation_uri string
account_issues[].impacted_destinations array of string

app_ordelogyproducts_get_offer Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

One offer in full detail: every exported element, per-offer errors and protected elements. Resolve offer_id via list_offers first. Set include_marketplace_url=true to also fetch the offer's public marketplace URL (slower — live marketplace API call; null when unresolvable).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
offer_id integer requiredpovinnépovinnékötelező

Internal offer ID — resolve it via list_offers.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
include_marketplace_url boolean optionalvolitelnévoliteľnéválasztható

Also resolve the offer's public marketplace URL — slower (live marketplace API call); null when unresolvable.
storefront string optionalvolitelnévoliteľnéválasztható

Storefront (country) code for the marketplace URL, e.g. CZ; defaults to the campaign's storefront.

OutputVýstupVýstupKimenet

offer object alwaysvždyvždymindig
offer.id integer alwaysvždyvždymindig
offer.errors array of object alwaysvždyvždymindig
offer.status string alwaysvždyvždymindig
offer.elements array of object alwaysvždyvždymindig
offer.elements[].name string alwaysvždyvždymindig
offer.elements[].value string | array
offer.elements[].children array of object
offer.elements[].editable boolean alwaysvždyvždymindig
offer.elements[].required boolean alwaysvždyvždymindig
offer.elements[].protected boolean alwaysvždyvždymindig
offer.eshop_url string
offer.is_uptodate boolean alwaysvždyvždymindig
offer.storefront_currency string
offer.successfully_uploaded boolean alwaysvždyvždymindig
offer.additional_storefronts object alwaysvždyvždymindig
offer.has_protected_elements boolean alwaysvždyvždymindig
campaign_id integer alwaysvždyvždymindig
marketplace_url string

app_ordelogyproducts_get_order Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Full detail of one order: products, prices, customer, invoice and delivery addresses, payment, documents, notes, history and sync errors. Resolve order_id (the internal id) via list_orders first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

order_id integer requiredpovinnépovinnékötelező

Internal order ID — resolve it via list_orders.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

id integer alwaysvždyvždymindig
errors array of string alwaysvždyvždymindig
status object alwaysvždyvždymindig
status.type string alwaysvždyvždymindig
status.display_name string alwaysvždyvždymindig
history array of object alwaysvždyvždymindig
history[].date string alwaysvždyvždymindig
history[].event string alwaysvždyvždymindig
history[].origin string
history[].is_error boolean alwaysvždyvždymindig
invoice object alwaysvždyvždymindig
invoice.city string
invoice.street string
invoice.company object alwaysvždyvždymindig
invoice.company.id string
invoice.company.name string
invoice.company.id_type string
invoice.required boolean
invoice.zip_code string
invoice.last_name string
invoice.first_name string
invoice.country_code string
invoice.phone_number string
payment object alwaysvždyvždymindig
payment.paid object alwaysvždyvždymindig
payment.paid.amount string
payment.paid.currency string
payment.method string
payment.provider string
customer object alwaysvždyvždymindig
customer.email string
customer.last_name string
customer.first_name string
customer.company_name string
customer.phone_number string
eshop_id integer alwaysvždyvždymindig
order_id string alwaysvždyvždymindig
products array of object alwaysvždyvždymindig
products[].id integer alwaysvždyvždymindig
products[].vat string
products[].gtin string
products[].name string
products[].price object alwaysvždyvždymindig
products[].price.amount string
products[].price.currency string
products[].amount string alwaysvždyvždymindig
products[].offer_id integer
products[].image_url string
products[].product_id string
products[].campaign_id integer
products[].additional_services array of object
shipping object alwaysvždyvždymindig
shipping.price object alwaysvždyvždymindig
shipping.price.amount string
shipping.price.currency string
shipping.method string
documents array of object alwaysvždyvždymindig
documents[].url string
documents[].name string
order_url string
created_at string
storefront string
fulfillment string
marketplace string alwaysvždyvždymindig
sync_status string alwaysvždyvždymindig
total_price object alwaysvždyvždymindig
total_price.amount string
total_price.currency string
seller_notes string
customer_notes string
internal_notes string
delivery_address object alwaysvždyvždymindig
delivery_address.city string
delivery_address.street string
delivery_address.zip_code string
delivery_address.last_name string
delivery_address.first_name string
delivery_address.company_name string
delivery_address.country_code string
delivery_address.phone_number string
delivery_address.pickup_point object alwaysvždyvždymindig
delivery_address.pickup_point.city string
delivery_address.pickup_point.street string
delivery_address.pickup_point.zip_code string
delivery_address.pickup_point.pickup_id string
delivery_address.pickup_point.pickup_name string
delivery_address.pickup_point.country_code string
external_order_id string

app_ordelogyproducts_get_orders_statistics Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Order statistics for the eshop: order/return counts, profit, averages and a profit/amount time series, with growth vs the previous period. Filter by marketplace, order status or period (custom_date preset or date_from/date_to in YYYY-MM-DD). Call when the user asks how sales are going.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

currency string optionalvolitelnévoliteľnéválasztható

Currency for monetary figures; one of: CZK, PLN, EUR, HUF, USD.
custom_date string optionalvolitelnévoliteľnéválasztható

Preset time period; one of: WEEK, TWO_WEEKS, ONE_MONTH, TWO_MONTHS, THREE_MONTHS, SIX_MONTHS, YEAR. Alternative to date_from/date_to.
date_from string optionalvolitelnévoliteľnéválasztható

Period start (YYYY-MM-DD); use with date_to.
date_to string optionalvolitelnévoliteľnéválasztható

Period end (YYYY-MM-DD); use with date_from.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
marketplace string optionalvolitelnévoliteľnéválasztható

Marketplace filter; one of: ALLEGRO, KAUFLAND, GOOGLE_MERCHANT_CENTER, AMAZON.
status string optionalvolitelnévoliteľnéválasztható

Order status filter; one of: OPEN, READY, PROCESSING, SENT, ONHOLD, RETURNED, CANCELLED, UNKNOWN.

OutputVýstupVýstupKimenet

orders object alwaysvždyvždymindig
orders.value number alwaysvždyvždymindig
orders.growth integer
orders.is_positive boolean
profit object alwaysvždyvždymindig
profit.value number alwaysvždyvždymindig
profit.growth integer
profit.is_positive boolean
average object alwaysvždyvždymindig
average.value number alwaysvždyvždymindig
average.growth integer
average.is_positive boolean
returns object alwaysvždyvždymindig
returns.value number alwaysvždyvždymindig
returns.growth integer
returns.is_positive boolean
profit_amount_graph array of object alwaysvždyvždymindig
profit_amount_graph[].date string alwaysvždyvždymindig
profit_amount_graph[].amount number alwaysvždyvždymindig
profit_amount_graph[].profit number alwaysvždyvždymindig

app_ordelogyproducts_get_seller_rating Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Seller quality score of an ALLEGRO campaign, fetched live from Allegro. Other marketplaces do not publish one and return an error. Call when the user asks about their Allegro seller rating or account quality.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

quality array of string alwaysvždyvždymindig
campaign_id integer alwaysvždyvždymindig

app_ordelogyproducts_list_campaigns Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

List the eshop's marketplace export campaigns in the Marketplaces app: id, name, marketplace, storefront, last sync, alerts and offer-status counts. Call this first to resolve the campaign_id needed by other tools, or when the user asks what they export where. Paginated — page through for more.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
limit integer optionalvolitelnévoliteľnéválasztható

Campaigns per page (1-50).
page integer optionalvolitelnévoliteľnéválasztható

Results page, 1-based.

OutputVýstupVýstupKimenet

eshop_id integer alwaysvždyvždymindig
campaigns array of object alwaysvždyvždymindig
campaigns[].id integer alwaysvždyvždymindig
campaigns[].name string alwaysvždyvždymindig
campaigns[].alerts array of string alwaysvždyvždymindig
campaigns[].statuses object alwaysvždyvždymindig
campaigns[].statuses.ENDED integer
campaigns[].statuses.ACTIVE integer
campaigns[].statuses.FAILED integer
campaigns[].statuses.ONHOLD integer
campaigns[].statuses.PAUSED integer
campaigns[].statuses.BUYABLE integer
campaigns[].statuses.UNKNOWN integer
campaigns[].statuses.APPROVED integer
campaigns[].statuses.INACTIVE integer
campaigns[].statuses.AVAILABLE integer
campaigns[].statuses.ACTIVATING integer
campaigns[].statuses.INCOMPLETE integer
campaigns[].statuses.ACTIVE_ERROR integer
campaigns[].statuses.DISCOVERABLE integer
campaigns[].statuses.NOT_APPROVED integer
campaigns[].statuses.UNDER_REVIEW integer
campaigns[].storefront string
campaigns[].last_change string
campaigns[].marketplace string alwaysvždyvždymindig
campaigns[].total_offers integer alwaysvždyvždymindig
campaigns[].pause_price_sync boolean alwaysvždyvždymindig
campaigns[].pause_offers_sync boolean alwaysvždyvždymindig
pagination object alwaysvždyvždymindig
pagination.per_page integer alwaysvždyvždymindig
pagination.total_results integer alwaysvždyvždymindig

app_ordelogyproducts_list_connections Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

All marketplace/eshop/ERP connections of the eshop with their IDs, linked campaigns, failed flags and masked credentials. Call to resolve the connection_id needed for campaign creation, or when the user asks what is connected, whether a marketplace connection is failing or why exports stopped. Never returns usable credentials.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

UNAS object
UNAS.id integer alwaysvždyvždymindig
UNAS.url string
UNAS.active boolean alwaysvždyvždymindig
UNAS.client string
UNAS.failed boolean alwaysvždyvždymindig
UNAS.secret string
UNAS.pairing_data object
UNAS.invoice_sync_enabled boolean
UNAS.invoice_sync_supported boolean
AMAZON object
AMAZON.id integer alwaysvždyvždymindig
AMAZON.client string
AMAZON.failed boolean alwaysvždyvždymindig
AMAZON.secret string
AMAZON.campaigns array of object alwaysvždyvždymindig
AMAZON.campaigns[].id integer alwaysvždyvždymindig
AMAZON.campaigns[].name string alwaysvždyvždymindig
AMAZON.storefront string
AMAZON.account_name string
AMAZON.has_account_issues boolean
POHODA object
POHODA.id integer alwaysvždyvždymindig
POHODA.ico string alwaysvždyvždymindig
POHODA.active boolean alwaysvždyvždymindig
POHODA.password string
POHODA.username string
POHODA.pairing_data object
ALLEGRO object
ALLEGRO.id integer alwaysvždyvždymindig
ALLEGRO.client string
ALLEGRO.failed boolean alwaysvždyvždymindig
ALLEGRO.secret string
ALLEGRO.campaigns array of object alwaysvždyvždymindig
ALLEGRO.campaigns[].id integer alwaysvždyvždymindig
ALLEGRO.campaigns[].name string alwaysvždyvždymindig
ALLEGRO.storefront string
ALLEGRO.account_name string
ALLEGRO.has_account_issues boolean
SHOPIFY object
SHOPIFY.id integer alwaysvždyvždymindig
SHOPIFY.url string
SHOPIFY.active boolean alwaysvždyvždymindig
SHOPIFY.client string
SHOPIFY.failed boolean alwaysvždyvždymindig
SHOPIFY.secret string
SHOPIFY.pairing_data object
SHOPIFY.invoice_sync_enabled boolean
SHOPIFY.invoice_sync_supported boolean
UPGATES object
UPGATES.id integer alwaysvždyvždymindig
UPGATES.url string
UPGATES.active boolean alwaysvždyvždymindig
UPGATES.client string
UPGATES.failed boolean alwaysvždyvždymindig
UPGATES.secret string
UPGATES.pairing_data object
UPGATES.invoice_sync_enabled boolean
UPGATES.invoice_sync_supported boolean
KAUFLAND object
KAUFLAND.id integer alwaysvždyvždymindig
KAUFLAND.client string
KAUFLAND.failed boolean alwaysvždyvždymindig
KAUFLAND.secret string
KAUFLAND.campaigns array of object alwaysvždyvždymindig
KAUFLAND.campaigns[].id integer alwaysvždyvždymindig
KAUFLAND.campaigns[].name string alwaysvždyvždymindig
KAUFLAND.storefront string
KAUFLAND.account_name string
KAUFLAND.has_account_issues boolean
WOOCOMMERCE object
WOOCOMMERCE.id integer alwaysvždyvždymindig
WOOCOMMERCE.url string
WOOCOMMERCE.active boolean alwaysvždyvždymindig
WOOCOMMERCE.client string
WOOCOMMERCE.failed boolean alwaysvždyvždymindig
WOOCOMMERCE.secret string
WOOCOMMERCE.pairing_data object
WOOCOMMERCE.invoice_sync_enabled boolean
WOOCOMMERCE.invoice_sync_supported boolean
SHOPTET_PREMIUM object
SHOPTET_PREMIUM.id integer alwaysvždyvždymindig
SHOPTET_PREMIUM.url string
SHOPTET_PREMIUM.active boolean alwaysvždyvždymindig
SHOPTET_PREMIUM.client string
SHOPTET_PREMIUM.failed boolean alwaysvždyvždymindig
SHOPTET_PREMIUM.secret string
SHOPTET_PREMIUM.pairing_data object
SHOPTET_PREMIUM.invoice_sync_enabled boolean
SHOPTET_PREMIUM.invoice_sync_supported boolean
GOOGLE_MERCHANT_CENTER object
GOOGLE_MERCHANT_CENTER.id integer alwaysvždyvždymindig
GOOGLE_MERCHANT_CENTER.client string
GOOGLE_MERCHANT_CENTER.failed boolean alwaysvždyvždymindig
GOOGLE_MERCHANT_CENTER.secret string
GOOGLE_MERCHANT_CENTER.campaigns array of object alwaysvždyvždymindig
GOOGLE_MERCHANT_CENTER.campaigns[].id integer alwaysvždyvždymindig
GOOGLE_MERCHANT_CENTER.campaigns[].name string alwaysvždyvždymindig
GOOGLE_MERCHANT_CENTER.storefront string
GOOGLE_MERCHANT_CENTER.account_name string
GOOGLE_MERCHANT_CENTER.has_account_issues boolean

app_ordelogyproducts_list_offers Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

The campaign's offers with statuses and errors — find a product by PRODUCT_ID or free text, or filter by marketplace status, sync flags or error code/severity. Call when the user asks which products are rejected, missing or failing. Paginated — page through for more.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
app_error_code string optionalvolitelnévoliteľnéválasztható

Only offers failing with this validator error code (codes come from get_campaign_validation).
error_severity string optionalvolitelnévoliteľnéválasztható

Error severity group filter; one of: FATAL, WARNING, ACTIVE_ERROR.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
has_protected_elements boolean optionalvolitelnévoliteľnéválasztható

Only offers with (true) / without (false) protected elements — values locked against feed overwrites.
limit integer optionalvolitelnévoliteľnéválasztható

Offers per page (1-49).
page integer optionalvolitelnévoliteľnéválasztható

Results page, 1-based.
product_id string optionalvolitelnévoliteľnéválasztható

Exact source-feed PRODUCT_ID of the offer.
search_text string optionalvolitelnévoliteľnéválasztható

Free-text search in product names and identifiers.
status string optionalvolitelnévoliteľnéválasztható

Offer status filter; one of: ACTIVATING, ACTIVE, ACTIVE_ERROR, APPROVED, AVAILABLE, BUYABLE, DISCOVERABLE, ENDED, FAILED, INACTIVE, INCOMPLETE, NOT_APPROVED, ONHOLD, PAUSED, UNDER_REVIEW, UNKNOWN.
up_to_date boolean optionalvolitelnévoliteľnéválasztható

Only offers whose exported data is (true) / is not (false) up to date with the source feed.
uploaded_to_marketplace boolean optionalvolitelnévoliteľnéválasztható

Only offers that were (true) / were not (false) successfully uploaded to the marketplace.

OutputVýstupVýstupKimenet

offers array of object alwaysvždyvždymindig
offers[].id integer alwaysvždyvždymindig
offers[].errors array of object alwaysvždyvždymindig
offers[].status string alwaysvždyvždymindig
offers[].elements array of object alwaysvždyvždymindig
offers[].elements[].name string alwaysvždyvždymindig
offers[].elements[].value string | array
offers[].elements[].children array of object
offers[].elements[].editable boolean alwaysvždyvždymindig
offers[].elements[].required boolean alwaysvždyvždymindig
offers[].elements[].protected boolean alwaysvždyvždymindig
offers[].eshop_url string
offers[].is_uptodate boolean alwaysvždyvždymindig
offers[].storefront_currency string
offers[].successfully_uploaded boolean alwaysvždyvždymindig
offers[].additional_storefronts object alwaysvždyvždymindig
offers[].has_protected_elements boolean alwaysvždyvždymindig
pagination object alwaysvždyvždymindig
pagination.per_page integer alwaysvždyvždymindig
pagination.total_results integer alwaysvždyvždymindig
storefront_currency string
products_are_syncing boolean alwaysvždyvždymindig
additional_storefronts array of string

app_ordelogyproducts_list_orders Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Marketplace orders of the eshop with status statistics: customer, addresses, payment, per-product detail, notes and sync errors (English). Call when the user asks about orders, their sync into the eshop, or order errors. Rows are detailed — keep `limit` low unless more is needed. Paginated — page through for more.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Only orders created on or after this date (YYYY-MM-DD).
date_to string optionalvolitelnévoliteľnéválasztható

Only orders created on or before this date (YYYY-MM-DD).
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
is_synced boolean optionalvolitelnévoliteľnéválasztható

Filter by whether the order was successfully synced into the eshop platform.
limit integer optionalvolitelnévoliteľnéválasztható

Orders per page (1-100).
marketplace string optionalvolitelnévoliteľnéválasztható

Marketplace filter; one of: ALLEGRO, KAUFLAND, GOOGLE_MERCHANT_CENTER, AMAZON.
page integer optionalvolitelnévoliteľnéválasztható

Results page, 1-based.
search_text string optionalvolitelnévoliteľnéválasztható

Free-text search across order number, customer and product names.
status string optionalvolitelnévoliteľnéválasztható

Order status filter; one of: OPEN, READY, PROCESSING, SENT, ONHOLD, RETURNED, CANCELLED, UNKNOWN.
storefront string optionalvolitelnévoliteľnéválasztható

Storefront (country) code filter, e.g. CZ, SK, DE.

OutputVýstupVýstupKimenet

orders array of object alwaysvždyvždymindig
orders[].id integer alwaysvždyvždymindig
orders[].errors array of string alwaysvždyvždymindig
orders[].status object alwaysvždyvždymindig
orders[].status.type string alwaysvždyvždymindig
orders[].status.display_name string alwaysvždyvždymindig
orders[].invoice object alwaysvždyvždymindig
orders[].invoice.city string
orders[].invoice.street string
orders[].invoice.company object alwaysvždyvždymindig
orders[].invoice.company.id string
orders[].invoice.company.name string
orders[].invoice.company.id_type string
orders[].invoice.required boolean
orders[].invoice.zip_code string
orders[].invoice.last_name string
orders[].invoice.first_name string
orders[].invoice.country_code string
orders[].invoice.phone_number string
orders[].payment object alwaysvždyvždymindig
orders[].payment.paid object alwaysvždyvždymindig
orders[].payment.paid.amount string
orders[].payment.paid.currency string
orders[].payment.method string
orders[].payment.provider string
orders[].customer object alwaysvždyvždymindig
orders[].customer.email string
orders[].customer.last_name string
orders[].customer.first_name string
orders[].customer.company_name string
orders[].customer.phone_number string
orders[].eshop_id integer alwaysvždyvždymindig
orders[].order_id string alwaysvždyvždymindig
orders[].products array of object alwaysvždyvždymindig
orders[].products[].id integer alwaysvždyvždymindig
orders[].products[].vat string
orders[].products[].gtin string
orders[].products[].name string
orders[].products[].price object alwaysvždyvždymindig
orders[].products[].price.amount string
orders[].products[].price.currency string
orders[].products[].amount string alwaysvždyvždymindig
orders[].products[].offer_id integer
orders[].products[].image_url string
orders[].products[].product_id string
orders[].products[].campaign_id integer
orders[].products[].additional_services array of object
orders[].shipping object alwaysvždyvždymindig
orders[].shipping.price object alwaysvždyvždymindig
orders[].shipping.price.amount string
orders[].shipping.price.currency string
orders[].shipping.method string
orders[].documents array of object alwaysvždyvždymindig
orders[].documents[].url string
orders[].documents[].name string
orders[].order_url string
orders[].created_at string
orders[].storefront string
orders[].fulfillment string
orders[].marketplace string alwaysvždyvždymindig
orders[].sync_status string alwaysvždyvždymindig
orders[].total_price object alwaysvždyvždymindig
orders[].total_price.amount string
orders[].total_price.currency string
orders[].seller_notes string
orders[].customer_notes string
orders[].internal_notes string
orders[].delivery_address object alwaysvždyvždymindig
orders[].delivery_address.city string
orders[].delivery_address.street string
orders[].delivery_address.zip_code string
orders[].delivery_address.last_name string
orders[].delivery_address.first_name string
orders[].delivery_address.company_name string
orders[].delivery_address.country_code string
orders[].delivery_address.phone_number string
orders[].delivery_address.pickup_point object alwaysvždyvždymindig
orders[].delivery_address.pickup_point.city string
orders[].delivery_address.pickup_point.street string
orders[].delivery_address.pickup_point.zip_code string
orders[].delivery_address.pickup_point.pickup_id string
orders[].delivery_address.pickup_point.pickup_name string
orders[].delivery_address.pickup_point.country_code string
orders[].external_order_id string
pagination object alwaysvždyvždymindig
pagination.per_page integer alwaysvždyvždymindig
pagination.total_results integer alwaysvždyvždymindig
statistics object alwaysvždyvždymindig

app_ordelogyproducts_pause_campaign_offers Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Pauses sales of ALL offers in a campaign (activate=true resumes them). Affects the whole campaign on the live marketplace — confirm with the user before pausing. Refused while a pause scheduler is active on the campaign.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
activate boolean optionalvolitelnévoliteľnéválasztható

false = pause sales, true = resume them.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_sample_project_element_values Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Sample output values per feed element of a Mergado project, in one call — the evidence for building `mapped_elements` yourself when describe_mergado_project returns no suggested_mapping (unsupported feed format). Match Marketplaces elements (from get_campaign_requirements) to feed elements on names AND sampled values — values disambiguate look-alikes (which price includes VAT, EAN vs internal code) — then present the complete proposed mapping to the user for review and verify it with validate_campaign_data. If no feed element convincingly matches a required Marketplaces element, do NOT force the closest look-alike — tell the user what's missing and ask. Mapping from the feed is ALWAYS the primary goal; a global_elements value (e.g. HANDLING_TIME/CONDITION) is only the fallback when the feed truly has no usable element, never the default. Elements whose fetch fails are omitted from the result; an empty list means the element exists but has no output values (don't map it). May take tens of seconds when sampling a whole project.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id integer requiredpovinnépovinnékötelező

Mergado project ID — resolve it via the Mergado hub's list_shop_projects.
elements array optionalvolitelnévoliteľnéválasztható

Feed element names to sample (nested paths as 'parent | child'); omit to sample every non-hidden element in the project.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

element_samples object alwaysvždyvždymindig

app_ordelogyproducts_save_campaign_draft Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Saves assembled campaign data as a draft the user can review, finish and launch in the app's campaign wizard — the safe default handoff of agent-assisted campaign creation (use create_campaign only when the user explicitly wants the campaign live immediately). Validate with validate_campaign_data first. Without draft_id creates a new draft (fails when the eshop already has 3); with draft_id overwrites that draft.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

Campaign data in the wizard shape: name, target_datasource{id, storefront?, user_documents?, additional_storefronts?, shipping_group?, reconnect_to_existing_offers?}, source_datasource{type, project, query}, mapped_elements {MARKETPLACES_ELEMENT: feed element name or list}, global_elements, availability_feed{url | product_feed_url}. Source valid values from get_campaign_requirements and describe_mergado_project; query ids and feed element names from the Mergado hub's list_project_queries / list_project_elements.
step integer requiredpovinnépovinnékötelező

Number of completed campaign-wizard steps (1-4): 1 name, 2 marketplace, 3 feed+mapping, 4 availability feed — use 4 when all data is filled in.
draft_id integer optionalvolitelnévoliteľnéválasztható

Existing draft to overwrite; omit to create a new draft.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_set_pause_scheduler Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Schedules a sales pause for the campaign (e.g. over holidays): offers pause at pause_from and resume at pause_to. Timestamps are ISO format (YYYY-MM-DDTHH:MM:SS); omit pause_to to pause until manually resumed. Calling again overwrites the existing schedule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
pause_from string requiredpovinnépovinnékötelező

When sales pause — ISO datetime, YYYY-MM-DDTHH:MM:SS.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
pause_to string optionalvolitelnévoliteľnéválasztható

When sales resume (ISO datetime); omit to pause until manually resumed.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_toggle_offer_pause Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Pauses an active offer or resumes a paused one on the marketplace — the same switch as the UI pause button; the response says which happened. Use for a single product ("take this off Kaufland now"); the change is reversible by calling again. Resolve offer_id via list_offers first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
offer_id integer requiredpovinnépovinnékötelező

Internal offer ID — resolve it via list_offers.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_trigger_product_feed_sync Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Triggers a full product-feed synchronization of the campaign now, instead of waiting for the schedule — use after the user fixed their feed. Refused when the campaign is paused, already syncing, or its connection is failed.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

campaign_id integer requiredpovinnépovinnékötelező

Internal campaign ID — resolve it via list_campaigns.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_update_order_internal_note Mergado Marketplaces Writes dataZapisuje dataZapisuje dátaAdatot ír

Sets the internal (staff-only) note of an order — overwrites any existing note; the customer never sees it. Resolve order_id via list_orders first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

internal_note string requiredpovinnépovinnékötelező

New note text — overwrites the existing note. Staff-only, never shown to the customer.
order_id integer requiredpovinnépovinnékötelező

Internal order ID — resolve it via list_orders.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_ordelogyproducts_validate_campaign_data Mergado Marketplaces Read-onlyPouze čteníIba čítanieCsak olvasás

Validates (partial) campaign data exactly like the app's creation wizard — nothing is saved. On failure the error message names the problem and the wizard step (0 name, 1 marketplace, 2 feed+mapping, 3 availability feed); fix and call again until it passes. May take tens of seconds — it downloads and checks the availability feed.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

Campaign data in the wizard shape: name, target_datasource{id, storefront?, user_documents?, additional_storefronts?, shipping_group?, reconnect_to_existing_offers?}, source_datasource{type, project, query}, mapped_elements {MARKETPLACES_ELEMENT: feed element name or list}, global_elements, availability_feed{url | product_feed_url}. Source valid values from get_campaign_requirements and describe_mergado_project; query ids and feed element names from the Mergado hub's list_project_queries / list_project_elements.
eshop_id integer optionalvolitelnévoliteľnéválasztható

Mergado eshop (shop) ID the call targets. Omit when authenticated with a shop token — it defaults to the token's own shop. User and project tokens must always provide it; their access to the shop is verified with Mergado.
ignore_missing_products boolean optionalvolitelnévoliteľnéválasztható

Skip the check that availability-feed products match the product feed — the wizard's 'continue anyway' confirmation.
last_step integer optionalvolitelnévoliteľnéválasztható

Validate only wizard steps up to this one (1-4); omit to validate everything provided.

OutputVýstupVýstupKimenet

extra object
message string alwaysvždyvždymindig

app_pricingfox_clone_rules Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Clones (duplicates) one or more pricing rules.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_ids array optionalvolitelnévoliteľnéválasztható

Array of IDs of the rules to clone (1-100 items).

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_create_rule Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates a new pricing rule in the project. PAID, per project. Only when the price must react to COMPETITOR prices from Heureka/Zbozi.cz; plain arithmetic is the free create_calc_rule. Pricing rules are first-match-wins.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

apply_to string optionalvolitelnévoliteľnéválasztható

What the rule applies to: all (all products), queries (mergado queries – then fill in mergado_queries), filters (product filters – then fill in filters).
condition_join_operator string optionalvolitelnévoliteľnéválasztható

Operator joining the conditions: and or or. Default: and.
condition_selector string optionalvolitelnévoliteľnéválasztható

How to pick the price from the conditions: min (lowest), max (highest), avg (average), first (first matching).
conditions array optionalvolitelnévoliteľnéválasztható

Rule conditions. Each condition must contain: source (heureka|mergado|input_price|import_price|kaufland|zbozi|gmc), type, operator, value (array of values).
diff_type string optionalvolitelnévoliteľnéválasztható

Difference type: relative (percentage), absolute (absolute amount in the project currency).
diff_value number optionalvolitelnévoliteľnéválasztható

Price change value. Required unless type is equals.
filters array optionalvolitelnévoliteľnéválasztható

Array of product filter IDs. Required when apply_to=filters.
final boolean optionalvolitelnévoliteľnéválasztható

If true, no further rules are evaluated once this rule is applied.
is_margin boolean optionalvolitelnévoliteľnéválasztható

The rule works with the margin instead of the price.
is_test boolean optionalvolitelnévoliteľnéválasztható

Test rule – it is not calculated into the feed output.
manual_limit_max_price number optionalvolitelnévoliteľnéválasztható

Maximum absolute product price after the rule is applied.
manual_limit_min_price number optionalvolitelnévoliteľnéválasztható

Minimum absolute product price after the rule is applied.
margin_limit_max number optionalvolitelnévoliteľnéválasztható

Maximum margin in percent.
margin_limit_min number optionalvolitelnévoliteľnéválasztható

Minimum margin in percent.
mergado_queries array optionalvolitelnévoliteľnéválasztható

Array of mergado query IDs. Required when apply_to=queries.
name string optionalvolitelnévoliteľnéválasztható

Rule name.
overcharge_limit_max number optionalvolitelnévoliteľnéválasztható

Maximum markup against the competition in percent.
overcharge_limit_min number optionalvolitelnévoliteľnéválasztható

Minimum markup against the competition in percent.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rounding_type string optionalvolitelnévoliteľnéválasztható

How to round the resulting price: ceil (up), floor (down), round (standard).
rounding_value integer optionalvolitelnévoliteľnéválasztható

Round to the nearest multiple (1 = units, 10 = tens, 100 = hundreds).
skip_reference boolean optionalvolitelnévoliteľnéválasztható

Skip the reference price when applying the rule.
start_at string optionalvolitelnévoliteľnéválasztható

Date when the rule becomes active, in the YYYY-MM-DD format.
stop_at string optionalvolitelnévoliteľnéválasztható

Date when the rule is deactivated, in the YYYY-MM-DD format.
type string optionalvolitelnévoliteľnéválasztható

Rule type: plus (add to the price), minus (subtract from the price), equals (set to an exact value).

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_edit_rule Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Edits an existing pricing rule in the project. All required fields must always be sent (not just the changed ones) – load the current rule via list_rules first and resend the unchanged values as they are. PAID, per project. Only when the price must react to COMPETITOR prices from Heureka/Zbozi.cz; plain arithmetic is the free create_calc_rule. Pricing rules are first-match-wins.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

condition_selector string requiredpovinnépovinnékötelező

How to pick the price from the conditions: min (lowest), max (highest), avg (average), first (first matching).
conditions array requiredpovinnépovinnékötelező

New rule conditions (they replace the existing ones). Each condition must contain: source (heureka|mergado|input_price|import_price|kaufland|zbozi|gmc), type, operator, value (array of values).
diff_type string requiredpovinnépovinnékötelező

Difference type: relative (percentage), absolute (absolute amount in the project currency).
final boolean requiredpovinnépovinnékötelező

If true, no further rules are evaluated once this rule is applied.
name string requiredpovinnépovinnékötelező

New rule name.
rounding_type string requiredpovinnépovinnékötelező

Rounding mode: ceil (up), floor (down), round (standard).
rounding_value integer requiredpovinnépovinnékötelező

Round to the nearest multiple (1 = units, 10 = tens).
type string requiredpovinnépovinnékötelező

Rule type: plus (add to the price), minus (subtract from the price), equals (set to an exact value).
active boolean optionalvolitelnévoliteľnéválasztható

Activate or deactivate the rule.
apply_to string optionalvolitelnévoliteľnéválasztható

What the rule applies to: all (all products), queries (mergado queries), filters (product filters).
condition_join_operator string optionalvolitelnévoliteľnéválasztható

Operator joining the conditions: and or or.
diff_value number optionalvolitelnévoliteľnéválasztható

Price change value.
filters array optionalvolitelnévoliteľnéválasztható

Array of product filter IDs. Required when apply_to=filters.
is_margin boolean optionalvolitelnévoliteľnéválasztható

The rule works with the margin instead of the price.
is_test boolean optionalvolitelnévoliteľnéválasztható

Test rule – it is not calculated into the feed output.
manual_limit_max_price number optionalvolitelnévoliteľnéválasztható

Maximum absolute product price after the rule is applied.
manual_limit_min_price number optionalvolitelnévoliteľnéválasztható

Minimum absolute product price after the rule is applied.
margin_limit_max number optionalvolitelnévoliteľnéválasztható

Maximum margin in percent.
margin_limit_min number optionalvolitelnévoliteľnéválasztható

Minimum margin in percent.
mergado_queries array optionalvolitelnévoliteľnéválasztható

Array of mergado query IDs. Required when apply_to=queries.
overcharge_limit_max number optionalvolitelnévoliteľnéválasztható

Maximum markup against the competition in percent.
overcharge_limit_min number optionalvolitelnévoliteľnéválasztható

Minimum markup against the competition in percent.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_id integer optionalvolitelnévoliteľnéválasztható

ID of the rule to edit.
skip_reference boolean optionalvolitelnévoliteľnéválasztható

Skip the reference price when applying the rule.
start_at string optionalvolitelnévoliteľnéválasztható

Date when the rule becomes active, in the YYYY-MM-DD format.
stop_at string optionalvolitelnévoliteľnéválasztható

Date when the rule is deactivated, in the YYYY-MM-DD format.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_get_competitor Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns detailed data about a specific competitor, including their metrics history for the given period.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

competitor_slug string optionalvolitelnévoliteľnéválasztható

Competitor slug.
date_from string optionalvolitelnévoliteľnéválasztható

Start date of the competitor history in the Y-m-d format (optional, defaults to 30 days ago).
date_to string optionalvolitelnévoliteľnéválasztható

End date of the competitor history in the Y-m-d format (optional, defaults to today).
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

slug string

Competitor identifier.
current string

Current competitor statistics.
date_to string

End of the period.
history string

Competitor statistics history.
watched string

Whether the competitor is watched.
date_from string

Start of the period.
compare_to string

Comparison with the project.
content_hash string

Hash of the data.

app_pricingfox_get_export Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the detail of a single export. Pricing Fox export = repriced data to an economic system or shop platform. Not the Mergado output feed (core get_export_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

export_id integer optionalvolitelnévoliteľnéválasztható

Export ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

id integer

Export ID.
name string

Export name.
user object

Pricing Fox user.
user.id integer

User ID.
user.name string
user.email string
engine string
locale string
status string

Export status (e.g. created, queued, generating, done, failed).
exporter string

Export format and settings.
periodic boolean

Whether the export is regenerated periodically.
schedule string

Export schedule.
created_at string

Format "Y-m-d H:i:s".
public_url string

Public URL of the generated file.
data_source string

Exported data source.
finished_at string

Format "Y-m-d H:i:s".
items_total integer
content_hash string

Hash of the data.
download_url string

Download URL of the generated file.
items_written integer
items_completed integer

app_pricingfox_get_import Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the detail of a single import. Pricing Fox import = a competitor-data connector. Not the Mergado input feed (core get_import_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

import_id integer optionalvolitelnévoliteľnéválasztható

Import ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

id integer

Import ID.
name string

Import name.
user object

Pricing Fox user.
user.id integer

User ID.
user.name string
user.email string
active boolean

Whether the import is running periodically.
engine string
status string

Import status.
retries integer
warning boolean

True when an active import has not finished in the last 24 hours.
schedule string

Import schedule.
created_at string

Format "Y-m-d H:i:s".
updated_at string

Format "Y-m-d H:i:s".
finished_at string

Format "Y-m-d H:i:s".
import_type string
items_total integer

Total number of items.
content_hash string

Hash of the data.
items_written integer

Number of imported items.
import_settings string

Import settings.

app_pricingfox_get_insights Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the insights of the project – changes detected over the last 30 days (price changes, competitor and rule product counts, new and dropped products).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

content_hash string

Hash of the data.
new_products array | object

New products. Keyed by date.
new_products[].id integer

Insight ID.
new_products[].data string

Insight data.
new_products[].date string

Date of the insight.
dropped_products array | object

Dropped products. Keyed by date.
dropped_products[].id integer

Insight ID.
dropped_products[].data string

Insight data.
dropped_products[].date string

Date of the insight.
product_pricing_change array | object

Products with the biggest price change. Keyed by date.
product_pricing_change[].id integer

Insight ID.
product_pricing_change[].data string

Insight data.
product_pricing_change[].date string

Date of the insight.
project_metrics_change array | object

Changes of project metrics. Keyed by date.
project_metrics_change[].id integer

Insight ID.
project_metrics_change[].data string

Insight data.
project_metrics_change[].date string

Date of the insight.
continuous_pricing_change array | object

Products with a continuous price change. Keyed by date.
continuous_pricing_change[].id integer

Insight ID.
continuous_pricing_change[].data string

Insight data.
continuous_pricing_change[].date string

Date of the insight.
rules_product_count_change array | object

Changes of rule product counts. Keyed by date.
rules_product_count_change[].id integer

Insight ID.
rules_product_count_change[].data string

Insight data.
rules_product_count_change[].date string

Date of the insight.
watched_competitors_change array | object

Changes of watched competitors. Keyed by date.
watched_competitors_change[].id integer

Insight ID.
watched_competitors_change[].data string

Insight data.
watched_competitors_change[].date string

Date of the insight.
competitor_product_count_change array | object

Changes of competitor product counts. Keyed by date.
competitor_product_count_change[].id integer

Insight ID.
competitor_product_count_change[].data string

Insight data.
competitor_product_count_change[].date string

Date of the insight.

app_pricingfox_get_keychain Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the detail of a single API key stored in the keychain.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

keychain_id integer optionalvolitelnévoliteľnéválasztható

ID of the keychain record (API key).
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

id integer

Keychain ID.
name enum

Keychain type.
config string

Keychain configuration.
enable boolean

Whether the keychain is enabled.
created_at string

Format "Y-m-d H:i:s".
project_id integer
updated_at string

Format "Y-m-d H:i:s".
content_hash string

Hash of the data.

app_pricingfox_get_product Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns detailed information about a single product.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

product_id integer optionalvolitelnévoliteľnéválasztható

Unique product ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

pricing string

Pricing result (resulting price, applied rule, ...).
mergado_id integer

Product ID.
pairing_id string

Pairing ID of the product.
history_ga4 string

Google Analytics 4 history.
is_favorite boolean

Whether the product is watched.
content_hash string

Hash of the data.
product_tags string

Product tags.
shark_heureka string

Heureka positions of the product.
manual_pricing string

Manual price, if set.
source_heureka string

Heureka statistics of the product.
source_mergado string

Product data from the feed (name, price, ...).
history_heureka string

Heureka history.
history_mergado string

Feed data history.
history_pricing string

Pricing history.
history_scraper string

Heureka offers history.
history_shoptet string

Shoptet history.
scraper_heureka string

Heureka offers of the product.
landing_page_path string
report_zbozi_history string

Zbozi.cz history.
scraper_failed_reason string

app_pricingfox_get_product_history Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the history of prices and other product data for the given period (defaults to the last 7 days).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

from string optionalvolitelnévoliteľnéválasztható

Start date (YYYY-MM-DD).
product_id integer optionalvolitelnévoliteľnéválasztható

Unique product ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
to string optionalvolitelnévoliteľnéválasztható

End date (YYYY-MM-DD).

OutputVýstupVýstupKimenet

pricing array | object

Pricing history.
content_hash string

Hash of the data.
scraper_heureka array | object

Heureka offers history.
source_heureka_conversion array | object

Heureka conversions history.

app_pricingfox_get_project Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns basic information about the project and its e-shop (name, currency, settings, filters, metrics).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

id string

Project ID.
name string

Project name.
type string
user object

Pricing Fox user.
user.id integer

User ID.
user.name string
user.email string
checks string

Project checks.
metrics array

Recent daily metrics.
metrics[].date string

Date of the metrics, format "Y-m-d".
metrics[].paired integer

Number of products paired with a comparison engine.
metrics[].priced integer

Number of priced products.
metrics[].current integer

Number of products.
metrics[].heureka_cr number

Heureka conversion rate.
metrics[].margin_avg number

Average margin (%).
metrics[].not_paired integer

Number of products not paired with a comparison engine.
metrics[].not_priced integer

Number of products that were not priced.
metrics[].updated_at string

Format "Y-m-d H:i:s".
metrics[].heureka_pno number

Heureka PNO (costs to sales ratio).
metrics[].new_price_avg number

Average resulting price.
metrics[].diff_price_avg number

Average price difference.
metrics[].overcharge_avg number

Average markup (%).
metrics[].heureka_costs_sum number

Heureka costs.
metrics[].heureka_sales_sum number

Heureka sales.
metrics[].has_purchase_price integer

Number of products with a purchase price.
metrics[].heureka_clicks_sum integer

Heureka clicks.
metrics[].heureka_orders_sum integer

Heureka orders.
metrics[].diff_direction_plus integer

Number of products whose price was increased.
metrics[].diff_direction_same integer

Number of products whose price did not change.
metrics[].diff_direction_minus integer

Number of products whose price was decreased.
shop_id integer

Shop ID.
currency string

Project currency.
analytics string

Google Analytics 4 data.
shop_name string
created_at string

Format "Y-m-d H:i:s".
panic_mode string

Panic mode state.
content_hash string

Hash of the data.
formatted_name string
mergado_queries string

Mergado queries (product selections).
mergado_elements string

Feed elements.
products_filters array

Product filters.
products_filters[].id integer

Product filter ID.
products_filters[].name string

Product filter name.
products_filters[].filters string

Filter conditions.
products_filters[].priority integer
products_filters[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
products_filters[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
products_filters[].latest_metrics.paired integer

Number of products paired with a comparison engine.
products_filters[].latest_metrics.priced integer

Number of priced products.
products_filters[].latest_metrics.current integer

Number of products.
products_filters[].latest_metrics.heureka_cr number

Heureka conversion rate.
products_filters[].latest_metrics.margin_avg number

Average margin (%).
products_filters[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
products_filters[].latest_metrics.not_priced integer

Number of products that were not priced.
products_filters[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
products_filters[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
products_filters[].latest_metrics.new_price_avg number

Average resulting price.
products_filters[].latest_metrics.diff_price_avg number

Average price difference.
products_filters[].latest_metrics.overcharge_avg number

Average markup (%).
products_filters[].latest_metrics.heureka_costs_sum number

Heureka costs.
products_filters[].latest_metrics.heureka_sales_sum number

Heureka sales.
products_filters[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
products_filters[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
products_filters[].latest_metrics.heureka_orders_sum integer

Heureka orders.
products_filters[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
products_filters[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
products_filters[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
products_filters[].products_count integer

Number of products matching the filter.
project_settings object

Project settings.
project_settings.connectors object

E-shop connectors.
project_settings.connectors.jzshop_api object

JZshop connector configuration and state.
project_settings.connectors.pohoda_xml object

Pohoda connector configuration and state.
project_settings.connectors.shoptet_xml object

Shoptet connector configuration and state.
project_settings.connectors.upgates_api object

UPgates connector configuration and state.
project_settings.connectors.exitshop_api object

ExitShop connector configuration and state.
project_settings.connectors.webareal_api object

Webareal connector configuration and state.
project_settings.connectors.universal_api object

Universal (CSV/XML) connector configuration and state.
project_settings.connectors.prestashop_api object

PrestaShop connector configuration and state.
project_settings.connectors.woocommerce_api object

WooCommerce connector configuration and state.
project_settings.created_at string

Format "Y-m-d H:i:s".
project_settings.updated_at string

Format "Y-m-d H:i:s".
project_settings.output_type string

Where resulting prices are written (e.g. none, mergado).
project_settings.vat_element string

Feed element with the VAT rate.
project_settings.item_id_element string

Feed element with the item ID.
project_settings.pricing_with_vat boolean

Whether prices are calculated including VAT.
project_settings.input_price_element string

Feed element with the input price.
project_settings.output_price_element string

Feed element with the resulting price.
project_settings.purchase_price_element string

Feed element with the purchase price.
project_settings.calculated_price_coefficient number
mergado_is_paused boolean
mergado_turned_off boolean
project_preferences string

Project preferences.
all_products_query_id integer

ID of the Mergado query with all products.

app_pricingfox_get_project_metrics Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the metrics of the project (product counts, performance, statistics). When rule_id or filter_id is passed, the metrics are returned for that rule or product filter instead.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

date_from string optionalvolitelnévoliteľnéválasztható

Start date of the report in the Y-m-d format (optional).
date_to string optionalvolitelnévoliteľnéválasztható

End date of the report in the Y-m-d format (optional).
filter_id integer optionalvolitelnévoliteľnéválasztható

ID of a product filter to get the metrics for (optional).
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_id integer optionalvolitelnévoliteľnéválasztható

ID of a specific rule to get the metrics for (optional).

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].date string

Date of the metrics, format "Y-m-d".
data[].paired integer

Number of products paired with a comparison engine.
data[].priced integer

Number of priced products.
data[].current integer

Number of products.
data[].heureka_cr number

Heureka conversion rate.
data[].margin_avg number

Average margin (%).
data[].not_paired integer

Number of products not paired with a comparison engine.
data[].not_priced integer

Number of products that were not priced.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].heureka_pno number

Heureka PNO (costs to sales ratio).
data[].new_price_avg number

Average resulting price.
data[].diff_price_avg number

Average price difference.
data[].overcharge_avg number

Average markup (%).
data[].heureka_costs_sum number

Heureka costs.
data[].heureka_sales_sum number

Heureka sales.
data[].has_purchase_price integer

Number of products with a purchase price.
data[].heureka_clicks_sum integer

Heureka clicks.
data[].heureka_orders_sum integer

Heureka orders.
data[].diff_direction_plus integer

Number of products whose price was increased.
data[].diff_direction_same integer

Number of products whose price did not change.
data[].diff_direction_minus integer

Number of products whose price was decreased.
meta object alwaysvždyvždymindig

Response metadata.
meta.date_to string

End of the period, format "Y-m-d".
meta.date_from string

Start of the period, format "Y-m-d".
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_get_project_settings Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the current pricing settings of the project (rounding, limits, data sources).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

connectors object

E-shop connectors.
connectors.jzshop_api object

JZshop connector configuration and state.
connectors.pohoda_xml object

Pohoda connector configuration and state.
connectors.shoptet_xml object

Shoptet connector configuration and state.
connectors.upgates_api object

UPgates connector configuration and state.
connectors.exitshop_api object

ExitShop connector configuration and state.
connectors.webareal_api object

Webareal connector configuration and state.
connectors.universal_api object

Universal (CSV/XML) connector configuration and state.
connectors.prestashop_api object

PrestaShop connector configuration and state.
connectors.woocommerce_api object

WooCommerce connector configuration and state.
created_at string

Format "Y-m-d H:i:s".
updated_at string

Format "Y-m-d H:i:s".
output_type string

Where resulting prices are written (e.g. none, mergado).
vat_element string

Feed element with the VAT rate.
content_hash string

Hash of the data.
item_id_element string

Feed element with the item ID.
pricing_with_vat boolean

Whether prices are calculated including VAT.
input_price_element string

Feed element with the input price.
output_price_element string

Feed element with the resulting price.
purchase_price_element string

Feed element with the purchase price.
calculated_price_coefficient number

app_pricingfox_get_project_settings_history Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the history of all changes of the project settings (who changed what and when).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].first boolean

Whether this is the initial state.
data[].changes string

Changed fields with their old and new values.
data[].updated_at string

Time of the change. Format "Y-m-d H:i:s".
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_get_report_data Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the data of a specific report type.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

payload object optionalvolitelnévoliteľnéválasztható

Request body with the report parameters.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
report_type enum optionalvolitelnévoliteľnéválasztható

Report type.

OutputVýstupVýstupKimenet

name string

Report name.
shop string

Shop.
config string

Report configuration.
last_sent string

Time the report was last sent. Format "Y-m-d H:i:s".
public_url string

Public URL of the report.
report_data string

Report data.
report_type enum

Report type.
content_hash string

Hash of the data.
generated_at string

Time of generation. Format "Y-m-d H:i:s".

app_pricingfox_get_report_flop_products Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the least performing (flop) products for the given report.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

payload object optionalvolitelnévoliteľnéválasztható

Request parameters with the product filter.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

filter string

Applied filter.
products array | object

Flop products.
content_hash string

Hash of the data.

app_pricingfox_get_report_top_products Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the best performing (top) products for the given report.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

payload object optionalvolitelnévoliteľnéválasztható

Request parameters with the product filter.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

filter string

Applied filter.
products array | object

Top products.
content_hash string

Hash of the data.

app_pricingfox_get_rule_history Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the change history of a specific pricing rule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_id integer optionalvolitelnévoliteľnéválasztható

Rule ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].first boolean

Whether this is the initial state.
data[].changes string

Changed fields with their old and new values.
data[].updated_at string

Time of the change. Format "Y-m-d H:i:s".
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_get_top_products Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of the best / worst performing products of the project.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

limit integer optionalvolitelnévoliteľnéválasztható

Number of products. Note: the underlying API does not support it, the value is ignored.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

rule_id integer

Rule the products were limited to.
best_margin array | object

Products with the best margin.
best_margin[].pricing string

Pricing result (resulting price, applied rule, ...).
best_margin[].mergado_id integer

Product ID (use as product_id in get_product).
best_margin[].is_favorite boolean

Whether the product is watched.
best_margin[].product_tags string

Product tags.
best_margin[].manual_pricing string

Manual price, if set.
best_margin[].source_heureka string

Heureka statistics of the product.
best_margin[].source_mergado string

Product data from the feed (name, price, ...).
best_margin[].scraper_heureka string

Heureka offers of the product.
best_margin[].top_competitors string

Top competitors of the product.
biggest_diff array | object

Products with the biggest price change.
biggest_diff[].pricing string

Pricing result (resulting price, applied rule, ...).
biggest_diff[].mergado_id integer

Product ID (use as product_id in get_product).
biggest_diff[].is_favorite boolean

Whether the product is watched.
biggest_diff[].product_tags string

Product tags.
biggest_diff[].manual_pricing string

Manual price, if set.
biggest_diff[].source_heureka string

Heureka statistics of the product.
biggest_diff[].source_mergado string

Product data from the feed (name, price, ...).
biggest_diff[].scraper_heureka string

Heureka offers of the product.
biggest_diff[].top_competitors string

Top competitors of the product.
content_hash string

Hash of the data.
worst_margin array | object

Products with the worst margin.
worst_margin[].pricing string

Pricing result (resulting price, applied rule, ...).
worst_margin[].mergado_id integer

Product ID (use as product_id in get_product).
worst_margin[].is_favorite boolean

Whether the product is watched.
worst_margin[].product_tags string

Product tags.
worst_margin[].manual_pricing string

Manual price, if set.
worst_margin[].source_heureka string

Heureka statistics of the product.
worst_margin[].source_mergado string

Product data from the feed (name, price, ...).
worst_margin[].scraper_heureka string

Heureka offers of the product.
worst_margin[].top_competitors string

Top competitors of the product.
zbozi_top_costs array | object

Products with the highest Zbozi.cz costs.
zbozi_top_costs[].pricing string

Pricing result (resulting price, applied rule, ...).
zbozi_top_costs[].mergado_id integer

Product ID (use as product_id in get_product).
zbozi_top_costs[].is_favorite boolean

Whether the product is watched.
zbozi_top_costs[].product_tags string

Product tags.
zbozi_top_costs[].manual_pricing string

Manual price, if set.
zbozi_top_costs[].source_heureka string

Heureka statistics of the product.
zbozi_top_costs[].source_mergado string

Product data from the feed (name, price, ...).
zbozi_top_costs[].scraper_heureka string

Heureka offers of the product.
zbozi_top_costs[].top_competitors string

Top competitors of the product.
zbozi_top_sales array | object

Products with the highest Zbozi.cz sales.
zbozi_top_sales[].pricing string

Pricing result (resulting price, applied rule, ...).
zbozi_top_sales[].mergado_id integer

Product ID (use as product_id in get_product).
zbozi_top_sales[].is_favorite boolean

Whether the product is watched.
zbozi_top_sales[].product_tags string

Product tags.
zbozi_top_sales[].manual_pricing string

Manual price, if set.
zbozi_top_sales[].source_heureka string

Heureka statistics of the product.
zbozi_top_sales[].source_mergado string

Product data from the feed (name, price, ...).
zbozi_top_sales[].scraper_heureka string

Heureka offers of the product.
zbozi_top_sales[].top_competitors string

Top competitors of the product.
heureka_top_costs array | object

Products with the highest Heureka costs.
heureka_top_costs[].pricing string

Pricing result (resulting price, applied rule, ...).
heureka_top_costs[].mergado_id integer

Product ID (use as product_id in get_product).
heureka_top_costs[].is_favorite boolean

Whether the product is watched.
heureka_top_costs[].product_tags string

Product tags.
heureka_top_costs[].manual_pricing string

Manual price, if set.
heureka_top_costs[].source_heureka string

Heureka statistics of the product.
heureka_top_costs[].source_mergado string

Product data from the feed (name, price, ...).
heureka_top_costs[].scraper_heureka string

Heureka offers of the product.
heureka_top_costs[].top_competitors string

Top competitors of the product.
heureka_top_sales array | object

Products with the highest Heureka sales.
heureka_top_sales[].pricing string

Pricing result (resulting price, applied rule, ...).
heureka_top_sales[].mergado_id integer

Product ID (use as product_id in get_product).
heureka_top_sales[].is_favorite boolean

Whether the product is watched.
heureka_top_sales[].product_tags string

Product tags.
heureka_top_sales[].manual_pricing string

Manual price, if set.
heureka_top_sales[].source_heureka string

Heureka statistics of the product.
heureka_top_sales[].source_mergado string

Product data from the feed (name, price, ...).
heureka_top_sales[].scraper_heureka string

Heureka offers of the product.
heureka_top_sales[].top_competitors string

Top competitors of the product.

app_pricingfox_list_competitors Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of the e-shop competitors. The watched competitors are listed in the response meta.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

total_hits string

Total number of competitors.
competitors array

Competitors.
competitors[].url string
competitors[].slug string

Competitor identifier (used by watch_competitor / get_competitor).
competitors[].rating integer
competitors[].watching boolean

Whether the competitor is watched.
competitors[].avg_price number
competitors[].shop_name string

Competitor shop name.
competitors[].better_price integer

Number of products where the competitor has a better price.
competitors[].my_avg_price number
competitors[].review_count integer
competitors[].top_producers string

Top producers of the competitor.
competitors[].products_count integer

Number of shared products.
competitors[].top_categories string

Top categories of the competitor.
competitors[].avg_price_positions number
competitors[].my_avg_price_positions number
content_hash string

Hash of the data.
top_producers string

Top producers.
top_categories string

Top categories.

app_pricingfox_list_connectors Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of all available data connectors (data sources) and their state in the project.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

jzshop_api object

JZshop connector configuration and state.
pohoda_xml object

Pohoda connector configuration and state.
shoptet_xml object

Shoptet connector configuration and state.
upgates_api object

UPgates connector configuration and state.
content_hash string

Hash of the data.
exitshop_api object

ExitShop connector configuration and state.
webareal_api object

Webareal connector configuration and state.
universal_api object

Universal (CSV/XML) connector configuration and state.
prestashop_api object

PrestaShop connector configuration and state.
woocommerce_api object

WooCommerce connector configuration and state.

app_pricingfox_list_exports Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of all data exports of the project. Pricing Fox export = repriced data to an economic system or shop platform. Not the Mergado output feed (core get_export_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Export ID.
data[].name string

Export name.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].engine string
data[].locale string
data[].status string

Export status (e.g. created, queued, generating, done, failed).
data[].exporter string

Export format and settings.
data[].periodic boolean

Whether the export is regenerated periodically.
data[].schedule string

Export schedule.
data[].created_at string

Format "Y-m-d H:i:s".
data[].public_url string

Public URL of the generated file.
data[].data_source string

Exported data source.
data[].finished_at string

Format "Y-m-d H:i:s".
data[].items_total integer
data[].download_url string

Download URL of the generated file.
data[].items_written integer
data[].items_completed integer
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_list_imports Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of all data imports of the project. Pricing Fox import = a competitor-data connector. Not the Mergado input feed (core get_import_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Import ID.
data[].name string

Import name.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].active boolean

Whether the import is running periodically.
data[].engine string
data[].status string

Import status.
data[].retries integer
data[].warning boolean

True when an active import has not finished in the last 24 hours.
data[].schedule string

Import schedule.
data[].created_at string

Format "Y-m-d H:i:s".
data[].updated_at string

Format "Y-m-d H:i:s".
data[].finished_at string

Format "Y-m-d H:i:s".
data[].import_type string
data[].items_total integer

Total number of items.
data[].items_written integer

Number of imported items.
data[].import_settings string

Import settings.
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_list_keychains Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of all stored API keys and connections of the project.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Keychain ID.
data[].name enum

Keychain type.
data[].config string

Keychain configuration.
data[].enable boolean

Whether the keychain is enabled.
data[].created_at string

Format "Y-m-d H:i:s".
data[].project_id integer
data[].updated_at string

Format "Y-m-d H:i:s".
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_list_product_filters Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of all saved product filters of the project. The app's own saved filters — a different object from a Mergado query (core list_project_queries), with different ids.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Product filter ID.
data[].name string

Product filter name.
data[].filters string

Filter conditions.
data[].priority integer
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].products_count integer

Number of products matching the filter.
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_list_products Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of products with optional advanced filtering and sorting (e.g. by price or name).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

f object optionalvolitelnévoliteľnéválasztható

Additional filter parameters (often used for fulltext search).
filter object optionalvolitelnévoliteľnéválasztható

Filters (e.g. {"report_products_groups": "best_sellers", "tag_ids": "10|12"}).
order object optionalvolitelnévoliteľnéválasztható

Sorting (e.g. {"column": "price", "direction": "desc"}).
page integer optionalvolitelnévoliteľnéválasztható

Page number.
per_page integer optionalvolitelnévoliteľnéválasztható

Number of products per page.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].pricing string

Pricing result (resulting price, applied rule, ...).
data[].mergado_id integer

Product ID (use as product_id in get_product).
data[].is_favorite boolean

Whether the product is watched.
data[].product_tags string

Product tags.
data[].manual_pricing string

Manual price, if set.
data[].source_heureka string

Heureka statistics of the product.
data[].source_mergado string

Product data from the feed (name, price, ...).
data[].scraper_heureka string

Heureka offers of the product.
data[].top_competitors string

Top competitors of the product.
meta object alwaysvždyvždymindig

Response metadata.
meta.stats string

Aggregated statistics.
meta.filter string

Applied filter.
meta.metrics string

Aggregated metrics.
meta.paginator string

Pagination info.
meta.total_items string

Total number of products matching the filter.
meta.content_hash string

Hash of the data.
meta.top_competitors string

Top Heureka competitors of the listed products.
meta.top_competitors_zbozi string

Top Zbozi.cz competitors of the listed products.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_list_rules Pricing Fox Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the list of all pricing rules of the project. PAID, per project. Only when the price must react to COMPETITOR prices from Heureka/Zbozi.cz; plain arithmetic is the free create_calc_rule. Pricing rules are first-match-wins.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_pause_import Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Pauses the given data import and returns the updated list of imports. Pricing Fox import = a competitor-data connector. Not the Mergado input feed (core get_import_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

import_id integer optionalvolitelnévoliteľnéválasztható

Import ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Import ID.
data[].name string

Import name.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].active boolean

Whether the import is running periodically.
data[].engine string
data[].status string

Import status.
data[].retries integer
data[].warning boolean

True when an active import has not finished in the last 24 hours.
data[].schedule string

Import schedule.
data[].created_at string

Format "Y-m-d H:i:s".
data[].updated_at string

Format "Y-m-d H:i:s".
data[].finished_at string

Format "Y-m-d H:i:s".
data[].import_type string
data[].items_total integer

Total number of items.
data[].items_written integer

Number of imported items.
data[].import_settings string

Import settings.
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_pause_rules Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Pauses one or more pricing rules.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_ids array optionalvolitelnévoliteľnéválasztható

Array of IDs of the rules to pause.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_regenerate_export Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Triggers regeneration of the export and returns the updated list of exports. Pricing Fox export = repriced data to an economic system or shop platform. Not the Mergado output feed (core get_export_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

export_id integer optionalvolitelnévoliteľnéválasztható

Export ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Export ID.
data[].name string

Export name.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].engine string
data[].locale string
data[].status string

Export status (e.g. created, queued, generating, done, failed).
data[].exporter string

Export format and settings.
data[].periodic boolean

Whether the export is regenerated periodically.
data[].schedule string

Export schedule.
data[].created_at string

Format "Y-m-d H:i:s".
data[].public_url string

Public URL of the generated file.
data[].data_source string

Exported data source.
data[].finished_at string

Format "Y-m-d H:i:s".
data[].items_total integer
data[].download_url string

Download URL of the generated file.
data[].items_written integer
data[].items_completed integer
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_reorder_rules Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Changes the order (priority) of the rules according to the order in the given list. FIRST-MATCH-WINS: the first matching rule reprices the product and it leaves the chain. Opposite of core reorder_rules, where every rule applies in sequence.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_ids array optionalvolitelnévoliteľnéválasztható

Array of rule IDs in the desired order (the first one has the highest priority).

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_start_import Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Starts the given data import and returns the updated list of imports. Pricing Fox import = a competitor-data connector. Not the Mergado input feed (core get_import_logs).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

import_id integer optionalvolitelnévoliteľnéválasztható

Import ID.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Import ID.
data[].name string

Import name.
data[].user object

Pricing Fox user.
data[].user.id integer

User ID.
data[].user.name string
data[].user.email string
data[].active boolean

Whether the import is running periodically.
data[].engine string
data[].status string

Import status.
data[].retries integer
data[].warning boolean

True when an active import has not finished in the last 24 hours.
data[].schedule string

Import schedule.
data[].created_at string

Format "Y-m-d H:i:s".
data[].updated_at string

Format "Y-m-d H:i:s".
data[].finished_at string

Format "Y-m-d H:i:s".
data[].import_type string
data[].items_total integer

Total number of items.
data[].items_written integer

Number of imported items.
data[].import_settings string

Import settings.
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_start_rules Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Starts (activates) one or more pricing rules.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string optionalvolitelnévoliteľnéválasztható

Project ID.
rule_ids array optionalvolitelnévoliteľnéválasztható

Array of IDs of the rules to start.

OutputVýstupVýstupKimenet

data array alwaysvždyvždymindig

Collection items.
data[].id integer

Rule ID.
data[].name string

Rule name.
data[].type enum

Direction of the price change.
data[].final boolean

Whether products priced by this rule are skipped by the following rules.
data[].active boolean

Whether the rule is running.
data[].budgets string

Rule budgets.
data[].filters array | object

Product filter IDs the rule applies to.
data[].is_test boolean

Test mode - prices are calculated but not applied.
data[].stop_at string

Scheduled stop. Format "Y-m-d H:i:s".
data[].apply_to enum

Which products the rule applies to.
data[].priority integer

Rule order; rules are evaluated by priority.
data[].start_at string

Scheduled start. Format "Y-m-d H:i:s".
data[].diff_type enum

Whether diff_value is relative (%) or absolute.
data[].is_margin boolean

Whether the rule works with margin.
data[].conditions string

Rule conditions (price sources and their settings).
data[].created_at string

Format "Y-m-d H:i:s".
data[].diff_value number

Price difference value.
data[].updated_at string

Format "Y-m-d H:i:s".
data[].cron_enable string

Cron expression enabling the rule.
data[].cron_disable string

Cron expression disabling the rule.
data[].next_stop_at string

Next scheduled stop.
data[].next_start_at string

Next scheduled start.
data[].latest_metrics object

Aggregated pricing metrics. Contains further counters not listed here.
data[].latest_metrics.date string

Date of the metrics, format "Y-m-d".
data[].latest_metrics.paired integer

Number of products paired with a comparison engine.
data[].latest_metrics.priced integer

Number of priced products.
data[].latest_metrics.current integer

Number of products.
data[].latest_metrics.heureka_cr number

Heureka conversion rate.
data[].latest_metrics.margin_avg number

Average margin (%).
data[].latest_metrics.not_paired integer

Number of products not paired with a comparison engine.
data[].latest_metrics.not_priced integer

Number of products that were not priced.
data[].latest_metrics.updated_at string

Format "Y-m-d H:i:s".
data[].latest_metrics.heureka_pno number

Heureka PNO (costs to sales ratio).
data[].latest_metrics.new_price_avg number

Average resulting price.
data[].latest_metrics.diff_price_avg number

Average price difference.
data[].latest_metrics.overcharge_avg number

Average markup (%).
data[].latest_metrics.heureka_costs_sum number

Heureka costs.
data[].latest_metrics.heureka_sales_sum number

Heureka sales.
data[].latest_metrics.has_purchase_price integer

Number of products with a purchase price.
data[].latest_metrics.heureka_clicks_sum integer

Heureka clicks.
data[].latest_metrics.heureka_orders_sum integer

Heureka orders.
data[].latest_metrics.diff_direction_plus integer

Number of products whose price was increased.
data[].latest_metrics.diff_direction_same integer

Number of products whose price did not change.
data[].latest_metrics.diff_direction_minus integer

Number of products whose price was decreased.
data[].skip_reference boolean
data[].mergado_queries array | object

Mergado query IDs the rule applies to.
data[].margin_limit_max number

Maximum margin (%).
data[].margin_limit_min number

Minimum margin (%).
data[].overcharge_limit_max number

Maximum markup (%).
data[].overcharge_limit_min number

Minimum markup (%).
data[].manual_limit_max_price number

Maximum resulting price.
data[].manual_limit_min_price number

Minimum resulting price.
data[].condition_join_operator string

Operator joining the conditions ("and" / "or").
meta object alwaysvždyvždymindig

Response metadata.
meta.content_hash string

Hash of the data.
type string alwaysvždyvždymindig

Internal response type name.

app_pricingfox_unwatch_competitor Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Stops watching a competitor (removes them from the watched competitors).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

competitor_slug string optionalvolitelnévoliteľnéválasztható

Competitor slug.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

competitors array | object

Slugs of all watched competitors.
content_hash string

Hash of the data.

app_pricingfox_watch_competitor Pricing Fox Writes dataZapisuje dataZapisuje dátaAdatot ír

Starts watching a competitor (adds them to the watched competitors).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

competitor_slug string optionalvolitelnévoliteľnéválasztható

Competitor slug.
project_id string optionalvolitelnévoliteľnéválasztható

Project ID.

OutputVýstupVýstupKimenet

competitors array | object

Slugs of all watched competitors.
content_hash string

Hash of the data.

apply_rules_to_traced_products Writes dataZapisuje dataZapisuje dátaAdatot ír

Runs the project's rules over its traced products only - the same task the regular "apply rules" action dispatches, restricted to the sample. Use to refresh what `preview_rule_changes` reports after editing rules or changing which products are traced. The run is dispatched to the background, so the returned apply log is a receipt (`status: in_progress`), not a result - poll `get_apply_log` with its `id` for the outcome. A project that is read-only because another process is already running for it answers with a conflict.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose rules to run over its traced products. Get from `list_shop_projects`.

OutputVýstupVýstupKimenet

id string

ID of the new apply log - pass to `get_apply_log`.
status string

Result of the run: `in_progress` (still running), `success` (finished, no errors nor warnings), `warning` (finished with warnings) or `failure` (finished with errors).
user_id string

ID of the user who started the run.
applied_to_all_items boolean

Whether the run covered all of the project's products. Null on this receipt - the API only fills it in once the run has finished, where `get_apply_log` reports it as false for a run scoped to the sample.
items integer

Number of products involved in the run.
duration number

How long the run took.
started_at string

When the run started (ISO 8601).
finished_at string

When the run ended (ISO 8601), null while it is in progress.
rules array of object

Rules involved in the run, with their progress counters.
rules[].rule_id string

ID of the rule involved in the run.
rules[].products integer

Products the rule is to process.
rules[].processed_products integer

Products the rule has processed so far.
errors array of object

Errors raised during the run, empty when there are none.
errors[].type string

Error type.
errors[].message string

Human-readable error message.
warnings array of object

Warnings raised during the run, empty when there are none.
warnings[].type string

Warning type.
warnings[].data string

JSON-encoded string with warning-specific details.
warnings[].product_ids array of integer

Products the warning concerns.

assign_query_to_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

query_id string requiredpovinnépovinnékötelező

ID of existing query to assign. Query must exist or 400 is returned.
rule_id string requiredpovinnépovinnékötelező

ID of the rule to assign query to

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

create_batch_copy_values_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_batch_delivery_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_batch_param_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_batch_rewriting_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_batch_rewriting_values_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_batch_set_datetime_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_bidding_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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. Free with every project. The word CPC does not imply the paid Bidding Fox; that one is needed only when the bid must react to live auction positions.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_calc_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

Create a 'Calculation' rule in a project: evaluates a mathematical expression and writes the result into `element_path`, optionally rounded and formatted. Supports + - * / and parentheses with standard operator precedence (* and / bind before + and -), so a flat expression like `1-%COST%/%PRICE%*100` evaluates as `1-((%COST%/%PRICE%)*100)` — parenthesise anything beyond a single operation. `%element%` references resolve to the product's current value at runtime; a value written with a space thousands separator and a decimal comma ("1 234,56") parses correctly. Use when the user wants a computed numeric value — margins, VAT, price adjustments, currency conversion. Rounding and number formatting are built into this rule (`rounding_type`, `decimal_places`, `decimal_separator`, `thousand_separator`), so no second rule is needed for that; use `create_rounding_rule` only to reformat an existing value with no arithmetic. A product whose expression cannot be evaluated — a non-numeric operand, or division by zero — is skipped and keeps its previous value; the rule itself does not fail. With `rounding_type` unset the raw result is written (e.g. `371.9008264463`), which most feed formats reject. The call returns the created rule only; computed values appear in the output after the next rebuild. Free with every project. The only pricing job it cannot do is reacting to competitor prices — that needs the paid Pricing Fox.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

Rule-type-specific configuration payload; the backend validates it authoritatively. `expression` (required) holds the formula. Optional: `rounding_type` — one of `mathematical`, `up`, `down`, `to0or05`, `ending09`, `ending099`; `decimal_places` — precision as a string ("2", "0", "-1"); `decimal_separator` and `thousand_separator` — output format only. Example: {"expression":"%PRICE_VAT% * 1.21","rounding_type":"mathematical"}
project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_casechanging_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_categories_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_create_product_value_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
data object optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_data_import_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates a Data Import rule: merges an external CSV or XML file onto the project's products, matching rows to products by a key. Source: `data_source_type: url` for a publicly reachable address, or `upload` with the file's text in `upload_control.uploaded_data`. Upload works — a write just does not echo the content back, so confirm it landed with `get_rule`. Matching: `matching_mode` (`exact`, `contains`, `xid`), with `match_by_input_values` to match the input rather than the output values, and `case_sensitive_matching` where case matters. Which elements the import may create: `element_import_policy` — `all`, `existing` (only paths the project already has), or `selected` together with `selected_elements`. `elements_to_skip` drops individual paths. CSV needs `file_type_specific_settings.delimiter`. XML needs paths there instead, in Mergado EP notation (`SHOP | SHOPITEM`) — never the XPath `parse_feed_elements` prints. `product_wrapper_element_path` is the full path to the element wrapping one product; `file_matching_element_path` is the key relative to it (`ITEM_ID`, not `SHOP | SHOPITEM | ITEM_ID`). A wrong notation is accepted and then silently matches nothing. Free with every project — the file is the user's own data. Competitor prices from Heureka/Zbozi.cz/Merchant Centrum need the paid Pricing Fox.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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. CSV: {"file_type":"csv","data_source_type":"url","source_url":"https://example.com/data.csv","file_type_specific_settings":{"delimiter":"semicolon"},"matching_mode":"exact","element_import_policy":"selected","selected_elements":["CUSTOM_LABEL"]} XML: {"file_type":"xml","data_source_type":"url","source_url":"https://example.com/feed.xml","file_type_specific_settings":{"product_wrapper_element_path":"SHOP | SHOPITEM","file_matching_element_path":"ITEM_ID","project_matching_element_path":"ITEM_ID"},"matching_mode":"exact","element_import_policy":"all"}
project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_datetime_formatting_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

Create a 'Datetime Formatting' rule in a project. Rewrite datetime values in the targeted element from one format to another. Both formats use strftime directives (e.g. `%Y-%m-%d`) or the special value `unixtime` for Unix timestamps in seconds. All conversions are performed in UTC. Pass the parameters as a `data` JSON object (an object, never a JSON-encoded string). Its shape, with `?` marking optional fields: `{format_from: string, format_to: string}`. At least one query is required in `queries` (objects `[{"id": "..."}]`) use the ♥ALLPRODUCTS♥ query to target every product. Pass `schedule` only when the user wants the rule limited in time (e.g. a weekend promotion): the rule then applies only at the listed hours of each weekday, within `date_from`-`date_until`. Leave `priority` and `placement` unset to append the rule at the end of the project's chain (still ahead of any hiding rule) - the position is resolved for you. Set `priority` or `placement` only to put the rule somewhere specific. The rule takes effect on the next rebuild - Mergado schedules that itself, so nothing further is needed after creating it.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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.
project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható
is_editable boolean optionalvolitelnévoliteľnéválasztható
is_movable boolean optionalvolitelnévoliteľnéválasztható
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

Explicit priority as a numeric string. Usually left unset so the server assigns a free slot required for some types (e.g. rewriting, tagstripping, truncating). Pass a high value like "100" to append at the end.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_element Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

Element name/tag (e.g. "CUSTOM_FIELD", "BRAND"). Must be valid XML tag name.
project_id string requiredpovinnépovinnékötelező

ID of the project where element will be created
is_hidden boolean optionalvolitelnévoliteľnéválasztható

Optional. True leaves the element out of the output feed (it still exists in the project and rules can still work with it).
output_cdata boolean optionalvolitelnévoliteľnéválasztható

Optional. True writes the element's value into the output feed wrapped in CDATA - for values holding HTML or characters that would otherwise need escaping.
parent_id string optionalvolitelnévoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the element
name string

Element tag name on its own
parent_id string

ID of the parent element, or null for a top-level one
is_attribute boolean

True if this is an XML attribute of its parent
is_hidden boolean

True if the element is left out of the output feed
is_hidden_set_manually boolean

True if a person hid (or unhid) the element, rather than the import
output_cdata boolean

True if the element's value is written into the output feed wrapped in CDATA
origin string

Where the element came from: 'input', 'from_rule' or 'manual'
order integer

Position among its siblings

create_feedaudit Writes dataZapisuje dataZapisuje dátaAdatot ír

Creates and triggers a new asynchronous feed audit for a project to validate feed data against advertising channel standards (e.g. Heureka, Google, Zboží) and detect errors or missing attributes. Requires project_id (from list_shop_projects) and feed_url (the source XML/CSV feed URL from get_project). Optionally specify feed_types to target specific channel formats. Returns the created audit object with its id and initial status. Audits run asynchronously in the background — proceed by polling get_feedaudit with the returned id until status reaches "done", then inspect detected issues via list_feedaudit_issues.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

feed_url string requiredpovinnépovinnékötelező

Source feed URL to audit. Required: the endpoint rejects a request without it (`400 Field 'feed_url' is not in required format`) despite the API docs implying otherwise. To audit the project's own feed, take the URL from `get_project`.
project_id string requiredpovinnépovinnékötelező

ID of the project to audit. Get it from `list_shop_projects`.
feed_types array optionalvolitelnévoliteľnéválasztható

Comparison-shopping formats to validate the feed against, e.g. ["heureka.cz", "zbozi.cz"]. Pass it. Omitted, Mergado guesses the formats from the feed's structure and does NOT consult the project's input format - measured on a `<SHOP>/<SHOPITEM>` heureka.cz feed in a heureka.cz project: the guess was `glami.ee`, so the audit validated against the GLAMI/Biano/Skrz family and reported 136 error-level findings for a missing DELIVERY_DATE, an element heureka.cz does not require. The same feed audited as `["heureka.cz"]` returned 1089 findings from heureka validators instead. Both audits are internally consistent, and only one of them answers the question the user asked, so take the formats from `get_project` (or from the user) rather than letting the guess decide which rulebook the feed is judged by.
parser_type string optionalvolitelnévoliteľnéválasztható

Input-feed parser type, e.g. "heureka.cz" - how the feed is READ, where `feed_types` is what it is judged against. Auto-detected when omitted, and the detection is a structural guess that carries the same risk: feed families sharing the `<SHOP>/<SHOPITEM>` shape are told apart by their elements, not by the project, so a heureka.cz feed was read as `glami.ee`. Set it alongside `feed_types` when you know the format. The value the audit actually used comes back on the audit's `parser_type` - worth checking against what you expected before reporting the findings.
webhook_url string optionalvolitelnévoliteľnéválasztható

URL pinged once the audit finishes. Optional.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Audit ID
project_id string

ID of the project whose feed was audited
status string

Audit status: `in_progress` while it runs, then `done` or `error`. This is the field to poll - the API sends no progress percentage.
errors integer

Number of `error`-level issues the audit recorded - the count of `list_feedaudit_issues` rows whose `level` is `error`, exactly. It does NOT count `warning` or `recommendation` rows, so it is a floor on what is wrong with the feed and not a total: an audit reporting `errors: 136` held 545 issues, and one reporting `errors: 0` may still hold hundreds of recommendations. Read the levels you care about off `list_feedaudit_issues` rather than inferring them from this number. A failure of the RUN itself (feed unreachable, unparseable) is counted here too, because it is filed as an error-level issue like any other - a 404 on the feed URL produced `status: error`, `error: "feed_download_error"` and `errors: 1`, that 1 being an issue with validator `http`. Use `status` and `error` to tell a failed run from a completed one; this field does not distinguish them. Null on `list_project_feedaudits`, which omits it - re-read the audit with `get_feedaudit` to get the count.
feed_url string

Audited source feed URL
feed_types array of string

Comparison-shopping formats the feed was validated against
parser_type string

Input-feed parser type used
product_count number

Number of products found in the feed
shop_name string

Shop name as read from the feed
webhook_url string

Webhook pinged on completion
error string

Error detail when the audit failed
started_at string

When the audit started, ISO 8601 in real UTC (`+00:00`, and the label is correct). The skew this field used to carry - two hours on the read paths, four on the create path, so the same audit reported two different start times - was fixed upstream and re-measured: `create_feedaudit` and `get_feedaudit` now agree with each other and with the wall clock. Ages and durations computed from it are sound again.
finished_at string

When the audit finished, ISO 8601 in real UTC, null while it is still running. Accurate now, like `started_at`. `time` remains the cheaper answer for how long the audit took, since it needs no arithmetic.
time number

Audit duration in seconds
slug string

Opaque per-audit token Mergado mints for its web-facing audit view. It is NOT an alternative id and this API offers no way to look an audit up by it - `/feedaudits/{slug}/`, `/feedaudits/slug/{slug}/` and `?slug=` all answer 404, so address every feed-audit tool by `id`. What it IS good for is the page a human reads: that is `result_url`, built from this slug - hand the user that, never the slug on its own.
result_url string

Public page showing this audit's results - the link to give the user when they want to see the findings themselves rather than have them summarised. Built from the audit's slug; null when the audit has none, or when this deployment has not been told where its audit pages live.
email string

Address Mergado notifies when the audit finishes
source string

How the audit was started - `api` for one this server created, other values for audits started from the Mergado web UI.
user_locale string

Locale of the user who started the audit, e.g. `sk_SK`. Describes the notification e-mail, not the audit: findings come back untranslated regardless.
agree_newsletter boolean

Marketing consent recorded with the audit, not an audit result
agree_marketing boolean

Marketing consent recorded with the audit, not an audit result
agree_analytics boolean

Analytics consent recorded with the audit, not an audit result

create_hiding_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
data object optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_params_remove_by_value_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_product_grouping_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
applies boolean optionalvolitelnévoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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`.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_project Writes dataZapisuje dataZapisuje dátaAdatot ír

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`. Give it `shop_id`, `name`, `url`, `input_format`, `output_format` and `pairing_elements`: only `pairing_elements` is enforced by the schema, but a project missing any of the others is not a working feed. Get `shop_id` from `list_user_eshops` and valid format ids from `list_supported_feed_formats`. Ask the user which channel the feed is for instead of guessing `output_format`, and which element identifies a product instead of guessing `pairing_elements` — the wrong one imports nothing at all. Projects go live and start syncing the moment they are created — there is no draft state to review first, so get the user's explicit consent before calling this. Afterwards call `get_project` to see whether it has synced rather than assuming it from this response.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

input_format string requiredpovinnépovinnékötelező

Format identifier of the source feed (e.g. "heureka.cz", "zbozi.cz", "google"). Native or custom. Call `list_supported_feed_formats` for the valid IDs and pick the one matching the feed at `url` - a Google Sheets link is "googlesheets.global", which reads the ordinary /edit link as it stands. Where the feed is not a recognisable channel feed, ask the user which format it follows rather than guessing: the wrong format imports nothing.
name string requiredpovinnépovinnékötelező

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").
output_format string requiredpovinnépovinnékötelező

Format the transformed feed is exported in (e.g. "heureka.cz", "billiger.de", "google"). Native or custom, discover valid IDs via `list_supported_feed_formats`. Ask the user which advertising channel this project is for if they have not said - it decides the shape of everything the project produces.
pairing_elements array requiredpovinnépovinnékötelező

Element that identifies a product across synchronisations, e.g. "ITEM_ID", "EAN" or "URL". Mergado matches every re-import on it, so a project created without one imports no products at all. Name an element that actually exists in the source feed: read the feed to find its identifier column, and if there is no obvious one - or more than one candidate - ask the user which to pair on rather than guessing. A list of element paths, e.g. `["ITEM_ID"]` or `["ITEM_ID", "EAN"]`.
shop_id string requiredpovinnépovinnékötelező

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épovinnékötelező

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"). Mergado also downloads it during creation, so it has to be reachable.
autohide_new_products boolean optionalvolitelnévoliteľnéválasztható

Optional. When true, products newly appearing after a synchronisation are automatically hidden until reviewed. Defaults to false.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the newly created project
name string alwaysvždyvždymindig

Project name as stored
slug string

URL-safe slug generated for the project
turned_off boolean

Whether the project starts turned off (new projects are off until configured)

create_project_query Writes dataZapisuje dataZapisuje dátaAdatot ír

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`). The query is re-evaluated on every project rebuild — write it as a condition over element values, not as a list of product IDs matching the condition today. Call workflow_element_paths_and_mql first for MQL limits and selection patterns.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

Descriptive name for the query (e.g. "Products under $10", "Items without images"). Helps identify query purpose.
project_id string requiredpovinnépovinnékötelező

ID of the project where this query will be created
query string requiredpovinnépovinnékötelező

Query expression using MQL (Mergado Query Language). Can filter, aggregate, or transform data (e.g. "PRICE < 10", "CATEGORY = Electronics").
read_only boolean optionalvolitelnévoliteľnéválasztható

Whether this query is read-only (cannot be modified)
search_output boolean optionalvolitelnévoliteľnéválasztható

True to query output data (after rules), False to query input data

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the query
project_id string alwaysvždyvždymindig

ID of the project this query belongs to
name string

Display name of the query
query string alwaysvždyvždymindig

Raw MQL query expression
advanced_interface boolean

True if query was created using advanced/raw MQL interface
read_only boolean

True if query cannot be modified (e.g. system queries like ♥ALLPRODUCTS♥)
search_output boolean

True to query output data (after rules), False to query input data
product_count integer

Number of products currently matching this query
created_at string alwaysvždyvždymindig

When the query was created (ISO 8601)

create_remove_diacritics_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
data object optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_replacing_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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). Free with every project. Covers swapping a domain inside IMGURL — that changes which picture the feed carries, not the picture itself, so no Feed Image Editor is involved.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_rewriting_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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). Free with every project. Covers pointing IMGURL at a different URL — that changes which picture the feed carries, not the picture itself, so no Feed Image Editor is involved.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_rounding_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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. Free with every project. Use it for reformatting alone — when the value is being computed, round inside create_calc_rule instead of adding a second rule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_shop Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

E-shop name. Max 100 characters. The value is trimmed and converted to title case by Mergado (e.g. "example.com").

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the newly created eshop
name string alwaysvždyvždymindig

Eshop name as stored (trimmed and title-cased)

create_tagstripping_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
data object optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_truncating_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

data object requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
element_path string optionalvolitelnévoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_utm_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project the rule is created in. Obtain it from `list_shop_projects`.
queries array requiredpovinnépovinnékötelező

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évoliteľnéválasztható

Whether the rule is active (vs. paused).
data object optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Target element path - it must already exist in the project. Take it verbatim from `element_path` in `list_project_elements`: a child element is written `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`, not as an XPath. The backend rejects a path the project does not have.
is_deletable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_editable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
is_movable boolean optionalvolitelnévoliteľnéválasztható

System flag controlling how the rule behaves in the Mergado editor. Leave unset — intended for system-generated rules only.
name string optionalvolitelnévoliteľnéválasztható

Human-readable rule name (max 100 chars).
note string optionalvolitelnévoliteľnéválasztható

Optional internal note - why the rule exists or what it is for. Not part of the output feed.
placement object optionalvolitelnévoliteľnéválasztható

Relative placement using `before`/`after` rule IDs takes precedence over `priority`.
priority string optionalvolitelnévoliteľnéválasztható

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.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. Limits when the rule is allowed to apply - by date range and by hours of each weekday. Omit it for a rule that applies whenever the feed is processed.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

create_variable Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

element_path string requiredpovinnépovinnékötelező

Element path from which the variable value is extracted (e.g. "ITEM | PRICE", "PARAM { NAME = 'color' } | VALUE")
name string requiredpovinnépovinnékötelező

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épovinnékötelező

ID of the project where this variable will be created and available for use
fragment_number integer optionalvolitelnévoliteľnéválasztható

Optional regex group/fragment number to extract (used with regular_expression)
regular_expression string optionalvolitelnévoliteľnéválasztható

Optional regex pattern to extract part of the element value
sample_text string optionalvolitelnévoliteľnéválasztható

Optional sample text for UI/testing purposes

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the variable
project_id string alwaysvždyvždymindig

ID of the project this variable belongs to
name string alwaysvždyvždymindig

Variable name used in rules (e.g. "price", "category")
element_path string alwaysvždyvždymindig

XPath to the element this variable extracts from
type string alwaysvždyvždymindig

Variable type
regular_expression string

Regex pattern to extract part of element value (e.g. domain from URL), null when the variable takes the element value whole
fragment_number integer

Capturing group number to extract from regex match (0 for entire match), null when no regex is set
sample_text string

Example text for testing the regex in UI
project_element_id string

ID of the project element the variable reads, when it is bound to one

delete_element Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Element ID to delete. Get from `list_project_elements`. Deletes all child elements too.

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

delete_query Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Query ID to delete. Get from `list_project_queries` or `list_rule_queries`. System queries (`read_only=true`) cannot be deleted.

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

delete_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

Deletes a rule permanently. The products it affected revert to their pre-rule values on the next rebuild; the queries it used stay in the project. 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. Not meant for switching a rule off temporarily - a paused rule (`update_rule`, `applies: false`) keeps its configuration, position and queries.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Rule ID to delete. Get from `list_project_rules`. Rules with `is_deletable=false` (system rules) cannot be deleted.

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

delete_variable Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Variable ID to delete. Get from `list_project_variables`.

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

duplicate_project Writes dataZapisuje dataZapisuje dátaAdatot ír

Copies an existing project into the same shop, or into another shop when `shop_id` is given. Use when the user wants a second feed built on the same rules - the same products exported to another channel, or a copy to experiment on without touching the original. Copied: the project settings and project info, its elements, variables, queries, and its whole rule chain with schedules. NOT copied: app rules, Heureka Watchdog pairing rules, and everything produced by a feed run (products, logs, the export URL). The copy is created immediately and answers with its `id`, but it holds no data yet: Mergado enables it and schedules its first feed download straight away, and the products appear when that import and the first rule apply have finished. So do not read products from it, or judge its rules by them, right after creating it. Its feed URL does not work yet either - and the copy reports the SOURCE project's `exported_items` until it has exported once, so that number is no evidence to the contrary. Two things this changes and cannot undo, so get the user's explicit consent first: it creates a live project that starts downloading the source feed, and (with `shop_id`) it can put it in a different shop. The name must be unique in the target shop, and the token must belong to a user - Mergado records who duplicated the project, so a service token is refused.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

Name of the new project. Max 100 characters and must not already exist in the target shop (Mergado answers 409 if it does). Ask the user what to call the copy rather than inventing a name - it is what they will see in the Mergado UI.
project_id string requiredpovinnépovinnékötelező

ID of the project to copy. Get it from `list_shop_projects`. Everything configured on it is copied - settings, project info, elements, variables, queries and rules with their schedules.
shop_id string optionalvolitelnévoliteľnéválasztható

Optional. ID of the shop to create the copy in, from `list_user_eshops`. Defaults to the source project's own shop. Copying into another shop additionally requires permission to manage that shop's projects.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the newly created project (the copy)
shop_id string

ID of the shop the copy was created in

get_access_log Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the access log to fetch. Get it from `get_access_logs`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the log
time string

When the feed was downloaded (ISO 8601)
ip string

IP address that downloaded it
https boolean

Whether it was fetched over HTTPS
request string

The HTTP request line
status integer

HTTP status answered
size integer

Bytes sent
referer string

Referer header, if any
user_agent string

User agent - usually tells which channel downloaded it
identity string

Identity of the client, if known
user string

Authenticated user, if any

get_access_logs Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project whose access logs to retrieve
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Downloads of the output feed, newest first
data[].id string alwaysvždyvždymindig

ID of the log
data[].time string

When the feed was downloaded (ISO 8601)
data[].ip string

IP address that downloaded it
data[].https boolean

Whether it was fetched over HTTPS
data[].request string

The HTTP request line
data[].status integer

HTTP status answered
data[].size integer

Bytes sent
data[].referer string

Referer header, if any
data[].user_agent string

User agent - usually tells which channel downloaded it
data[].identity string

Identity of the client, if known
data[].user string

Authenticated user, if any

get_app_by_name Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

name string requiredpovinnépovinnékötelező

Name (ID) of the application

OutputVýstupVýstupKimenet

title string

Application title
type string

Application type: user, eshop, or project
creation_date string

When application was created (ISO 8601)
trial_period integer

Trial period in days
forum_url string

Forum page URL
latest_release_date string

Latest release date (ISO 8601)

get_apply_log Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the apply log to fetch. Get it from `get_apply_logs`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the log
user_id string

Who started the run, or null for a scheduled one
status string

`in_progress`, `success`, `warning` (finished with warnings) or `failure` (finished with errors)
started_at string

When the run started (ISO 8601)
finished_at string

When the run finished (ISO 8601), null while running
duration number

How long the run took, in seconds
items integer

Number of products the run involved
errors array of object

Errors the run hit
errors[].type string

Kind of problem, e.g. `HTTPError`
errors[].message string

What went wrong, in words
warnings array of object

Warnings the run recorded
warnings[].type string

Kind of problem, e.g. `HTTPError`
warnings[].message string

What went wrong, in words
applied_to_all_items boolean

Whether the run covered every product (false for a run over a sample)
finished_clearing boolean

Whether clearing the previous results finished
rules array of object

Per-rule results, in apply order
rules[].rule_id string

ID of the rule
rules[].products integer

Products the rule changed
rules[].processed_products integer

Products the rule was evaluated on
rules[].duration number

How long the rule took, in seconds

get_apply_logs Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project whose apply logs to retrieve
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Apply runs, newest first
data[].id string alwaysvždyvždymindig

ID of the log
data[].user_id string

Who started the run, or null for a scheduled one
data[].status string

`in_progress`, `success`, `warning` (finished with warnings) or `failure` (finished with errors)
data[].started_at string

When the run started (ISO 8601)
data[].finished_at string

When the run finished (ISO 8601), null while running
data[].duration number

How long the run took, in seconds
data[].items integer

Number of products the run involved
data[].errors array of object

Errors the run hit
data[].errors[].type string

Kind of problem, e.g. `HTTPError`
data[].errors[].message string

What went wrong, in words
data[].warnings array of object

Warnings the run recorded
data[].warnings[].type string

Kind of problem, e.g. `HTTPError`
data[].warnings[].message string

What went wrong, in words
data[].applied_to_all_items boolean

Whether the run covered every product (false for a run over a sample)
data[].finished_clearing boolean

Whether clearing the previous results finished
data[].rules array of object

Per-rule results, in apply order
data[].rules[].rule_id string

ID of the rule
data[].rules[].products integer

Products the rule changed
data[].rules[].processed_products integer

Products the rule was evaluated on
data[].rules[].duration number

How long the rule took, in seconds

get_current_user Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

User ID
first_name string

User first name
last_name string

User last name
name string

User full name
username string

User login name
email string

User email address
city string

User city
company string

User company name
country string

Country code (ISO 3166-1)
postcode string

User postal code
street string

User street address
timezone string

User timezone
timezone_offset string

Timezone offset
dic string

VAT identification number
ico string

Taxpayer identification number
fakturoid_id string

Fakturoid.cz ID
invoice_months integer

Number of months to be invoiced
last_access string

Last access datetime (ISO 8601)
locale string

User locale (ISO 15897)
registered_at string

Registration datetime (ISO 8601)
send_summary boolean

Whether user wants to receive summaries
mfa_enabled boolean

Whether the user has multi-factor authentication turned on, or null when it could not be determined

get_element Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Element ID to fetch. Get from `list_project_elements`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the element
name string

Element tag name on its own
parent_id string

ID of the parent element, or null for a top-level one
is_attribute boolean

True if this is an XML attribute of its parent
is_hidden boolean

True if the element is left out of the output feed
is_hidden_set_manually boolean

True if a person hid (or unhid) the element, rather than the import
output_cdata boolean

True if the element's value is written into the output feed wrapped in CDATA
origin string

Where the element came from: 'input', 'from_rule' or 'manual'
order integer

Position among its siblings

get_export_log Read-onlyPouze čteníIba čítanieCsak olvasás

Returns details of a single output-feed export run. Use after `get_export_logs` to inspect a specific export.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the export log to fetch. Get it from `get_export_logs`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the log
user_id string

Who started the run, or null for a scheduled one
status string

`in_progress`, `success`, `warning` (finished with warnings) or `failure` (finished with errors)
started_at string

When the run started (ISO 8601)
finished_at string

When the run finished (ISO 8601), null while running
duration number

How long the run took, in seconds
items integer

Number of products the run involved
errors array of object

Errors the run hit
errors[].type string

Kind of problem, e.g. `HTTPError`
errors[].message string

What went wrong, in words
warnings array of object

Warnings the run recorded
warnings[].type string

Kind of problem, e.g. `HTTPError`
warnings[].message string

What went wrong, in words
initial boolean

Whether this was the first export
processed_items integer

Products written to the feed
exported_product_group_count integer

Product groups written to the feed

get_export_logs Read-onlyPouze čteníIba čítanieCsak olvasás

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. "Export" means something else in the extensions — repriced data sent onward in Pricing Fox, a CSV/XLSX report in Bidding Fox. Neither shows up here.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project whose export logs to retrieve
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Export runs, newest first
data[].id string alwaysvždyvždymindig

ID of the log
data[].user_id string

Who started the run, or null for a scheduled one
data[].status string

`in_progress`, `success`, `warning` (finished with warnings) or `failure` (finished with errors)
data[].started_at string

When the run started (ISO 8601)
data[].finished_at string

When the run finished (ISO 8601), null while running
data[].duration number

How long the run took, in seconds
data[].items integer

Number of products the run involved
data[].errors array of object

Errors the run hit
data[].errors[].type string

Kind of problem, e.g. `HTTPError`
data[].errors[].message string

What went wrong, in words
data[].warnings array of object

Warnings the run recorded
data[].warnings[].type string

Kind of problem, e.g. `HTTPError`
data[].warnings[].message string

What went wrong, in words
data[].initial boolean

Whether this was the first export
data[].processed_items integer

Products written to the feed
data[].exported_product_group_count integer

Product groups written to the feed

get_feedaudit Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the current status, progress, timing, and summary metadata of a single feed audit. Use to poll a running audit until completion or to check if an audit finished with errors before querying its issues. Requires id (the audit ID from create_feedaudit or list_project_feedaudits). Returns the audit record including status, progress, product counts, and failure reasons if any. Once status is "done", proceed to list_feedaudit_issues for concrete diagnostic findings.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the feed audit. Get from `list_project_feedaudits`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Audit ID
project_id string

ID of the project whose feed was audited
status string

Audit status: `in_progress` while it runs, then `done` or `error`. This is the field to poll - the API sends no progress percentage.
errors integer

Number of `error`-level issues the audit recorded - the count of `list_feedaudit_issues` rows whose `level` is `error`, exactly. It does NOT count `warning` or `recommendation` rows, so it is a floor on what is wrong with the feed and not a total: an audit reporting `errors: 136` held 545 issues, and one reporting `errors: 0` may still hold hundreds of recommendations. Read the levels you care about off `list_feedaudit_issues` rather than inferring them from this number. A failure of the RUN itself (feed unreachable, unparseable) is counted here too, because it is filed as an error-level issue like any other - a 404 on the feed URL produced `status: error`, `error: "feed_download_error"` and `errors: 1`, that 1 being an issue with validator `http`. Use `status` and `error` to tell a failed run from a completed one; this field does not distinguish them. Null on `list_project_feedaudits`, which omits it - re-read the audit with `get_feedaudit` to get the count.
feed_url string

Audited source feed URL
feed_types array of string

Comparison-shopping formats the feed was validated against
parser_type string

Input-feed parser type used
product_count number

Number of products found in the feed
shop_name string

Shop name as read from the feed
webhook_url string

Webhook pinged on completion
error string

Error detail when the audit failed
started_at string

When the audit started, ISO 8601 in real UTC (`+00:00`, and the label is correct). The skew this field used to carry - two hours on the read paths, four on the create path, so the same audit reported two different start times - was fixed upstream and re-measured: `create_feedaudit` and `get_feedaudit` now agree with each other and with the wall clock. Ages and durations computed from it are sound again.
finished_at string

When the audit finished, ISO 8601 in real UTC, null while it is still running. Accurate now, like `started_at`. `time` remains the cheaper answer for how long the audit took, since it needs no arithmetic.
time number

Audit duration in seconds
slug string

Opaque per-audit token Mergado mints for its web-facing audit view. It is NOT an alternative id and this API offers no way to look an audit up by it - `/feedaudits/{slug}/`, `/feedaudits/slug/{slug}/` and `?slug=` all answer 404, so address every feed-audit tool by `id`. What it IS good for is the page a human reads: that is `result_url`, built from this slug - hand the user that, never the slug on its own.
result_url string

Public page showing this audit's results - the link to give the user when they want to see the findings themselves rather than have them summarised. Built from the audit's slug; null when the audit has none, or when this deployment has not been told where its audit pages live.
email string

Address Mergado notifies when the audit finishes
source string

How the audit was started - `api` for one this server created, other values for audits started from the Mergado web UI.
user_locale string

Locale of the user who started the audit, e.g. `sk_SK`. Describes the notification e-mail, not the audit: findings come back untranslated regardless.
agree_newsletter boolean

Marketing consent recorded with the audit, not an audit result
agree_marketing boolean

Marketing consent recorded with the audit, not an audit result
agree_analytics boolean

Analytics consent recorded with the audit, not an audit result

get_feedaudit_issue Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the audit issue. Get from `list_feedaudit_issues`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Issue ID
audit_id string

ID of the audit this issue belongs to
product_id string

ID of the audited product this issue is about. Resolve it with `get_feedaudit_product` to get the ITEM_ID, PRODUCTNAME and URL that name the product to a user. Null for a finding that belongs to the feed rather than to one product - a value duplicated across products, or a download/content-type failure - which is a small minority of rows (1 of 545 on one audit) and worth reporting separately rather than discarding.
validator string

Validator that raised the issue, e.g. `is_present_product`
verdict string

What the validator concluded - the finding itself, where `validator` is only which check produced it. Observed values include `missing`, `wrong_format`, `contains_html`, `single_category`, `duplicate` and `unknown_compression`, plus `error` for a failure of the run. The set is open, so render it rather than matching on it.
level string

Severity: `error`, `warning` or `recommendation`. This is the field that decides what to tell the user - only `error` rows are counted by the audit's `errors`, and `recommendation` rows are usually the bulk of a listing (408 of 545 on one audit), so a raw issue count badly overstates how much is wrong.
checked_at string

When the validation ran
feed_types array of string

The comparison-shopping formats this validation applies to - not the formats the audit ran against. It repeats the same long list on nearly every row and is the main reason an untrimmed listing is large, so leave it out of `fields` unless you need it.
info object

Validator-specific context, and where a finding becomes actionable: it names the offending element (`{"element": "DELIVERY_DATE"}`), or for a duplicate the shared `value` and the `products` sharing it. Keep it in `fields` when you intend to explain the findings rather than count them.

get_feedaudit_product Read-onlyPouze čteníIba čítanieCsak olvasás

Returns a single audited product with all its parsed feed element tags and original values as recorded at audit time. Use when troubleshooting a specific product that failed validation to inspect its raw input data. Requires id (the audited product ID from list_feedaudit_products or list_feedaudit_issues). Returns the full product data object containing all XML/feed element tag-value pairs.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the audited product. Get from `list_feedaudit_products`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Audited product ID
audit_id string

ID of the audit this product belongs to
elements array of object

The product's elements as the audit parsed them out of the feed (tag/value pairs, PARAM nested one level deeper). This is where a product gets its identity: ITEM_ID, PRODUCTNAME, URL, EAN and the rest are all here, so an issue can be reported against a product the user recognises - take the issue's `product_id`, read that product, and quote its ITEM_ID.It was documented here as "in practice always null", which was true of the API at the time and is not any more: re-measured, every product of every audit carried its full element list (136 of 136, in the listing and the detail alike). The old note told the agent to refuse "what is wrong with product X" as unanswerable. It is answerable - answer it.Null only when you asked for it: a `fields` list that leaves `elements` out reads back as null here, which is this server filling in the model rather than the audit having nothing.
elements[].tag string

Element tag, e.g. `PRODUCT`, `PRICE_VAT`
elements[].value string | number | integer

Element value
elements[].elements array of string

Nested child elements - a PARAM carries its PARAM_NAME and VAL here, and its own `value` is the empty string. An empty list for a leaf element (the API sends `[]`, not null, though null is tolerated).

get_format Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

format_id string requiredpovinnépovinnékötelező

Format ID (e.g. 'heureka.cz', 'zbozi.cz')

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Format ID
country string alwaysvždyvždymindig

Country code (e.g. 'cz', 'sk')
name string alwaysvždyvždymindig

Format name
ga_sources array of string

Google Analytics source identifiers
is_importable boolean alwaysvždyvždymindig

Whether format can be imported
is_exportable boolean alwaysvždyvždymindig

Whether format can be exported

get_format_specification Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

format_id string requiredpovinnépovinnékötelező

Format ID (e.g. 'heureka.cz', 'zbozi.cz')

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Format specification ID (e.g. 'xml.Heureka')
file_format string alwaysvždyvždymindig

File format type (e.g. 'xml')
global_schema object

Global schema definition
item_schema object

Item-level schema definition

get_import_log Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the import log to fetch. Get it from `get_import_logs`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the log
user_id string

Who started the run, or null for a scheduled one
status string

`in_progress`, `success`, `warning` (finished with warnings) or `failure` (finished with errors)
started_at string

When the run started (ISO 8601)
finished_at string

When the run finished (ISO 8601), null while running
duration number

How long the run took, in seconds
items integer

Number of products the run involved
errors array of object

Errors the run hit
errors[].type string

Kind of problem, e.g. `HTTPError`
errors[].message string

What went wrong, in words
warnings array of object

Warnings the run recorded
warnings[].type string

Kind of problem, e.g. `HTTPError`
warnings[].message string

What went wrong, in words
items_created integer

Products new in this import
items_updated integer

Products whose data changed
items_removed integer

Products no longer in the feed
items_processed integer

Products read from the feed

get_import_logs Read-onlyPouze čteníIba čítanieCsak olvasás

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. "Import" means something else in Pricing Fox, where it is a competitor-data connector rather than the shop feed. That one does not show up here.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project whose import logs to retrieve
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Import runs, newest first
data[].id string alwaysvždyvždymindig

ID of the log
data[].user_id string

Who started the run, or null for a scheduled one
data[].status string

`in_progress`, `success`, `warning` (finished with warnings) or `failure` (finished with errors)
data[].started_at string

When the run started (ISO 8601)
data[].finished_at string

When the run finished (ISO 8601), null while running
data[].duration number

How long the run took, in seconds
data[].items integer

Number of products the run involved
data[].errors array of object

Errors the run hit
data[].errors[].type string

Kind of problem, e.g. `HTTPError`
data[].errors[].message string

What went wrong, in words
data[].warnings array of object

Warnings the run recorded
data[].warnings[].type string

Kind of problem, e.g. `HTTPError`
data[].warnings[].message string

What went wrong, in words
data[].items_created integer

Products new in this import
data[].items_updated integer

Products whose data changed
data[].items_removed integer

Products no longer in the feed
data[].items_processed integer

Products read from the feed

get_notification Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Notification ID to retrieve. Get it from `get_user_notifications`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Notification ID
event string alwaysvždyvždymindig

Event type (e.g., app_notify)
created_at string alwaysvždyvždymindig

Creation timestamp (ISO 8601)
statuses array of object

One entry per channel this notification was delivered through, each with its own read state
statuses[].status_id string

ID of this delivery record
statuses[].channel string

Channel it was delivered through ('frontend', 'email')
statuses[].user_id integer

ID of the recipient
statuses[].resolved_at string

ISO 8601 datetime the recipient acknowledged it, null while unread
priority string alwaysvždyvždymindig

Priority (low/medium/high)
scope string alwaysvždyvždymindig

Scope (eshop/owner/user)
data object

Event payload - the keys and value types depend on `event` (e.g. project_name, shop_url, billing_info_ok)

get_pairing Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the pairing to fetch. Get it from `list_pairings`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Pairing ID (stable identifier, corresponds to product ID). Pass it straight to `get_pairing`.
project_id string

ID of the project
created_at string

ISO 8601 datetime when product first appeared in feed (null for products before Jan 11, 2017)
deleted_at string

ISO 8601 datetime when product last appeared in feed (null if still present)

get_product Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Product ID to retrieve. Get it from `list_project_products` or `query_products`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Product ID corresponding to pairing ID (stable identifier across feed updates)
output_changed_at string

ISO 8601 datetime when output data (after rules) last changed
updated_at string

ISO 8601 datetime when input data from feed last changed
project_id string

ID of the project the product is in
data object

Output product data (after applying all rules), as `{elements: {NAME: [{value, ...}]}, attributes: {...}}`. Empty when `values_to_extract` was used without `include_data` - read `extracted_values` then
extracted_values object

Values extracted from the requested element paths or variables, as path -> list of values (only present if `values_to_extract` was used)
is_hidden boolean

True if the product is left out of the output feed - because a hiding rule matches it, because it was hidden manually, or both
is_hidden_by_rule boolean

True if any hiding rule of the project matches the product
is_hidden_manually boolean

True if this product itself was hidden by hand (in the Mergado UI or the API)
manual_changes array of object

Element values set by hand for this one product, on top of what the rules compute
manual_changes[].element_path string alwaysvždyvždymindig

Element path the manual value belongs to, in the escaped and position-qualified form Mergado stores it in (which of the element's values it sets)
manual_changes[].value string alwaysvždyvždymindig

The value the element is forced to
manual_changes[].is_applied boolean

True once the value is in the output feed; false while it waits for the next regeneration of the project

get_project Read-onlyPouze čteníIba čítanieCsak olvasás

Returns one project's full record: feed URL, input/output formats, status, timestamps, and `all_products_query_id` — the query targeting every product, which rules need. Do not go to `list_shop_projects` for any of it.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID to fetch. Get from `list_shop_projects`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the project (export)
shop_id string alwaysvždyvždymindig

ID of the eshop this project belongs to
creator_id string

ID of the user who created this project
name string alwaysvždyvždymindig

Display name of the project
url string alwaysvždyvždymindig

URL of the source XML feed with products
created string

ISO 8601 datetime when the project was created
exported_items integer

Number of products exported in the last successful export
input_format string

Input format identifier (e.g. heureka.cz, zbozi.cz, google)
output_format string

Output format identifier for the transformed feed
pairing_elements array of string

Element paths used for product pairing/identification during feed synchronization
readonly boolean

True if project is being regenerated and modifications are locked. Product data may not be consistent during this state.
is_paused boolean

True if automatic scheduled rebuilds are temporarily disabled
rules_changed_at string

ISO 8601 datetime of the last rule creation, deletion, or update
slug string alwaysvždyvždymindig

Unique URL-safe identifier used in the output feed URL path
turned_off boolean

True if the project is completely disabled (no processing occurs)
update_period integer

Automatic update interval in seconds (e.g. 3600 for hourly, 86400 for daily)
last_access string

ISO 8601 datetime of last user access to this project
data_synced_at string

ISO 8601 datetime when the input feed was last successfully imported
data_updated_at string

ISO 8601 datetime when the project data was last modified by source feed changes
in_testing_mode boolean

True if project is in testing mode (export generation is disabled)
autohide_new_products boolean

True if newly imported products are hidden until somebody authorizes them
encoding string

Encoding the input feed is read with, or null when the import detects it from the feed (the usual case)
all_products_query_id string

ID of the ♥ALLPRODUCTS♥ query matching every product - the query to pass when a rule should apply to all products
number_of_elements integer

Number of elements defined in the project
metadata object

Additional project metadata (e.g. `stats_ga_source`)
sync_schedule object

When the project downloads its source feed
sync_schedule.minute string

Cron minute field, e.g. "50"
sync_schedule.hour string

Cron hour field, e.g. "*/1" for hourly
sync_schedule.day_of_week string

Cron day-of-week field
sync_schedule.day_of_month string

Cron day-of-month field
sync_schedule.month_of_year string

Cron month field

get_project_app Read-onlyPouze čteníIba čítanieCsak olvasás

Fetches subscription details (free_until, paid_until) for a project-level app. Use after `list_project_apps` to inspect a specific subscription.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

app_name string requiredpovinnépovinnékötelező

Name (ID) of the application
project_id string requiredpovinnépovinnékötelező

ID of the project

OutputVýstupVýstupKimenet

app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
free_until string

Trial expiration date (ISO 8601)
paid_until string

Paid subscription expiration date (ISO 8601)

get_project_feed_url Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the public URL of a project's output feed - the XML address to give an advertising channel (Google Merchant Center, Heureka, Zbozi, GLAMI, ...) or to open to inspect the exported data. Use whenever the user asks where their feed is, what link to submit to a channel, or for the export/output URL of a project. Mergado does not send the URL as a field: it is composed from the project's `slug`, which is what this tool reads. The answer is deliberately just the URL and the project it belongs to, plus `exported_items` - zero there means the project has never exported, which is one of the two reasons a correctly built URL still answers 404. The other is a project that is turned off; `get_project` reports that. This reads the project only; it changes nothing and triggers no export.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose output feed URL to build. Get from `list_shop_projects`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

ID of the project the feed belongs to
name string

Display name of the project
feed_url string alwaysvždyvždymindig

Public URL of the project output feed - the address to hand to an advertising channel, or to open to inspect the exported data. Its extension is the file type of the project's output format (`.xml` for Heureka or Google Shopping, `.csv` for TikTok or plaincsv, `.tsv` for ChatGPT, and so on), so it is the file itself, not a page about it
exported_items integer

Products in the last successful export. Zero means nothing has been published at this URL yet, so it answers 404 - as it also does while the project is turned off, and when the last export is old enough that the file is no longer served (`get_project` reports both, the second as an `xml_updated_at` far in the past). On a freshly duplicated project the count is inherited from the project it was copied from, so there it is no evidence that the URL is live: a copy answers 404 until its own first export ran

get_query Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Query ID to fetch. Get from `list_project_queries` or `list_rule_queries`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the query
project_id string alwaysvždyvždymindig

ID of the project this query belongs to
name string

Display name of the query
query string alwaysvždyvždymindig

Raw MQL query expression
advanced_interface boolean

True if query was created using advanced/raw MQL interface
read_only boolean

True if query cannot be modified (e.g. system queries like ♥ALLPRODUCTS♥)
search_output boolean

True to query output data (after rules), False to query input data
product_count integer

Number of products currently matching this query
created_at string alwaysvždyvždymindig

When the query was created (ISO 8601)

get_rule Read-onlyPouze čteníIba čítanieCsak olvasás

Returns one rule by id. It carries nothing beyond the entry `list_project_rules` already gives, so reach for it only when you have an id without the listing. To change a rule in place use `update_rule`; only a change of TYPE needs delete + recreate.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Rule ID to fetch. Get from `list_project_rules`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the rule
project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
name string

Display name of the rule
note string

Internal note about the rule (why it exists, what it is for), or null
type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
element_path string

Target element path (optional, not all rule types require it)
priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
applies boolean

True if rule is active and will be executed
is_deletable boolean

True if user is allowed to delete this rule
is_movable boolean

True if user is allowed to change rule priority/position
is_editable boolean

True if user is allowed to modify rule parameters
is_pausable boolean

True if user is allowed to enable/disable the rule
data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
schedule.enabled boolean

False when the schedule is stored but has no effect
schedule.date_from string

First day (inclusive) the weekday hours are in effect
schedule.date_until string

Last day (inclusive) the weekday hours are in effect
schedule.apply_before boolean

Whether the rule applies on days before `date_from`
schedule.apply_after boolean

Whether the rule applies on days after `date_until`
schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)

get_shop Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Shop ID to fetch. Get from `list_user_eshops`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the shop
owner_id string alwaysvždyvždymindig

ID of the user who owns this shop
name string alwaysvždyvždymindig

Display name of the shop
web string

Website URL of the eshop
xml_domain string

Domain detected from XML feed URLs
exported_items integer

Total sum of exported items across all projects
tariff_id string

ID of the active tariff/pricing plan
tariff_validity string

ISO 8601 datetime when tariff expires
created_at string

ISO 8601 datetime when the shop was created
permissions array of object

List of users and their access roles for this shop

get_shop_app Read-onlyPouze čteníIba čítanieCsak olvasás

Fetches subscription details (free_until, paid_until) for a shop-level app. Use after `list_shop_apps` to inspect a specific subscription.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

app_name string requiredpovinnépovinnékötelező

Name (ID) of the application
shop_id string requiredpovinnépovinnékötelező

ID of the shop

OutputVýstupVýstupKimenet

app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
free_until string

Trial expiration date (ISO 8601)
paid_until string

Paid subscription expiration date (ISO 8601)

get_shop_event_logs Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

shop_id string requiredpovinnépovinnékötelező

ID of the shop whose event logs to retrieve
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of log entries
data[].id string alwaysvždyvždymindig

Log entry ID
data[].project_id string

Project ID
data[].type string

Log type (import, export, apply, access)
data[].status string | integer

Log status - a label (success, error) or an HTTP code (e.g. 200)
data[].message string

Log message
data[].created_at string

When log was created (ISO 8601)
data[].details object

Additional log details

get_shop_info Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Shop ID whose info to retrieve. Get it from `list_user_eshops`.

OutputVýstupVýstupKimenet

info object

Additional shop information and statistics

get_stats_audit Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Composite statistics-audit ID of the form `{m3shop_id}-{date_id}` (e.g. `1276-260625`). Get it from `list_shop_stats_audits`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Statistics audit ID
date string

Audit date (YYYY-MM-DD)
status string

Audit status, e.g. `done`
product_count number

Number of products audited
started_at string

When the audit started (ISO 8601)
finished_at string

When the audit finished (ISO 8601)
error string

Error detail when the audit failed
issues object

Per-validator issue summary, each with ok/wrong/... counts and item totals (present on a single audit only the listing omits it)

get_tariff Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Tariff ID to fetch. Get it from `list_available_tariffs`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Tariff ID
name string alwaysvždyvždymindig

Tariff name
price_czk integer alwaysvždyvždymindig

Price in CZK
price_eur integer alwaysvždyvždymindig

Price in EUR
price_pln integer alwaysvždyvždymindig

Price in PLN
price_usd integer alwaysvždyvždymindig

Price in USD
price_gbp integer alwaysvždyvždymindig

Price in GBP

get_user Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

User ID to retrieve. Get it from `get_current_user` or `list_users`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

User ID
first_name string

User first name
last_name string

User last name
name string

User full name
username string

User login name
email string

User email address
phone string

User phone number
city string

User city
company string

User company name
country string

Country code (ISO 3166-1)
postcode string

User postal code
street string

User street address
timezone string

User timezone
timezone_offset string

Timezone offset
dic string

VAT identification number
ico string

Taxpayer identification number
fakturoid_id string

Fakturoid.cz ID
invoice_months integer

Number of months to be invoiced
invoicing_validity_date string

Date until which services are prepaid
last_access string

Last access datetime (ISO 8601)
locale string

User locale (ISO 15897)
registered_at string

Registration datetime (ISO 8601)
send_summary boolean

Whether user wants to receive summaries
avatars object

Avatar URLs by dimension

get_user_app Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

app_name string requiredpovinnépovinnékötelező

Name (ID) of the application
user_id string requiredpovinnépovinnékötelező

ID of the user

OutputVýstupVýstupKimenet

app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
free_until string

Trial expiration date (ISO 8601)
paid_until string

Paid subscription expiration date (ISO 8601)

get_user_custom_formats Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

format_id string requiredpovinnépovinnékötelező

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épovinnékötelező

User ID who owns the custom formats. Get it from `get_current_user`.

OutputVýstupVýstupKimenet

user_id string

ID of the user the format belongs to
name string

Name of the format
url string

Link to the feed the format is based on
extension string

File type of the format (xml, csv, ...)
country string

Country of the format
visibility boolean

Visibility of the format
mappings array | object

How the format's elements map to Mergado: each with `xpath`, `parent`, `target`, `type`, `order` and `is_wrapper`
namespaces array of object

XML namespaces the format declares, each with `prefix` and `uri` - element names like `g:id` are only meaningful with them. Empty for a format that is not XML or declares none.
namespaces[].prefix string

Namespace prefix, e.g. `g`
namespaces[].uri string

The URI the prefix is bound to

get_user_eshop_permissions Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

shop_id string requiredpovinnépovinnékötelező

ID of the shop
user_id string requiredpovinnépovinnékötelező

ID of the user

OutputVýstupVýstupKimenet

permissions array of object

All permissions
permissions[].user_id string alwaysvždyvždymindig

User ID
permissions[].resource_id string alwaysvždyvždymindig

Resource ID (shop or project)
permissions[].role string alwaysvždyvždymindig

User role/permission level

get_user_notifications Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

user_id string requiredpovinnépovinnékötelező

ID of the user whose notifications to retrieve
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of notifications
data[].id string alwaysvždyvždymindig

Notification ID
data[].event string alwaysvždyvždymindig

Event type (e.g., app_notify)
data[].created_at string alwaysvždyvždymindig

Creation timestamp (ISO 8601)
data[].statuses array of object

One entry per channel this notification was delivered through, each with its own read state
data[].statuses[].status_id string

ID of this delivery record
data[].statuses[].channel string

Channel it was delivered through ('frontend', 'email')
data[].statuses[].user_id integer

ID of the recipient
data[].statuses[].resolved_at string

ISO 8601 datetime the recipient acknowledged it, null while unread
data[].priority string alwaysvždyvždymindig

Priority (low/medium/high)
data[].scope string alwaysvždyvždymindig

Scope (eshop/owner/user)
data[].data object

Event payload - the keys and value types depend on `event` (e.g. project_name, shop_url, billing_info_ok)

get_user_permissions Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

User ID whose permissions to retrieve. Get it from `get_current_user`.

OutputVýstupVýstupKimenet

permissions array of object

All permissions
permissions[].user_id string alwaysvždyvždymindig

User ID
permissions[].resource_id string alwaysvždyvždymindig

Resource ID (shop or project)
permissions[].role string alwaysvždyvždymindig

User role/permission level

get_user_project_permissions Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project
user_id string requiredpovinnépovinnékötelező

ID of the user

OutputVýstupVýstupKimenet

permissions array of object

All permissions
permissions[].user_id string alwaysvždyvždymindig

User ID
permissions[].resource_id string alwaysvždyvždymindig

Resource ID (shop or project)
permissions[].role string alwaysvždyvždymindig

User role/permission level

get_variable Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Variable ID to fetch. Get from `list_project_variables`.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the variable
project_id string alwaysvždyvždymindig

ID of the project this variable belongs to
name string alwaysvždyvždymindig

Variable name used in rules (e.g. "price", "category")
element_path string alwaysvždyvždymindig

XPath to the element this variable extracts from
type string alwaysvždyvždymindig

Variable type
regular_expression string

Regex pattern to extract part of element value (e.g. domain from URL), null when the variable takes the element value whole
fragment_number integer

Capturing group number to extract from regex match (0 for entire match), null when no regex is set
sample_text string

Example text for testing the regex in UI
project_element_id string

ID of the project element the variable reads, when it is bound to one

list_apps Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

List of applications
data[].title string

Application title
data[].type string

Application type: user, eshop, or project
data[].creation_date string

When application was created (ISO 8601)
data[].trial_period integer

Trial period in days
data[].forum_url string

Forum page URL
data[].latest_release_date string

Latest release date (ISO 8601)

list_available_tariffs Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

List of tariffs
data[].id string alwaysvždyvždymindig

Tariff ID
data[].name string alwaysvždyvždymindig

Tariff name
data[].price_czk integer alwaysvždyvždymindig

Price in CZK
data[].price_eur integer alwaysvždyvždymindig

Price in EUR
data[].price_pln integer alwaysvždyvždymindig

Price in PLN
data[].price_usd integer alwaysvždyvždymindig

Price in USD
data[].price_gbp integer alwaysvždyvždymindig

Price in GBP

list_feedaudit_issues Read-onlyPouze čteníIba čítanieCsak olvasás

Lists all validation issues, errors, warnings, and missing element recommendations detected by a completed feed audit. Main diagnostic tool for feed quality analysis. Use after an audit status is "done". Requires id (the audit ID). Token efficiency: Audits can generate large outputs; pass the fields parameter with ["id", "level", "verdict", "validator", "product_id"] to trim heavy metadata and avoid context limits. Use limit and offset for pagination. Returns an array of issue items with severity levels, validator names, human-readable verdicts, and affected product IDs. Call get_feedaudit_issue for deeper context on a specific issue.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the feed audit whose issues to list. Get from `list_project_feedaudits`.
fields array optionalvolitelnévoliteľnéválasztható

Optional. Return only these keys per issue, e.g. `["id", "level", "verdict", "validator", "product_id"]`. Worth using on any real audit: every issue otherwise repeats the full `feed_types` list of the formats it applies to, which dominates the row. Measured on a 545-issue audit: 604 kB untrimmed, 132 kB trimmed to those five keys. Valid keys: id, audit_id, product_id, validator, verdict, level, checked_at, info, feed_types. Keep `info` when you intend to explain a finding - it carries the offending element. Keys you leave out still come back in the result as null - that is this server filling in its response model, not the audit reporting an empty value. Read a trimmed row only for the keys you asked for. An unknown key is rejected outright (`400 Unknown field '<key>' in 'fields'`), so a typo fails loudly rather than silently emptying the response.
limit integer optionalvolitelnévoliteľnéválasztható

Pagination: maximum number of rows to return. Do NOT pass an exact multiple of 100 - on the feed-audit listings that value is broken upstream, in both of its failure directions. If at least 100 rows would be left unreturned the request is refused outright (`400 Invalid limit or offset.`), and if fewer than 100 would be left the limit is ignored and the ENTIRE collection comes back while the envelope still echoes the limit you asked for - so a request for 100 rows can quietly return thousands. Add one: 201, 1001 and 2001 all behave exactly as asked. Every non-multiple of 100 was correct at every size measured; `offset` is sound throughout and needs no such care.
offset integer optionalvolitelnévoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of audit issues
data[].id string alwaysvždyvždymindig

Issue ID
data[].audit_id string

ID of the audit this issue belongs to
data[].product_id string

ID of the audited product this issue is about. Resolve it with `get_feedaudit_product` to get the ITEM_ID, PRODUCTNAME and URL that name the product to a user. Null for a finding that belongs to the feed rather than to one product - a value duplicated across products, or a download/content-type failure - which is a small minority of rows (1 of 545 on one audit) and worth reporting separately rather than discarding.
data[].validator string

Validator that raised the issue, e.g. `is_present_product`
data[].verdict string

What the validator concluded - the finding itself, where `validator` is only which check produced it. Observed values include `missing`, `wrong_format`, `contains_html`, `single_category`, `duplicate` and `unknown_compression`, plus `error` for a failure of the run. The set is open, so render it rather than matching on it.
data[].level string

Severity: `error`, `warning` or `recommendation`. This is the field that decides what to tell the user - only `error` rows are counted by the audit's `errors`, and `recommendation` rows are usually the bulk of a listing (408 of 545 on one audit), so a raw issue count badly overstates how much is wrong.
data[].checked_at string

When the validation ran
data[].feed_types array of string

The comparison-shopping formats this validation applies to - not the formats the audit ran against. It repeats the same long list on nearly every row and is the main reason an untrimmed listing is large, so leave it out of `fields` unless you need it.
data[].info object

Validator-specific context, and where a finding becomes actionable: it names the offending element (`{"element": "DELIVERY_DATE"}`), or for a duplicate the shared `value` and the `products` sharing it. Keep it in `fields` when you intend to explain the findings rather than count them.

list_feedaudit_product_issues Read-onlyPouze čteníIba čítanieCsak olvasás

Lists all validation issues and errors that apply to one specific audited product item. Use to answer "what errors and warnings exist for this specific product?" after finding a problematic product in list_feedaudit_products. Requires id (the audited product ID from list_feedaudit_products or list_feedaudit_issues). Supports limit and offset pagination. Returns all error, warning, and recommendation records specifically tied to that product.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the audited product whose issues to list. Get from `list_feedaudit_products`.
fields array optionalvolitelnévoliteľnéválasztható

Optional. Return only these keys per issue. Same keys as `list_feedaudit_issues`: id, audit_id, product_id, validator, verdict, level, checked_at, info, feed_types. `feed_types` is the bulk of an untrimmed row here too. Keys you leave out still come back in the result as null - that is this server filling in its response model, not the audit reporting an empty value. Read a trimmed row only for the keys you asked for. An unknown key is rejected outright (`400 Unknown field '<key>' in 'fields'`), so a typo fails loudly rather than silently emptying the response.
limit integer optionalvolitelnévoliteľnéválasztható

Pagination: maximum number of rows to return. Do NOT pass an exact multiple of 100 - on the feed-audit listings that value is broken upstream, in both of its failure directions. If at least 100 rows would be left unreturned the request is refused outright (`400 Invalid limit or offset.`), and if fewer than 100 would be left the limit is ignored and the ENTIRE collection comes back while the envelope still echoes the limit you asked for - so a request for 100 rows can quietly return thousands. Add one: 201, 1001 and 2001 all behave exactly as asked. Every non-multiple of 100 was correct at every size measured; `offset` is sound throughout and needs no such care.
offset integer optionalvolitelnévoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of audit issues
data[].id string alwaysvždyvždymindig

Issue ID
data[].audit_id string

ID of the audit this issue belongs to
data[].product_id string

ID of the audited product this issue is about. Resolve it with `get_feedaudit_product` to get the ITEM_ID, PRODUCTNAME and URL that name the product to a user. Null for a finding that belongs to the feed rather than to one product - a value duplicated across products, or a download/content-type failure - which is a small minority of rows (1 of 545 on one audit) and worth reporting separately rather than discarding.
data[].validator string

Validator that raised the issue, e.g. `is_present_product`
data[].verdict string

What the validator concluded - the finding itself, where `validator` is only which check produced it. Observed values include `missing`, `wrong_format`, `contains_html`, `single_category`, `duplicate` and `unknown_compression`, plus `error` for a failure of the run. The set is open, so render it rather than matching on it.
data[].level string

Severity: `error`, `warning` or `recommendation`. This is the field that decides what to tell the user - only `error` rows are counted by the audit's `errors`, and `recommendation` rows are usually the bulk of a listing (408 of 545 on one audit), so a raw issue count badly overstates how much is wrong.
data[].checked_at string

When the validation ran
data[].feed_types array of string

The comparison-shopping formats this validation applies to - not the formats the audit ran against. It repeats the same long list on nearly every row and is the main reason an untrimmed listing is large, so leave it out of `fields` unless you need it.
data[].info object

Validator-specific context, and where a finding becomes actionable: it names the offending element (`{"element": "DELIVERY_DATE"}`), or for a duplicate the shared `value` and the `products` sharing it. Keep it in `fields` when you intend to explain the findings rather than count them.

list_feedaudit_products Read-onlyPouze čteníIba čítanieCsak olvasás

Lists all products captured and evaluated during a feed audit, showing parsed element values as they existed in the feed at audit time. Use to inspect the audited product catalog or cross-reference products against detected audit issues. Requires id (the audit ID from list_project_feedaudits). Supports limit and offset pagination, and optional fields array. Returns a list of products with their internal IDs and parsed feed elements. To inspect all issues for a specific product, call list_feedaudit_product_issues with the product's ID.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the feed audit whose products to list. Get from `list_project_feedaudits`.
fields array optionalvolitelnévoliteľnéválasztható

Optional. Return only these keys per product. Valid keys: id, audit_id, elements. `elements` is the whole payload here - it holds every parsed tag of every product - so this is the most effective trim on any feed-audit listing: a 136-product audit is 253 kB whole and 9.8 kB as `["id"]`. Trim to `["id"]` when you only need to count the products or map issue `product_id`s onto rows, and omit `fields` when you need to identify the products themselves. Keys you leave out still come back in the result as null - that is this server filling in its response model, not the audit reporting an empty value. Read a trimmed row only for the keys you asked for. An unknown key is rejected outright (`400 Unknown field '<key>' in 'fields'`), so a typo fails loudly rather than silently emptying the response.
limit integer optionalvolitelnévoliteľnéválasztható

Pagination: maximum number of rows to return. Do NOT pass an exact multiple of 100 - on the feed-audit listings that value is broken upstream, in both of its failure directions. If at least 100 rows would be left unreturned the request is refused outright (`400 Invalid limit or offset.`), and if fewer than 100 would be left the limit is ignored and the ENTIRE collection comes back while the envelope still echoes the limit you asked for - so a request for 100 rows can quietly return thousands. Add one: 201, 1001 and 2001 all behave exactly as asked. Every non-multiple of 100 was correct at every size measured; `offset` is sound throughout and needs no such care.
offset integer optionalvolitelnévoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of audited products
data[].id string alwaysvždyvždymindig

Audited product ID
data[].audit_id string

ID of the audit this product belongs to
data[].elements array of object

The product's elements as the audit parsed them out of the feed (tag/value pairs, PARAM nested one level deeper). This is where a product gets its identity: ITEM_ID, PRODUCTNAME, URL, EAN and the rest are all here, so an issue can be reported against a product the user recognises - take the issue's `product_id`, read that product, and quote its ITEM_ID.It was documented here as "in practice always null", which was true of the API at the time and is not any more: re-measured, every product of every audit carried its full element list (136 of 136, in the listing and the detail alike). The old note told the agent to refuse "what is wrong with product X" as unanswerable. It is answerable - answer it.Null only when you asked for it: a `fields` list that leaves `elements` out reads back as null here, which is this server filling in the model rather than the audit having nothing.
data[].elements[].tag string

Element tag, e.g. `PRODUCT`, `PRICE_VAT`
data[].elements[].value string | number | integer

Element value
data[].elements[].elements array of string

Nested child elements - a PARAM carries its PARAM_NAME and VAL here, and its own `value` is the empty string. An empty list for a leaf element (the API sends `[]`, not null, though null is tolerated).

list_pairings Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose pairings to list. Get it from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of pairings matching the request
data[].id string alwaysvždyvždymindig

Pairing ID (stable identifier, corresponds to product ID). Pass it straight to `get_pairing`.
data[].project_id string

ID of the project
data[].created_at string

ISO 8601 datetime when product first appeared in feed (null for products before Jan 11, 2017)
data[].deleted_at string

ISO 8601 datetime when product last appeared in feed (null if still present)

list_project_apps Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose installed apps to list. Get it from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of enabled apps
data[].app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
data[].free_until string

Trial expiration date (ISO 8601)
data[].paid_until string

Paid subscription expiration date (ISO 8601)

list_project_elements Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose elements to list. Get from `list_shop_projects`.

OutputVýstupVýstupKimenet

elements array of object

The project's elements as a tree, ordered as they appear in the feed
elements[].name string alwaysvždyvždymindig

Element tag name on its own, without the path to it
elements[].element_path string alwaysvždyvždymindig

Full path of this element, ready to be passed to any tool that takes an `element_path` (the rule tools, `list_unique_element_values`). A child reads `PARENT | CHILD` and an attribute `PARENT | @ATTRIBUTE`.
elements[].id string

Unique identifier of the element
elements[].is_attribute boolean

True if this is an XML attribute of its parent rather than an element
elements[].is_hidden boolean

True if the element exists in the project but is left out of the output feed
elements[].is_hidden_set_manually boolean

True if a person hid (or unhid) the element, rather than the import
elements[].output_cdata boolean

True if the element's value is written into the output feed wrapped in CDATA
elements[].origin string

Where the element came from: 'input' (the source feed), 'from_rule' (created by a rule), or 'manual' (created by hand)
elements[].order integer

Position of the element among its siblings
elements[].children array of object

Child elements, ordered as they appear in the feed

list_project_feedaudits Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose feed audits to list. Get from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of feed audits
data[].id string alwaysvždyvždymindig

Audit ID
data[].project_id string

ID of the project whose feed was audited
data[].status string

Audit status: `in_progress` while it runs, then `done` or `error`. This is the field to poll - the API sends no progress percentage.
data[].errors integer

Number of `error`-level issues the audit recorded - the count of `list_feedaudit_issues` rows whose `level` is `error`, exactly. It does NOT count `warning` or `recommendation` rows, so it is a floor on what is wrong with the feed and not a total: an audit reporting `errors: 136` held 545 issues, and one reporting `errors: 0` may still hold hundreds of recommendations. Read the levels you care about off `list_feedaudit_issues` rather than inferring them from this number. A failure of the RUN itself (feed unreachable, unparseable) is counted here too, because it is filed as an error-level issue like any other - a 404 on the feed URL produced `status: error`, `error: "feed_download_error"` and `errors: 1`, that 1 being an issue with validator `http`. Use `status` and `error` to tell a failed run from a completed one; this field does not distinguish them. Null on `list_project_feedaudits`, which omits it - re-read the audit with `get_feedaudit` to get the count.
data[].feed_url string

Audited source feed URL
data[].feed_types array of string

Comparison-shopping formats the feed was validated against
data[].parser_type string

Input-feed parser type used
data[].product_count number

Number of products found in the feed
data[].shop_name string

Shop name as read from the feed
data[].webhook_url string

Webhook pinged on completion
data[].error string

Error detail when the audit failed
data[].started_at string

When the audit started, ISO 8601 in real UTC (`+00:00`, and the label is correct). The skew this field used to carry - two hours on the read paths, four on the create path, so the same audit reported two different start times - was fixed upstream and re-measured: `create_feedaudit` and `get_feedaudit` now agree with each other and with the wall clock. Ages and durations computed from it are sound again.
data[].finished_at string

When the audit finished, ISO 8601 in real UTC, null while it is still running. Accurate now, like `started_at`. `time` remains the cheaper answer for how long the audit took, since it needs no arithmetic.
data[].time number

Audit duration in seconds
data[].slug string

Opaque per-audit token Mergado mints for its web-facing audit view. It is NOT an alternative id and this API offers no way to look an audit up by it - `/feedaudits/{slug}/`, `/feedaudits/slug/{slug}/` and `?slug=` all answer 404, so address every feed-audit tool by `id`. What it IS good for is the page a human reads: that is `result_url`, built from this slug - hand the user that, never the slug on its own.
data[].result_url string

Public page showing this audit's results - the link to give the user when they want to see the findings themselves rather than have them summarised. Built from the audit's slug; null when the audit has none, or when this deployment has not been told where its audit pages live.
data[].email string

Address Mergado notifies when the audit finishes
data[].source string

How the audit was started - `api` for one this server created, other values for audits started from the Mergado web UI.
data[].user_locale string

Locale of the user who started the audit, e.g. `sk_SK`. Describes the notification e-mail, not the audit: findings come back untranslated regardless.
data[].agree_newsletter boolean

Marketing consent recorded with the audit, not an audit result
data[].agree_marketing boolean

Marketing consent recorded with the audit, not an audit result
data[].agree_analytics boolean

Analytics consent recorded with the audit, not an audit result

list_project_products Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

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`.
include_data boolean optionalvolitelnévoliteľnéválasztható

Optional. With `values_to_extract`, also return each product's full `data` tree next to `extracted_values`. Much larger - leave false unless the extracted values are not enough. Has no effect without `values_to_extract`, where `data` is always returned.
is_hidden boolean optionalvolitelnévoliteľnéválasztható

Filter by visibility: true=only hidden, false=only visible, null/omitted=all products
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Optional MQL query string to filter products (e.g. "PRICE > 100"). Can be used in GET or POST request body.
offset integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

Element paths to return instead of the whole product tree, e.g. `["PRODUCTNAME", "PRICE_VAT"]`. The answer then carries `data: {}` and only the requested values under `extracted_values`, which is far smaller — use it whenever you need a few fields rather than the full product. Paths are case-sensitive; discover them with `list_project_elements`. Set `include_data: true` if you need the full tree as well.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Products matching the request
data[].id string alwaysvždyvždymindig

Product ID corresponding to pairing ID (stable identifier across feed updates)
data[].output_changed_at string

ISO 8601 datetime when output data (after rules) last changed
data[].updated_at string

ISO 8601 datetime when input data from feed last changed
data[].project_id string

ID of the project the product is in
data[].data object

Output product data (after applying all rules), as `{elements: {NAME: [{value, ...}]}, attributes: {...}}`. Empty when `values_to_extract` was used without `include_data` - read `extracted_values` then
data[].extracted_values object

Values extracted from the requested element paths or variables, as path -> list of values (only present if `values_to_extract` was used)
data[].is_hidden boolean

True if the product is left out of the output feed - because a hiding rule matches it, because it was hidden manually, or both
data[].is_hidden_by_rule boolean

True if any hiding rule of the project matches the product
data[].is_hidden_manually boolean

True if this product itself was hidden by hand (in the Mergado UI or the API)
data[].manual_changes array of object

Element values set by hand for this one product, on top of what the rules compute
data[].manual_changes[].element_path string alwaysvždyvždymindig

Element path the manual value belongs to, in the escaped and position-qualified form Mergado stores it in (which of the element's values it sets)
data[].manual_changes[].value string alwaysvždyvždymindig

The value the element is forced to
data[].manual_changes[].is_applied boolean

True once the value is in the output feed; false while it waits for the next regeneration of the project

list_project_queries Read-onlyPouze čteníIba čítanieCsak olvasás

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. Queries named BF_* were written by Bidding Fox, not by the user. The extensions keep their own saved product filters, which are a different object and are not listed here (app_*_list_product_filters).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose queries to list. Get from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

All queries matching the request
data[].id string alwaysvždyvždymindig

Unique identifier of the query
data[].project_id string alwaysvždyvždymindig

ID of the project this query belongs to
data[].name string

Display name of the query
data[].query string alwaysvždyvždymindig

Raw MQL query expression
data[].advanced_interface boolean

True if query was created using advanced/raw MQL interface
data[].read_only boolean

True if query cannot be modified (e.g. system queries like ♥ALLPRODUCTS♥)
data[].search_output boolean

True to query output data (after rules), False to query input data
data[].product_count integer

Number of products currently matching this query
data[].created_at string alwaysvždyvždymindig

When the query was created (ISO 8601)

list_project_rules Read-onlyPouze čteníIba čítanieCsak olvasás

Lists a project's rules in application order (lower priority runs first). Each entry is the complete rule object — the same one `get_rule` returns — including `note`, `schedule` and the `is_*` flags. Start here before creating, reordering or deleting a rule.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose rules to list. Get from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of rules in the project ordered by priority
data[].id string alwaysvždyvždymindig

Unique identifier of the rule
data[].project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
data[].name string

Display name of the rule
data[].note string

Internal note about the rule (why it exists, what it is for), or null
data[].type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
data[].element_path string

Target element path (optional, not all rule types require it)
data[].priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
data[].applies boolean

True if rule is active and will be executed
data[].is_deletable boolean

True if user is allowed to delete this rule
data[].is_movable boolean

True if user is allowed to change rule priority/position
data[].is_editable boolean

True if user is allowed to modify rule parameters
data[].is_pausable boolean

True if user is allowed to enable/disable the rule
data[].data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
data[].queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
data[].schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
data[].schedule.enabled boolean

False when the schedule is stored but has no effect
data[].schedule.date_from string

First day (inclusive) the weekday hours are in effect
data[].schedule.date_until string

Last day (inclusive) the weekday hours are in effect
data[].schedule.apply_before boolean

Whether the rule applies on days before `date_from`
data[].schedule.apply_after boolean

Whether the rule applies on days after `date_until`
data[].schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)
total integer

Total number of rules in the project - this endpoint sends `total` rather than `total_results`; use it to know when to stop paging

list_project_variables Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose variables to list. Get from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of variables in the project
data[].id string alwaysvždyvždymindig

Unique identifier of the variable
data[].project_id string alwaysvždyvždymindig

ID of the project this variable belongs to
data[].name string alwaysvždyvždymindig

Variable name used in rules (e.g. "price", "category")
data[].element_path string alwaysvždyvždymindig

XPath to the element this variable extracts from
data[].type string alwaysvždyvždymindig

Variable type
data[].regular_expression string

Regex pattern to extract part of element value (e.g. domain from URL), null when the variable takes the element value whole
data[].fragment_number integer

Capturing group number to extract from regex match (0 for entire match), null when no regex is set
data[].sample_text string

Example text for testing the regex in UI
data[].project_element_id string

ID of the project element the variable reads, when it is bound to one

list_rule_queries Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Rule ID whose queries to list. Get from `list_project_rules`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

All queries matching the request
data[].id string alwaysvždyvždymindig

Unique identifier of the query
data[].project_id string alwaysvždyvždymindig

ID of the project this query belongs to
data[].name string

Display name of the query
data[].query string alwaysvždyvždymindig

Raw MQL query expression
data[].advanced_interface boolean

True if query was created using advanced/raw MQL interface
data[].read_only boolean

True if query cannot be modified (e.g. system queries like ♥ALLPRODUCTS♥)
data[].search_output boolean

True to query output data (after rules), False to query input data
data[].product_count integer

Number of products currently matching this query
data[].created_at string alwaysvždyvždymindig

When the query was created (ISO 8601)

list_shop_apps Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Shop ID whose installed apps to list. Get it from `list_user_eshops`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of enabled apps
data[].app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
data[].free_until string

Trial expiration date (ISO 8601)
data[].paid_until string

Paid subscription expiration date (ISO 8601)

list_shop_projects Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Shop ID whose projects to list. Get from `list_user_eshops`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of projects in the shop
data[].id string alwaysvždyvždymindig

Unique identifier of the project (export)
data[].shop_id string alwaysvždyvždymindig

ID of the eshop this project belongs to
data[].creator_id string

ID of the user who created this project
data[].name string alwaysvždyvždymindig

Display name of the project
data[].url string alwaysvždyvždymindig

URL of the source XML feed with products
data[].created string

ISO 8601 datetime when the project was created
data[].exported_items integer

Number of products exported in the last successful export
data[].input_format string

Input format identifier (e.g. heureka.cz, zbozi.cz, google)
data[].output_format string

Output format identifier for the transformed feed
data[].pairing_elements array of string

Element paths used for product pairing/identification during feed synchronization
data[].readonly boolean

True if project is being regenerated and modifications are locked. Product data may not be consistent during this state.
data[].is_paused boolean

True if automatic scheduled rebuilds are temporarily disabled
data[].rules_changed_at string

ISO 8601 datetime of the last rule creation, deletion, or update
data[].slug string alwaysvždyvždymindig

Unique URL-safe identifier used in the output feed URL path
data[].turned_off boolean

True if the project is completely disabled (no processing occurs)
data[].update_period integer

Automatic update interval in seconds (e.g. 3600 for hourly, 86400 for daily)
data[].last_access string

ISO 8601 datetime of last user access to this project
data[].data_synced_at string

ISO 8601 datetime when the input feed was last successfully imported
data[].data_updated_at string

ISO 8601 datetime when the project data was last modified by source feed changes
data[].in_testing_mode boolean

True if project is in testing mode (export generation is disabled)
data[].autohide_new_products boolean

True if newly imported products are hidden until somebody authorizes them
data[].encoding string

Encoding the input feed is read with, or null when the import detects it from the feed (the usual case)
data[].all_products_query_id string

ID of the ♥ALLPRODUCTS♥ query matching every product - the query to pass when a rule should apply to all products
data[].number_of_elements integer

Number of elements defined in the project
data[].metadata object

Additional project metadata (e.g. `stats_ga_source`)
data[].sync_schedule object

When the project downloads its source feed
data[].sync_schedule.minute string

Cron minute field, e.g. "50"
data[].sync_schedule.hour string

Cron hour field, e.g. "*/1" for hourly
data[].sync_schedule.day_of_week string

Cron day-of-week field
data[].sync_schedule.day_of_month string

Cron day-of-month field
data[].sync_schedule.month_of_year string

Cron month field

list_shop_stats_audits Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the shop whose statistics audits to list. Get from `list_user_eshops`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of statistics audits
data[].id string alwaysvždyvždymindig

Statistics audit ID
data[].date string

Audit date (YYYY-MM-DD)
data[].status string

Audit status, e.g. `done`
data[].product_count number

Number of products audited
data[].started_at string

When the audit started (ISO 8601)
data[].finished_at string

When the audit finished (ISO 8601)
data[].error string

Error detail when the audit failed
data[].issues object

Per-validator issue summary, each with ok/wrong/... counts and item totals (present on a single audit only the listing omits it)

list_stats_audit_issues Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Composite statistics-audit ID of the form `{m3shop_id}-{date_id}` (e.g. `1276-260625`). Get it from `list_shop_stats_audits`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of statistics-audit issues
data[].audit_id string

ID of the statistics audit
data[].item_id string

Affected item ID
data[].product_id string

Affected product ID (if any)
data[].validator string

Validator that raised the issue, e.g. `heureka_is_paired`
data[].verdict string

Validation verdict, e.g. `wrong`
data[].info object

Validator-specific context

list_supported_feed_formats Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

data array of string

List of supported format IDs (e.g. "heureka.cz", "zbozi.cz")

list_traced_products Read-onlyPouze čteníIba čítanieCsak olvasás

Lists the products currently traced in the project - the sample `preview_rule_changes` reports on. The `auto_traced` flag separates products Mergado's sampling algorithm picked (true) from products a user or the API marked (false); only the latter count towards the 50-product cap on `mark_traced_product`.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Project ID whose traced products to list. Get from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Traced products of the project.
data[].product_id string alwaysvždyvždymindig

ID of the traced product (pairing xid).
data[].auto_traced boolean alwaysvždyvždymindig

True = the product was picked automatically by the sampling algorithm (system). False = it was marked manually by a user or via the API.
data[].created_at string

When the product was marked (ISO 8601).

list_unique_element_values Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

element_path string requiredpovinnépovinnékötelező

Path of the element whose values to read, exactly as `list_project_elements` reports it in `element_path`. NOT an XPath: a child is written `PARENT | CHILD` (spaces around the pipe) and an attribute `PARENT | @ATTRIBUTE`, e.g. "PRODUCTNAME", "PARAM | PARAM_NAME", "GIFT | @ID".
project_id string requiredpovinnépovinnékötelező

Project ID from which to retrieve values
is_output boolean optionalvolitelnévoliteľnéválasztható

True=output values (after rules), False=input values (before rules), null=output
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

List of unique values with occurrence counts
data[].value string | integer | number | boolean

The actual value found in products
data[].count integer

Number of products that have this value

list_user_apps Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

User ID whose installed apps to list. Get it from `get_current_user`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of enabled apps
data[].app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
data[].free_until string

Trial expiration date (ISO 8601)
data[].paid_until string

Paid subscription expiration date (ISO 8601)

list_user_eshops Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

User ID whose shops to retrieve. Get it from `get_current_user`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

All shops the user has access to
data[].id string alwaysvždyvždymindig

Unique identifier of the shop
data[].owner_id string alwaysvždyvždymindig

ID of the user who owns this shop
data[].name string alwaysvždyvždymindig

Display name of the shop
data[].web string

Website URL of the eshop
data[].xml_domain string

Domain detected from XML feed URLs
data[].exported_items integer

Total sum of exported items across all projects
data[].tariff_id string

ID of the active tariff/pricing plan
data[].tariff_validity string

ISO 8601 datetime when tariff expires
data[].created_at string

ISO 8601 datetime when the shop was created
data[].permissions array of object

List of users and their access roles for this shop

list_users Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Array of users the client has access to
data[].id string alwaysvždyvždymindig

User ID
data[].first_name string

User first name
data[].last_name string

User last name
data[].name string

User full name
data[].username string

User login name
data[].email string

User email address
data[].phone string

User phone number
data[].city string

User city
data[].company string

User company name
data[].country string

Country code (ISO 3166-1)
data[].postcode string

User postal code
data[].street string

User street address
data[].timezone string

User timezone
data[].timezone_offset string

Timezone offset
data[].dic string

VAT identification number
data[].ico string

Taxpayer identification number
data[].fakturoid_id string

Fakturoid.cz ID
data[].invoice_months integer

Number of months to be invoiced
data[].invoicing_validity_date string

Date until which services are prepaid
data[].last_access string

Last access datetime (ISO 8601)
data[].locale string

User locale (ISO 15897)
data[].registered_at string

Registration datetime (ISO 8601)
data[].send_summary boolean

Whether user wants to receive summaries
data[].avatars object

Avatar URLs by dimension

mark_traced_product Writes dataZapisuje dataZapisuje dátaAdatot ír

Adds a product to the project's traced sample. Use when the user wants the preview to cover a specific product rather than whatever the sampling algorithm picked. A project holds at most 50 manually marked products (auto-traced ones do not count towards that); marking an already-traced product, or exceeding the limit, fails with a conflict, and a product that is not in the project at all answers 404. Marking a product the sampling algorithm had picked converts it to a manually marked one.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

product_id string requiredpovinnépovinnékötelező

ID of the product (pairing xid) to mark. Get from `list_project_products` or `query_products` and pass it exactly as they return it.
project_id string requiredpovinnépovinnékötelező

ID of the project. Get from `list_shop_projects`.

OutputVýstupVýstupKimenet

product_id string alwaysvždyvždymindig

ID of the traced product (pairing xid).
auto_traced boolean alwaysvždyvždymindig

True = the product was picked automatically by the sampling algorithm (system). False = it was marked manually by a user or via the API.
created_at string

When the product was marked (ISO 8601).

parse_feed_elements Read-onlyPouze čteníIba čítanieCsak olvasás

Downloads an XML or CSV file from `url` and returns the elements it contains, WITHOUT creating anything in Mergado. Use it before a project exists - to show a user what is in their feed, to check that a URL really serves the data file, or to plan an import. The format is detected from the content, so the file name does not matter, and each element comes back with how often it occurs (`count`) and its first value (`example`). Two things to tell the user rather than work around. The `path` of an element is the path inside the FILE (an XPath, or the CSV column) - it is not an `element_path` and no rule tool will accept it. Rules, variables and MQL all take Mergado element paths (`PARAM | VAL`), which `list_project_elements` prints. For a Data Import rule translate it: `/SHOP/SHOPITEM` becomes the wrapper `SHOP | SHOPITEM`, and an element inside it becomes the key relative to that wrapper — `/SHOP/SHOPITEM/ITEM_ID` becomes `ITEM_ID`; element paths only exist once the feed is a project. And a URL that opens a share PAGE instead of serving the file parses as the page: the answer then carries `looks_like_a_web_page: true` with `html` and `head` as its elements, and what is needed is the direct-download link. For a project that already exists, use `list_project_elements` instead - it reports the project's own elements, each with the `element_path` the rule tools take.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

url string requiredpovinnépovinnékötelező

URL of the XML or CSV file to parse. Must be an http, https or sftp address, and must be the FILE itself - a share page (a Dropbox or Google Drive link that opens a viewer) is a web page, and the parser will happily read its HTML and report `html`, `head` and `script` as the elements of the feed. Use the direct-download form of such a link.

OutputVýstupVýstupKimenet

extension string

Format the file was parsed as - `xml` or `csv`. Detected from the content, not from the file name.
namespaces object

XML namespaces found in the file, as prefix -> URI. Always empty for CSV. A prefix here explains element names like `g:title`.
elements array of object

The elements found in the file, as a tree, in document order
elements[].name string alwaysvždyvždymindig

Element (or attribute) name on its own, without its path
elements[].path string

Where this sits in the FILE - an XPath for XML, the column name for CSV. It is not a Mergado `element_path` and must not be passed to a tool that takes one: those address elements of a project, and no project exists here yet.
elements[].is_attribute boolean

True for an XML attribute, which is parsed as an element of its own and named with a leading `@`
elements[].is_wrapper boolean

True when the element wraps other elements instead of holding a value
elements[].order integer

Position among its siblings, in document order
elements[].count integer

How many times the element occurs in the file
elements[].example string

First value found for this element - the quickest way to tell what it holds. Empty for a wrapper.
elements[].children array of object

Nested elements, in document order
looks_like_a_web_page boolean

True when the parsed document is an HTML page rather than a feed - the answer a share link gives when it opens a viewer instead of serving the file. The parse succeeded, but the elements below describe a web page, so ask for the direct-download URL rather than reporting them as the feed.

preview_rule_changes Read-onlyPouze čteníIba čítanieCsak olvasás

Returns the before/after element values recorded for the project's traced products, per rule and element path, ordered by the rule priority the run used. Use to judge the impact of rules on a small sample instead of applying them to the whole project and reading the output feed. Each row covers the latest recorded run only, so it reflects the rules as they stood then - run `apply_rules_to_traced_products` after editing a rule to refresh it. Pass `product_id` to narrow the listing to one traced product.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the project. Get from `list_shop_projects`.
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.
product_id string optionalvolitelnévoliteľnéválasztható

Optional: narrow the listing to a single traced product - its `product_id` from `list_traced_products`, exactly as that tool returns it.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Per-rule, per-element before/after changes, ordered by the rule priority the apply ran with.
data[].id string

ID of the recorded change.
data[].product_id string

ID of the traced product the change was recorded on.
data[].rule_id string

ID of the rule that produced the change - pass to `get_rule`.
data[].apply_log_id string

ID of the apply run this change belongs to - pass to `get_apply_log`.
data[].element_path string

Element path the change was recorded on.
data[].content_in string

Element value before the rule was applied.
data[].content_out string

Element value after the rule was applied.

query_products Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

query_id string requiredpovinnépovinnékötelező

ID of the query to execute
include_data boolean optionalvolitelnévoliteľnéválasztható

Optional. With `values_to_extract`, also return each product's full `data` tree next to `extracted_values`. Much larger - leave false unless the extracted values are not enough. Has no effect without `values_to_extract`, where `data` is always returned.
is_hidden boolean optionalvolitelnévoliteľnéválasztható

Filter by visibility: true=only hidden, false=only visible, null=all
limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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évoliteľnéválasztható

Element paths to return instead of the whole product tree, e.g. `["PRODUCTNAME", "PRICE_VAT"]`. The answer then carries `data: {}` and only the requested values under `extracted_values`, which is far smaller — use it whenever you need a few fields rather than the full product. Paths are case-sensitive; discover them with `list_project_elements`. Set `include_data: true` if you need the full tree as well.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

Products matching the request
data[].id string alwaysvždyvždymindig

Product ID corresponding to pairing ID (stable identifier across feed updates)
data[].output_changed_at string

ISO 8601 datetime when output data (after rules) last changed
data[].updated_at string

ISO 8601 datetime when input data from feed last changed
data[].project_id string

ID of the project the product is in
data[].data object

Output product data (after applying all rules), as `{elements: {NAME: [{value, ...}]}, attributes: {...}}`. Empty when `values_to_extract` was used without `include_data` - read `extracted_values` then
data[].extracted_values object

Values extracted from the requested element paths or variables, as path -> list of values (only present if `values_to_extract` was used)
data[].is_hidden boolean

True if the product is left out of the output feed - because a hiding rule matches it, because it was hidden manually, or both
data[].is_hidden_by_rule boolean

True if any hiding rule of the project matches the product
data[].is_hidden_manually boolean

True if this product itself was hidden by hand (in the Mergado UI or the API)
data[].manual_changes array of object

Element values set by hand for this one product, on top of what the rules compute
data[].manual_changes[].element_path string alwaysvždyvždymindig

Element path the manual value belongs to, in the escaped and position-qualified form Mergado stores it in (which of the element's values it sets)
data[].manual_changes[].value string alwaysvždyvždymindig

The value the element is forced to
data[].manual_changes[].is_applied boolean

True once the value is in the output feed; false while it waits for the next regeneration of the project

remove_traced_product Writes dataZapisuje dataZapisuje dátaAdatot ír

Unmarks a single product, taking it out of the traced sample. Use when the user no longer wants a product covered by the preview. A product that is not currently traced answers 404 rather than succeeding silently.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

product_id string requiredpovinnépovinnékötelező

ID of the traced product to unmark. Get from `list_traced_products`.
project_id string requiredpovinnépovinnékötelező

ID of the project. Get from `list_shop_projects`.

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

reorder_rules Writes dataZapisuje dataZapisuje dátaAdatot ír

Rearranges rules of a project into the order given by `rule_ids` - first in the list is applied first. Rules are applied one after another, each seeing the output of the ones before it, so their order decides the result: rounding a price before a discount is calculated gives a different feed than rounding it after. Use whenever the user wants a rule to run before or after another one. Only the listed rules move, and only their positions among themselves: they are redealt the priorities they already occupy, so every rule left out of the list keeps exactly the position it has - reordering three rules of forty touches those three. Read the current order with `list_project_rules` first (it is returned in application order), then pass the ids in the order the user wants. Nothing else about the rules is touched - not their names, queries, data, or whether they are active. Rules Mergado pins in place (`is_movable: false`, such as the hiding rules it keeps at the end of every chain) cannot be moved, and the whole call is refused rather than partly applied if one of them is listed. Neither can the rules of a project that is turned off be moved, so turn it back on first. The new order takes effect on the next rebuild, which Mergado schedules itself. Mergado rules only. Pricing Fox has a same-named tool for its own chain (app_pricingfox_reorder_rules) with the opposite model: there the first matching rule wins and the product leaves the chain.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

project_id string requiredpovinnépovinnékötelező

ID of the project whose rules to reorder. Get it from `list_shop_projects`; every rule listed must belong to it.
rule_ids array requiredpovinnépovinnékötelező

Rule IDs in the order they should be APPLIED - first in the list is applied first, and therefore feeds its output to the next one. Get them from `list_project_rules`, which already returns the current order. Only the listed rules move: they are rearranged among the positions they occupy today, so every rule left out keeps its own position exactly. List two or more rules; listing a rule twice is refused.

OutputVýstupVýstupKimenet

project_id string alwaysvždyvždymindig

ID of the project whose rules were reordered
rules array of object

The reordered rules in their new application order (lowest priority first), as read back after the change
rules[].id string alwaysvždyvždymindig

ID of the rule
rules[].name string

Display name of the rule
rules[].type string

Rule type identifier
rules[].priority string alwaysvždyvždymindig

Priority the rule now has - lower is applied earlier
rules[].moved boolean

True if this rule had to be given a new priority, false if the requested order already put it where it was
updated integer

How many rules were actually given a new priority - the rest were already in the requested position and were left untouched
message string

Human-readable summary of what changed

retract_query_from_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

query_id string requiredpovinnépovinnékötelező

ID of query to unassign from the rule
rule_id string requiredpovinnépovinnékötelező

ID of the rule to remove query from

OutputVýstupVýstupKimenet

success boolean

True if operation completed successfully
message string

Human-readable message about the operation result
id string

ID of created/affected resource (if applicable)
status string

Status code or identifier

show_maintenance_info Read-onlyPouze čteníIba čítanieCsak olvasás

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í parametryVstupné parametreBemeneti paraméterek

limit integer optionalvolitelnévoliteľnéválasztható

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évoliteľnéválasztható

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.

OutputVýstupVýstupKimenet

limit integer

Number of items per page
total_results integer

Total number of results
offset integer

Current offset for pagination
data array of object

List of maintenance events
data[].from string alwaysvždyvždymindig

Start datetime of maintenance (ISO 8601)
data[].to string alwaysvždyvždymindig

End datetime of maintenance (ISO 8601)
data[].type string alwaysvždyvždymindig

Type of maintenance (e.g. "scheduled_maintenance")

update_element Writes dataZapisuje dataZapisuje dátaAdatot ír

Changes an existing element: hides it from the output feed or shows it again (`is_hidden`), switches CDATA wrapping of its value (`output_cdata`), or renames it (`name`). Only the fields you pass are changed. Use to drop an element a channel does not want without deleting it - a hidden element stays in the project, so rules can still read and fill it. Only elements created by hand (`origin: manual`) can be renamed - Mergado refuses the rest (409), since an input element is named by the source feed. A rename also changes the element path every rule addresses it by, so check `list_project_rules` for rules using the old path and tell the user they will need updating. Hiding a parent does not hide its children. Moving an element, reordering it or turning it into an attribute is not possible here - each changes the element path and breaks the rules that use it; send the user to the Mergado UI. Changes show in the output feed after the next export. Get the user's consent first: hiding an element removes it from what their advertising channel receives.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the element to change. Get it from `list_project_elements`.
is_hidden boolean optionalvolitelnévoliteľnéválasztható

Optional. True leaves the element out of the output feed (rules can still work with it), false puts it back. Hiding a parent does not hide its children.
name string optionalvolitelnévoliteľnéválasztható

Optional. New element name - only for an element created by hand (`origin: manual`); Mergado refuses to rename the rest. It must be a valid XML name and unused among its siblings. Renaming changes the element path, so every rule using the old path stops finding it.
output_cdata boolean optionalvolitelnévoliteľnéválasztható

Optional. True writes the element's value into the output feed wrapped in CDATA, false writes it plain.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the element
name string

Element tag name on its own
parent_id string

ID of the parent element, or null for a top-level one
is_attribute boolean

True if this is an XML attribute of its parent
is_hidden boolean

True if the element is left out of the output feed
is_hidden_set_manually boolean

True if a person hid (or unhid) the element, rather than the import
output_cdata boolean

True if the element's value is written into the output feed wrapped in CDATA
origin string

Where the element came from: 'input', 'from_rule' or 'manual'
order integer

Position among its siblings

update_product Writes dataZapisuje dataZapisuje dátaAdatot ír

Makes a manual change to ONE product - the same two things the Mergado UI offers on a product: hide it (`is_hidden`) and set element values by hand (`manual_changes`). Use for a one-off fix of a single product (a wrong name, a price to override, a product to pull from the feed). For anything that applies to more than a handful of products, create a rule instead - manual values are per product and do not follow new products. `manual_changes` is merged into what the product already has: list only the paths to change, and pass `value: null` to remove a manual value so the rules' value comes back. The element path must exist in the project (`list_project_elements`, case-sensitive); a path matching several values changes the first - use `@@POSITION` for another. `manual_changes` in the answer lists every manual value the product holds, with the normalised path and `is_applied`. Nothing reaches the output feed at once: Mergado schedules a regeneration of the project itself, and until it finishes the changes read `is_applied: false`. A manual change belongs to the product, so it is lost if the next import replaces the product. Get the user's consent first - hiding a product pulls it from what their advertising channel receives.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the product to change. Get it from `list_project_products` or `query_products`.
is_hidden boolean optionalvolitelnévoliteľnéválasztható

Optional. True hides this product by hand - it is left out of the output feed whatever the rules say; false takes the manual hiding back. A product a hiding rule matches stays hidden either way. To hide a group of products, create a hiding rule instead.
manual_changes array optionalvolitelnévoliteľnéválasztható

Optional. Element values to set by hand, on top of what the rules compute. MERGED into what the product already holds: a path you do not list keeps its manual value, and each path may appear at most once per call. A manual value cannot be REMOVED here — the schema requires `value` to be a string and refuses null, and an empty string stores an empty value rather than giving the rules' value back. Removing one has to be done in the Mergado UI.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Product ID corresponding to pairing ID (stable identifier across feed updates)
output_changed_at string

ISO 8601 datetime when output data (after rules) last changed
updated_at string

ISO 8601 datetime when input data from feed last changed
project_id string

ID of the project the product is in
data object

Output product data (after applying all rules), as `{elements: {NAME: [{value, ...}]}, attributes: {...}}`. Empty when `values_to_extract` was used without `include_data` - read `extracted_values` then
extracted_values object

Values extracted from the requested element paths or variables, as path -> list of values (only present if `values_to_extract` was used)
is_hidden boolean

True if the product is left out of the output feed - because a hiding rule matches it, because it was hidden manually, or both
is_hidden_by_rule boolean

True if any hiding rule of the project matches the product
is_hidden_manually boolean

True if this product itself was hidden by hand (in the Mergado UI or the API)
manual_changes array of object

Element values set by hand for this one product, on top of what the rules compute
manual_changes[].element_path string alwaysvždyvždymindig

Element path the manual value belongs to, in the escaped and position-qualified form Mergado stores it in (which of the element's values it sets)
manual_changes[].value string alwaysvždyvždymindig

The value the element is forced to
manual_changes[].is_applied boolean

True once the value is in the output feed; false while it waits for the next regeneration of the project

update_project Writes dataZapisuje dataZapisuje dátaAdatot ír

Changes the settings of an existing project: its name, its source feed URL, whether newly imported products wait for authorization, and which shop it belongs to. Only the fields you pass are touched — everything else is left exactly as it is, so name the one thing the user asked to change rather than sending the project back in full. This tool cannot turn a project on or off; that is not exposed through MCP. If a project is turned off, say so and point the user to Mergado — do not present it as something you can switch. A turned-off project can still be renamed and given a new URL through this tool like any other. It also cannot change the input format, the output format or the pairing elements of an existing project. Those are settled by `create_project` and changing them afterwards needs Mergado support. A new `url` is validated before it is stored: Mergado fetches it and refuses one that answers 401, 403, 404, 408 or 5xx. It is used by the NEXT feed download — this does not start one, and the products in the project keep coming from the feed imported last. Get the user's explicit consent first: renaming and moving a project to another shop (which changes which shop is billed for it) are both changes their advertising channels can see.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the project to update. Get from `list_shop_projects`.
autohide_new_products boolean optionalvolitelnévoliteľnéválasztható

Optional. When true, products that appear in a later import wait for authorization instead of going straight into the output feed.
name string optionalvolitelnévoliteľnéválasztható

Optional. New project name, max 100 characters. Must be free among the active projects of the shop the project lives in - Mergado answers 409 if it is not.
shop_id string optionalvolitelnévoliteľnéválasztható

Optional. Moves the project to another shop, from `list_user_eshops`. Requires permission to manage that shop's projects and a free project name there. Ask the user before moving a project - it changes which shop is billed for it.
url string optionalvolitelnévoliteľnéválasztható

Optional. New source feed URL, using an http, https or sftp scheme. Mergado checks an http(s) URL before storing it and refuses one that answers 401, 403, 404, 408 or 5xx (422). The new URL is used by the NEXT feed download - updating it does not start one.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the project (export)
shop_id string alwaysvždyvždymindig

ID of the eshop this project belongs to
creator_id string

ID of the user who created this project
name string alwaysvždyvždymindig

Display name of the project
url string alwaysvždyvždymindig

URL of the source XML feed with products
created string

ISO 8601 datetime when the project was created
exported_items integer

Number of products exported in the last successful export
input_format string

Input format identifier (e.g. heureka.cz, zbozi.cz, google)
output_format string

Output format identifier for the transformed feed
pairing_elements array of string

Element paths used for product pairing/identification during feed synchronization
readonly boolean

True if project is being regenerated and modifications are locked. Product data may not be consistent during this state.
is_paused boolean

True if automatic scheduled rebuilds are temporarily disabled
rules_changed_at string

ISO 8601 datetime of the last rule creation, deletion, or update
slug string alwaysvždyvždymindig

Unique URL-safe identifier used in the output feed URL path
turned_off boolean

True if the project is completely disabled (no processing occurs)
update_period integer

Automatic update interval in seconds (e.g. 3600 for hourly, 86400 for daily)
last_access string

ISO 8601 datetime of last user access to this project
data_synced_at string

ISO 8601 datetime when the input feed was last successfully imported
data_updated_at string

ISO 8601 datetime when the project data was last modified by source feed changes
in_testing_mode boolean

True if project is in testing mode (export generation is disabled)
autohide_new_products boolean

True if newly imported products are hidden until somebody authorizes them
encoding string

Encoding the input feed is read with, or null when the import detects it from the feed (the usual case)
all_products_query_id string

ID of the ♥ALLPRODUCTS♥ query matching every product - the query to pass when a rule should apply to all products
number_of_elements integer

Number of elements defined in the project
metadata object

Additional project metadata (e.g. `stats_ga_source`)
sync_schedule object

When the project downloads its source feed
sync_schedule.minute string

Cron minute field, e.g. "50"
sync_schedule.hour string

Cron hour field, e.g. "*/1" for hourly
sync_schedule.day_of_week string

Cron day-of-week field
sync_schedule.day_of_month string

Cron day-of-month field
sync_schedule.month_of_year string

Cron month field

update_project_app Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

app_name string requiredpovinnépovinnékötelező

Name (ID) of the application
project_id string requiredpovinnépovinnékötelező

ID of the project
free_until string optionalvolitelnévoliteľnéválasztható

Trial expiration date (ISO 8601 format)
paid_until string optionalvolitelnévoliteľnéválasztható

Paid subscription expiration date (ISO 8601 format)

OutputVýstupVýstupKimenet

app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
free_until string

Trial expiration date (ISO 8601)
paid_until string

Paid subscription expiration date (ISO 8601)

update_query Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

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évoliteľnéválasztható

New name for the query
query string optionalvolitelnévoliteľnéválasztható

New MQL query expression replacing the existing one

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the query
project_id string alwaysvždyvždymindig

ID of the project this query belongs to
name string

Display name of the query
query string alwaysvždyvždymindig

Raw MQL query expression
advanced_interface boolean

True if query was created using advanced/raw MQL interface
read_only boolean

True if query cannot be modified (e.g. system queries like ♥ALLPRODUCTS♥)
search_output boolean

True to query output data (after rules), False to query input data
product_count integer

Number of products currently matching this query
created_at string alwaysvždyvždymindig

When the query was created (ISO 8601)

update_rule Writes dataZapisuje dataZapisuje dátaAdatot ír

Changes a rule in place — its name, note, configuration and schedule, and whether it is active (`applies`, to pause or resume it). Its position and its queries survive, unlike delete + recreate. Only the fields you send are touched, so omit the rest. Two of them REPLACE rather than merge: `data` is the rule's complete configuration and `schedule` the complete schedule — read the rule with `get_rule` first and send the whole object back with your change in it. `schedule` and `remove_schedule` cannot be combined: one replaces the schedule, the other clears it. What this cannot change: the rule's TYPE (build the other rule instead), its position (`reorder_rules`), and which products it targets (`assign_query_to_rule` / `retract_query_from_rule`). `format_converter` and `hiding` rules hold no configuration of their own; a rule with `is_editable: false` can only be renamed. Changes apply on the next rebuild and cannot be undone from here — say what you are about to change first.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

ID of the rule to change. Get it from `list_project_rules` or `get_rule`.
applies boolean optionalvolitelnévoliteľnéválasztható

Optional. False pauses the rule (it stays in place, fully configured, but is skipped), true resumes it. Omit it to leave the rule as it is.
data object optionalvolitelnévoliteľnéválasztható

Optional. The rule's complete new configuration - its shape depends on the rule type, and it REPLACES what is stored rather than merging into it, so send every field, not just the ones you are changing. Read the rule with `get_rule` first, change what you need in the `data` it returns, and pass the whole object back; it is checked against the schema of that rule type before anything is written. Omit it to leave the configuration alone.
name string optionalvolitelnévoliteľnéválasztható

Optional. New label for the rule, max 100 characters. Omit it to leave the name alone.
note string optionalvolitelnévoliteľnéválasztható

Optional. New internal note for the rule - it REPLACES the stored note. Pass an empty string to delete the note; omit it to leave the note alone.
remove_schedule boolean optionalvolitelnévoliteľnéválasztható

Optional. True deletes the rule's schedule, so it applies whenever the feed is processed again. Cannot be combined with `schedule`.
schedule object optionalvolitelnévoliteľnéválasztható

Optional. The complete new schedule limiting when the rule applies. It REPLACES the stored schedule as a whole - fields you leave out are reset, not kept - so read the rule with `get_rule` first and send its `schedule` back with your change. Omit it to leave the schedule alone; use `remove_schedule` to delete it.

OutputVýstupVýstupKimenet

rule object alwaysvždyvždymindig

The rule after the update, as the API returned it
rule.id string alwaysvždyvždymindig

Unique identifier of the rule
rule.project_id string alwaysvždyvždymindig

ID of the project this rule belongs to
rule.name string

Display name of the rule
rule.note string

Internal note about the rule (why it exists, what it is for), or null
rule.type string alwaysvždyvždymindig

Rule type identifier defining what transformation is performed
rule.element_path string

Target element path (optional, not all rule types require it)
rule.priority string | integer alwaysvždyvždymindig

Execution order priority (can be string or number)
rule.applies boolean

True if rule is active and will be executed
rule.is_deletable boolean

True if user is allowed to delete this rule
rule.is_movable boolean

True if user is allowed to change rule priority/position
rule.is_editable boolean

True if user is allowed to modify rule parameters
rule.is_pausable boolean

True if user is allowed to enable/disable the rule
rule.data object

Rule-specific parameters, or null for the types that take none (hiding, remove_diacritics, tagstripping)
rule.queries array of object

Queries selecting which products the rule applies to (each with `id`, `name`, `query`, `product_count`, ...)
rule.schedule object

When the rule is allowed to apply, or null when it has no schedule and applies whenever the feed is processed. A schedule only ever holds back a rule that would otherwise apply - it never makes a paused one (`applies: false`) apply.
rule.schedule.enabled boolean

False when the schedule is stored but has no effect
rule.schedule.date_from string

First day (inclusive) the weekday hours are in effect
rule.schedule.date_until string

Last day (inclusive) the weekday hours are in effect
rule.schedule.apply_before boolean

Whether the rule applies on days before `date_from`
rule.schedule.apply_after boolean

Whether the rule applies on days after `date_until`
rule.schedule.weekdays object

Hours (0-23) the rule applies at, keyed by ISO-8601 weekday ("1" = Monday ... "7" = Sunday)
changed array of string

Which fields this call actually changed - `name`, `note`, `data`, `schedule` and/or `applies`
message string

Human-readable summary of what changed

update_shop Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Shop ID to update. Get it from `list_user_eshops`.
name string optionalvolitelnévoliteľnéválasztható

New name for the shop
web string optionalvolitelnévoliteľnéválasztható

New website URL for the shop
xml_domain string optionalvolitelnévoliteľnéválasztható

XML domain for the shop

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the shop
owner_id string alwaysvždyvždymindig

ID of the user who owns this shop
name string alwaysvždyvždymindig

Display name of the shop
web string

Website URL of the eshop
xml_domain string

Domain detected from XML feed URLs
exported_items integer

Total sum of exported items across all projects
tariff_id string

ID of the active tariff/pricing plan
tariff_validity string

ISO 8601 datetime when tariff expires
created_at string

ISO 8601 datetime when the shop was created
permissions array of object

List of users and their access roles for this shop

update_shop_app Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

app_name string requiredpovinnépovinnékötelező

Name (ID) of the application
shop_id string requiredpovinnépovinnékötelező

ID of the shop
free_until string optionalvolitelnévoliteľnéválasztható

Trial expiration date (ISO 8601 format)
paid_until string optionalvolitelnévoliteľnéválasztható

Paid subscription expiration date (ISO 8601 format)

OutputVýstupVýstupKimenet

app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
free_until string

Trial expiration date (ISO 8601)
paid_until string

Paid subscription expiration date (ISO 8601)

update_user_app Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

app_name string requiredpovinnépovinnékötelező

Name (ID) of the application
user_id string requiredpovinnépovinnékötelező

ID of the user
free_until string optionalvolitelnévoliteľnéválasztható

Trial expiration date (ISO 8601 format)
paid_until string optionalvolitelnévoliteľnéválasztható

Paid subscription expiration date (ISO 8601 format)

OutputVýstupVýstupKimenet

app_name string alwaysvždyvždymindig

Name (ID) of the enabled app
free_until string

Trial expiration date (ISO 8601)
paid_until string

Paid subscription expiration date (ISO 8601)

update_variable Writes dataZapisuje dataZapisuje dátaAdatot ír

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í parametryVstupné parametreBemeneti paraméterek

id string requiredpovinnépovinnékötelező

Variable ID to update. Get it from `list_project_variables`.
name string optionalvolitelnévoliteľnéválasztható

New name for the variable. Will affect all references in rules and queries.

OutputVýstupVýstupKimenet

id string alwaysvždyvždymindig

Unique identifier of the variable
project_id string alwaysvždyvždymindig

ID of the project this variable belongs to
name string alwaysvždyvždymindig

Variable name used in rules (e.g. "price", "category")
element_path string alwaysvždyvždymindig

XPath to the element this variable extracts from
type string alwaysvždyvždymindig

Variable type
regular_expression string

Regex pattern to extract part of element value (e.g. domain from URL), null when the variable takes the element value whole
fragment_number integer

Capturing group number to extract from regex match (0 for entire match), null when no regex is set
sample_text string

Example text for testing the regex in UI
project_element_id string

ID of the project element the variable reads, when it is bound to one

workflow_element_paths_and_mql WorkflowWorkflowWorkflowWorkflow Read-onlyPouze čteníIba čítanieCsak olvasás

Call this before constructing element paths, product queries (MQL), or regular expressions. Provides syntax rules and reference guides for nested element paths (using | and conditions { }), MQL query operators and filtering logic (MQL is not SQL), input vs. output element mapping, PCRE regex capture groups, and best practices for diacritics and element value matching.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

text string

workflow_feed_diagnostics WorkflowWorkflowWorkflowWorkflow Read-onlyPouze čteníIba čítanieCsak olvasás

Call this when troubleshooting feed errors, data discrepancies, or advertising channel rejections (e.g. Google Merchant Center, Meta, Heureka). Provides step-by-step diagnostic workflows for common feed issues including zero product imports, unmatched data imports, missing attributes (GTIN, images, shipping), stale data, and interpreting Product Data Audit findings.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

text string

workflow_getting_oriented WorkflowWorkflowWorkflowWorkflow Read-onlyPouze čteníIba čítanieCsak olvasás

Call this at the start of a task before proposing or making changes, to safely explore and understand a Mergado project. Provides guidance on identifying feed formats, inspecting existing element structures and live values, mapping input vs. output elements, selecting stable pairing identifiers, and following safe workflow practices before executing modifications.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

text string

workflow_known_limitations WorkflowWorkflowWorkflowWorkflow Read-onlyPouze čteníIba čítanieCsak olvasás

Call this when encountering unexpected errors, timeouts, empty responses, or tool anomalies, and before executing complex workflows. Provides an up-to-date reference on known API and platform limitations, unsupported operations, edge-case behaviors, reliability guidelines, and recommended workarounds.

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

text string

workflow_platform_specs WorkflowWorkflowWorkflowWorkflow Read-onlyPouze čteníIba čítanieCsak olvasás

Call this when the user asks about a specific advertising channel or comparison engine (Google, Heureka, Zboží, GLAMI, Meta/Instagram, TikTok, Pinterest, Bing, Kelkoo, idealo, Ceneo, Skroutz, Árukereső, Favi, Biano) to get the link to its current official feed specification

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

text string

workflow_rules_cookbook WorkflowWorkflowWorkflowWorkflow Read-onlyPouze čteníIba čítanieCsak olvasás

Call this before creating or configuring product transformation rules in a project. Provides a comprehensive mapping of rule types to MCP tools, required rule parameters (element_path, priority, queries, applies), common transformation recipes, parameter path conventions, and safety checklists for destructive operations (e.g. Data File Import).

Input parametersVstupní parametryVstupné parametreBemeneti paraméterek

This tool takes no input parameters.Tento nástroj nemá žádné vstupní parametry.Tento nástroj nemá žiadne vstupné parametre.Ennek az eszköznek nincsenek bemeneti paraméterei.

OutputVýstupVýstupKimenet

text string

Mergado MCP Server

Getting StartedJak se připojitAko sa pripojiťElső lépések

AuthenticationAutentizaceAutentifikáciaHitelesítés

Bearer tokenBearer tokenBearer tokenBearer token

Server URLURL serveruURL serveraA szerver URL-je

Client SetupNastavení klientaNastavenie klientaA kliens beállítása

Admin-level (shared with all users)Admin úroveň (sdíleno se všemi uživateli)Admin úroveň (zdieľané so všetkými používateľmi)Admin szint (minden felhasználóval megosztva)

User-level (personal tools)Uživatelská úroveň (osobní nástroje)Používateľská úroveň (osobné nástroje)Felhasználói szint (személyes eszközök)

MCP InspectorMCP InspectorMCP InspectorMCP Inspector

PrerequisitesPožadavkyPožiadavkyKövetelmények

How to useJak používatAko používaťHasználata

Available toolsDostupné nástrojeDostupné nástrojeElérhető eszközök

Mergado MCP Server

Getting StartedJak se připojitAko sa pripojiťElső lépések

AuthenticationAutentizaceAutentifikáciaHitelesítés

Sign in through your client (Recommended)Přihlášení přes klienta (doporučeno)Prihlásenie cez klienta (odporúčané)Bejelentkezés a kliensen keresztül (ajánlott)

Bearer tokenBearer tokenBearer tokenBearer token

Server URLURL serveruURL serveraA szerver URL-je

Client SetupNastavení klientaNastavenie klientaA kliens beállítása

Admin-level (shared with all users)Admin úroveň (sdíleno se všemi uživateli)Admin úroveň (zdieľané so všetkými používateľmi)Admin szint (minden felhasználóval megosztva)

User-level (personal tools)Uživatelská úroveň (osobní nástroje)Používateľská úroveň (osobné nástroje)Felhasználói szint (személyes eszközök)

MCP InspectorMCP InspectorMCP InspectorMCP Inspector

PrerequisitesPožadavkyPožiadavkyKövetelmények

How to useJak používatAko používaťHasználata

Available toolsDostupné nástrojeDostupné nástrojeElérhető eszközök