Документация/Справочник методов MCP X-MP

Руководство по работе с магазином

Справочник методов MCP X-MP

Именованные методы, параметры, типы, обязательность, ограничения и схемы опубликованного клиента. Читайте вместе с руководством нужного сервиса.

Зачем это нужно

Справочник помогает точно составить запрос и понять назначение результата. Поля и имена сверены с клиентом. Сервисные руководства объясняют смысл данных, алгоритм и ограничения, а этот раздел фиксирует формальный интерфейс.

Пример из работы магазина

Задача → руководство → метод → параметры → вызов → проверка результата и качества.

Как начать

Проверьте tools/list своей сессии и capabilities.list.
Выберите метод и изучите руководство его сервиса.
Передавайте только допустимые поля; типы идентификаторов не взаимозаменяемы.
Следуйте пагинации и проверяйте качество, а не только успешность вызова.

Что вы получите

Однозначный запрос по проверенной схеме и понимание того, что делает инструмент.

Что важно учитывать

Контракт проверен по клиенту 0.34.0 на 08.09.2026. Сервер дополнительно проверяет права, период, сочетания параметров и готовность. Наличие схемы не разрешает действие.

Идентификаторы, единицы и версии

Понятие	Правило
nm_id / nm_ids	Артикул WB. Тип различается по методу: строка либо integer.
product_id	Внутренний UUID товара.
target_ids	В pricing — nmID, в advertising — campaign ID.
card_id / job_id / plan_id / artifact_id	Задача памяти, запуск, план и файл — разные ID из соответствующих ответов.
date_from / date_to	Включённые даты; смысл события или наблюдения зависит от метода.
idempotency_key	Стабильный ключ одной логической операции. Новое намерение — новый ключ.
expected_config_sha256	Последняя прочитанная контрольная сумма для безопасного обновления.
null	Неопределённое значение, не ноль.
Доли / проценты	target_drr=0.18 означает 18%; max_step_percent=10 означает 10%.
Рубли / копейки	Суффиксы _rub и _kopecks задают разные единицы.

Таблицы показывают вложенные поля; их обязательность действует при передаче родительского объекта. JSON Schema раскрывается отдельно и сохраняет точные типы. Методы без параметров получают arguments={}.

Методы и параметры

Параметры ниже относятся к MCP arguments. Идентичность и ключ не передаются в них. Для полного объекта config следуйте руководству домена.

agent.me capabilities.list readiness.get xmp.services.list tasks.resume monitor.history monitor.snapshot monitor.media collection.sources collection.history collection.access collection.records collection.artifacts collection.artifact.download monitor.status monitor.timeline monitor.series analysis.query metrics.catalog metrics.status metrics.completeness metrics.query dataset.query dataset.export repricer.config.validate repricer.plan repricer.plan.get repricer.reconcile automations.templates.list automations.catalog automations.policy.validate automations.policy.plan automations.operation.plan.register automations.operation.plan.get automations.credentials.requirements automations.status automations.config.get automations.config.apply automations.shadow.run automations.runs.list automations.jobs.create automations.jobs.get automations.jobs.list automations.emergency-stop automations.reviews.catalog automations.reviews.prepare monitor.compare datasets.list cabinet.overview product.360 finance.summary memory.context xmp.client.instructions xmp.update.check xmp.update.apply xmp.client.doctor notifications.history notifications.settings.get notifications.settings.update reports.list reports.create reports.run reports.schedule reports.status reports.result

`agent.me`

Проверить личность, привязанный магазин и права подключения.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`capabilities.list`

Получить эффективные возможности; наличие метода в клиенте не заменяет проверку прав.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`readiness.get`

Проверить состояние магазина и свежесть данных.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`xmp.services.list`

Получить сервисы и их режимы для текущего подключения.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`tasks.resume`

Прочитать актуальную версию существующей задачи и рабочий контекст.

Параметр	Тип	Обязателен	Назначение и ограничения
card_id	строка	да	Задача Seller Memory; возьмите реальный UUID. формат: "uuid"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "card_id"
  ],
  "properties": {
    "card_id": {
      "type": "string",
      "format": "uuid"
    }
  }
}

`monitor.history`

Найти изменения по тегу, полю и источнику; полный before/after требует limit=1.

Параметр	Тип	Обязателен	Назначение и ограничения
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода.
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода.
tag	строка	нет	Тег изменения из доступной истории.
field	строка	нет	Путь конкретного параметра; выбирается по данным истории.
source	строка	нет	Фильтр источника наблюдения.
cursor	строка	нет	Непрозрачный курсор продолжения с теми же фильтрами.
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50
detail	строка	нет	Краткие данные либо полный снимок; full у истории требует limit=1. варианты: ["summary", "full"]
nm_ids	массив	нет	Список артикулов WB в пределах выбранного магазина. не более элементов: 20
include_baseline	да/нет	нет	Включить первоначальные базовые снимки, не только изменения.

Точная JSON Schema

{
  "type": "object",
  "properties": {
    "date_from": {
      "type": "string"
    },
    "date_to": {
      "type": "string"
    },
    "tag": {
      "type": "string"
    },
    "field": {
      "type": "string"
    },
    "source": {
      "type": "string"
    },
    "cursor": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "detail": {
      "type": "string",
      "enum": [
        "summary",
        "full"
      ]
    },
    "nm_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20
    },
    "include_baseline": {
      "type": "boolean"
    }
  },
  "required": [
    "date_from",
    "date_to"
  ],
  "additionalProperties": false
}

`monitor.snapshot`

Прочитать компоненты товара на момент или по snapshot_id; полный detail требует limit=1.

Параметр	Тип	Обязателен	Назначение и ограничения
snapshot_id	строка	нет	Точный ID сохранённого снимка из ответа.
at	строка	нет	Момент времени с часовым поясом для восстановления снимка.
component	строка	нет	Сохранённый компонент товара.
source	строка	нет	Фильтр источника наблюдения.
field	строка	нет	Путь конкретного параметра; выбирается по данным истории.
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50
detail	строка	нет	Краткие данные либо полный снимок; full у истории требует limit=1. варианты: ["summary", "full"]
nm_id	целое	да	Артикул WB; соблюдайте тип именно этого метода. минимум: 1
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0

Точная JSON Schema

{
  "type": "object",
  "properties": {
    "snapshot_id": {
      "type": "string"
    },
    "at": {
      "type": "string"
    },
    "component": {
      "type": "string"
    },
    "source": {
      "type": "string"
    },
    "field": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "detail": {
      "type": "string",
      "enum": [
        "summary",
        "full"
      ]
    },
    "nm_id": {
      "type": "integer",
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "nm_id"
  ],
  "additionalProperties": false
}

`monitor.media`

Прочитать часть изображения до256KiB; продолжать next_offset, проверить полный hash.

Параметр	Тип	Обязателен	Назначение и ограничения
media_id	строка	да	Идентификатор сохранённого изображения.
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0

Точная JSON Schema

{
  "type": "object",
  "properties": {
    "media_id": {
      "type": "string"
    },
    "offset": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "media_id"
  ],
  "additionalProperties": false
}

`collection.sources`

Перечислить сохранённые источники и record_sets; включает пустые/ошибочные источники.

Параметр	Тип	Обязателен	Назначение и ограничения
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0; максимум: 10000

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    }
  },
  "required": []
}

`collection.history`

Прочитать историю сбора по дням и методам за период до31 дня.

Параметр	Тип	Обязателен	Назначение и ограничения
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "date_from",
    "date_to"
  ]
}

`collection.access`

Прочитать сохранённую диагностику доступа без нового запроса WB.

Параметр	Тип	Обязателен	Назначение и ограничения
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0; максимум: 10000

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    }
  },
  "required": []
}

`collection.records`

Прочитать текущие записи или версии; entity и kind берутся из collection.sources.

Параметр	Тип	Обязателен	Назначение и ограничения
entity	строка	да	Наблюдаемое имя сущности из collection.sources/record_sets. шаблон: "^[a-zA-Z0-9_.-]{1,128}$"
kind	строка	нет	Вид записи или файла; допустимые варианты зависят от метода. варианты: ["entity", "fact", "product"]
current_only	да/нет	нет	Только актуальные записи либо сохранённая история версий. по умолчанию: true
after	строка	нет	UUID последней записи для продолжения next_after. формат: "uuid"
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20
fields	массив	нет	Имена выбранных полей; допустимые имена зависят от набора. не менее элементов: 1; не более элементов: 20
date_from	строка	нет	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	нет	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "entity": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9_.-]{1,128}$"
    },
    "kind": {
      "type": "string",
      "enum": [
        "entity",
        "fact",
        "product"
      ]
    },
    "current_only": {
      "type": "boolean",
      "default": true
    },
    "after": {
      "type": "string",
      "format": "uuid"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 20
    },
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    }
  },
  "required": [
    "entity"
  ]
}

`collection.artifacts`

Найти метаданные исходных ответов или зарегистрированных бизнес-файлов.

Параметр	Тип	Обязателен	Назначение и ограничения
kind	строка	нет	Вид записи или файла; допустимые варианты зависят от метода. варианты: ["raw", "business"]
entity	строка	нет	Наблюдаемое имя сущности из collection.sources/record_sets.
method_id	строка	нет	Фильтр по зарегистрированному методу источника.
date_from	строка	нет	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	нет	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"
after	строка	нет	UUID последней записи для продолжения next_after. формат: "uuid"
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "raw",
        "business"
      ]
    },
    "entity": {
      "type": "string"
    },
    "method_id": {
      "type": "string"
    },
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    },
    "after": {
      "type": "string",
      "format": "uuid"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    }
  },
  "required": []
}

`collection.artifact.download`

Скачать один артефакт в приватную .xmp/data, проверить размер и SHA-256; вернуть путь.

Параметр	Тип	Обязателен	Назначение и ограничения
artifact_id	строка	да	Идентификатор файла из каталога артефактов. формат: "uuid"
kind	строка	нет	Вид записи или файла; допустимые варианты зависят от метода. по умолчанию: "raw"; варианты: ["raw", "business"]
max_bytes	целое	нет	Верхняя граница размера скачивания или экспорта в байтах. минимум: 1; максимум: 134217728; по умолчанию: 10485760

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "artifact_id": {
      "type": "string",
      "format": "uuid"
    },
    "kind": {
      "type": "string",
      "enum": [
        "raw",
        "business"
      ],
      "default": "raw"
    },
    "max_bytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 134217728,
      "default": 10485760
    }
  },
  "required": [
    "artifact_id"
  ]
}

`monitor.status`

Проверить состояние и покрытие мониторинга.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "required": [],
  "additionalProperties": false
}

`monitor.timeline`

Прочитать события по типу и товарам; baseline скрыт по умолчанию.

Параметр	Тип	Обязателен	Назначение и ограничения
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода.
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода.
nm_ids	массив	нет	Список артикулов WB в пределах выбранного магазина. не более элементов: 20
event_type	строка	нет	Тип сохранённого события. варианты: ["baseline", "source_gap", "card", "photos", "price", "stock", "supply", "advertising", "rating", "reviews"]
object_type	строка	нет	Тип наблюдаемого объекта. варианты: ["store", "product", "competitor"]
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50
cursor	строка	нет	Непрозрачный курсор продолжения с теми же фильтрами.
include_baseline	да/нет	нет	Включить первоначальные базовые снимки, не только изменения. по умолчанию: false
detail	строка	нет	Краткие данные либо полный снимок; full у истории требует limit=1. по умолчанию: "summary"; варианты: ["summary", "full"]

Точная JSON Schema

{
  "type": "object",
  "properties": {
    "date_from": {
      "type": "string"
    },
    "date_to": {
      "type": "string"
    },
    "nm_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20
    },
    "event_type": {
      "type": "string",
      "enum": [
        "baseline",
        "source_gap",
        "card",
        "photos",
        "price",
        "stock",
        "supply",
        "advertising",
        "rating",
        "reviews"
      ]
    },
    "object_type": {
      "type": "string",
      "enum": [
        "store",
        "product",
        "competitor"
      ]
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "cursor": {
      "type": "string"
    },
    "include_baseline": {
      "type": "boolean",
      "default": false
    },
    "detail": {
      "type": "string",
      "enum": [
        "summary",
        "full"
      ],
      "default": "summary"
    }
  },
  "required": [
    "date_from",
    "date_to"
  ],
  "additionalProperties": false
}

`monitor.series`

Получить временной ряд одного разрешённого показателя или количества событий.

Параметр	Тип	Обязателен	Назначение и ограничения
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода.
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода.
nm_ids	массив	нет	Список артикулов WB в пределах выбранного магазина. не более элементов: 20
event_type	строка	нет	Тип сохранённого события. варианты: ["baseline", "source_gap", "card", "photos", "price", "stock", "supply", "advertising", "rating", "reviews"]
object_type	строка	нет	Тип наблюдаемого объекта. варианты: ["store", "product", "competitor"]
group_by	строка	нет	Группировка данных; проверяйте разрешённые варианты. варианты: ["account", "product"]
metric	строка	нет	Один показатель временного ряда. варианты: ["events", "rating", "reviews", "public_price_min_rub", "public_price_max_rub", "amount", "discountedPrice_min"]

Точная JSON Schema

{
  "type": "object",
  "properties": {
    "date_from": {
      "type": "string"
    },
    "date_to": {
      "type": "string"
    },
    "nm_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 20
    },
    "event_type": {
      "type": "string",
      "enum": [
        "baseline",
        "source_gap",
        "card",
        "photos",
        "price",
        "stock",
        "supply",
        "advertising",
        "rating",
        "reviews"
      ]
    },
    "object_type": {
      "type": "string",
      "enum": [
        "store",
        "product",
        "competitor"
      ]
    },
    "group_by": {
      "type": "string",
      "enum": [
        "account",
        "product"
      ]
    },
    "metric": {
      "type": "string",
      "enum": [
        "events",
        "rating",
        "reviews",
        "public_price_min_rub",
        "public_price_max_rub",
        "amount",
        "discountedPrice_min"
      ]
    }
  },
  "required": [
    "date_from",
    "date_to"
  ],
  "additionalProperties": false
}

`analysis.query`

Рассчитать агрегаты и коэффициенты по магазину, товарам и дням с признаками качества.

Параметр	Тип	Обязателен	Назначение и ограничения
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"
group_by	строка	нет	Группировка данных; проверяйте разрешённые варианты. по умолчанию: "product"; варианты: ["account", "day", "product", "day_product"]
metrics	массив	нет	Список выбранных показателей; разные сервисы имеют собственный каталог. не менее элементов: 1; не более элементов: 12; по умолчанию: ["ordered_gmv", "sales_gmv", "ad_spend", "cancelled_units"]
nm_ids	массив	нет	Список артикулов WB в пределах выбранного магазина. не более элементов: 20
sort_by	строка	нет	Выбранный показатель для сортировки; должен присутствовать в запросе. по умолчанию: "ordered_gmv"; шаблон: "^[a-z][a-z0-9_]{1,63}$"
sort_direction	строка	нет	Направление сортировки. по умолчанию: "desc"; варианты: ["asc", "desc"]
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0; максимум: 10000; по умолчанию: 0
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "date_from",
    "date_to"
  ],
  "properties": {
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    },
    "group_by": {
      "type": "string",
      "enum": [
        "account",
        "day",
        "product",
        "day_product"
      ],
      "default": "product"
    },
    "metrics": {
      "type": "array",
      "minItems": 1,
      "maxItems": 12,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "ordered_units",
          "ordered_gmv",
          "cancelled_units",
          "sales_gmv",
          "ad_spend",
          "ad_clicks",
          "ad_orders",
          "wb_for_pay",
          "contribution_profit",
          "stock_units",
          "opens",
          "carts",
          "ad_impressions",
          "funnel_orders",
          "average_ordered_unit_price",
          "cpm",
          "ad_spend_to_ordered_gmv",
          "ad_spend_per_ordered_unit",
          "operational_contribution_margin",
          "average_order_value",
          "cancelled_order_share",
          "ad_ctr",
          "cpc",
          "cpo",
          "cart_cr",
          "order_cr",
          "cart_to_order_cr"
        ]
      },
      "default": [
        "ordered_gmv",
        "sales_gmv",
        "ad_spend",
        "cancelled_units"
      ]
    },
    "nm_ids": {
      "type": "array",
      "maxItems": 20,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[0-9]{1,20}$"
      }
    },
    "sort_by": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{1,63}$",
      "default": "ordered_gmv"
    },
    "sort_direction": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "default": "desc"
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000,
      "default": 0
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    }
  }
}

`metrics.catalog`

Прочитать определения KPI: формулы, входы, единицы, детализацию и зрелость.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`metrics.status`

Проверить последнюю сборку метрик и пробелы покрытия.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`metrics.completeness`

Получить матрицу достаточности определений, свежесть и недостающие входы.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`metrics.query`

Прочитать значения зарегистрированных KPI по периоду и измерениям.

Параметр	Тип	Обязателен	Назначение и ограничения
metric_ids	массив	да	Список выбранных показателей; разные сервисы имеют собственный каталог. не менее элементов: 1; не более элементов: 50
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"
grain	строка	нет	Зарегистрированный уровень детализации метрики. шаблон: "^[a-z][a-z0-9_]{1,63}$"
product_id	строка	нет	Внутренний UUID товара; отличается от артикула WB. формат: "uuid"
nm_id	целое	нет	Артикул WB; соблюдайте тип именно этого метода. минимум: 1
campaign_id	целое	нет	Идентификатор рекламной кампании. минимум: 1
warehouse_id	строка	нет	Идентификатор склада из доступного источника. не менее символов: 1; не более символов: 128
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0; максимум: 1000000; по умолчанию: 0

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "metric_ids",
    "date_from",
    "date_to"
  ],
  "properties": {
    "metric_ids": {
      "type": "array",
      "minItems": 1,
      "maxItems": 50,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]{1,63}$"
      }
    },
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    },
    "grain": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{1,63}$"
    },
    "product_id": {
      "type": "string",
      "format": "uuid"
    },
    "nm_id": {
      "type": "integer",
      "minimum": 1
    },
    "campaign_id": {
      "type": "integer",
      "minimum": 1
    },
    "warehouse_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000,
      "default": 0
    }
  }
}

`dataset.query`

Прочитать страницу нормализованных строк с выбранными полями, без raw payload.

Параметр	Тип	Обязателен	Назначение и ограничения
dataset_key	строка	да	Зарегистрированное имя набора из datasets.list. шаблон: "^[a-z][a-z0-9_-]{1,127}$"
fields	массив	нет	Имена выбранных полей; допустимые имена зависят от набора. не менее элементов: 1; не более элементов: 16
nm_ids	массив	нет	Список артикулов WB в пределах выбранного магазина. не более элементов: 20
date_from	строка	нет	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	нет	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 50; по умолчанию: 20
offset	целое	нет	Смещение следующей страницы либо байтов медиа; используйте значение ответа. минимум: 0; максимум: 10000; по умолчанию: 0

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "dataset_key"
  ],
  "properties": {
    "dataset_key": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_-]{1,127}$"
    },
    "fields": {
      "type": "array",
      "minItems": 1,
      "maxItems": 16,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[a-z][a-z0-9_]*$"
      }
    },
    "nm_ids": {
      "type": "array",
      "maxItems": 20,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[0-9]{1,19}$"
      }
    },
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 20
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000,
      "default": 0
    }
  }
}

`dataset.export`

Сохранить ограниченный нормализованный набор в приватный JSONL и manifest.

Параметр	Тип	Обязателен	Назначение и ограничения
dataset_key	строка	да	Зарегистрированное имя набора из datasets.list. шаблон: "^[a-z][a-z0-9_-]{1,127}$"
max_rows	целое	нет	Верхняя граница числа экспортируемых строк. минимум: 1; максимум: 100000; по умолчанию: 10000
max_bytes	целое	нет	Верхняя граница размера скачивания или экспорта в байтах. минимум: 1024; максимум: 52428800; по умолчанию: 10485760

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "dataset_key"
  ],
  "properties": {
    "dataset_key": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_-]{1,127}$"
    },
    "max_rows": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000,
      "default": 10000
    },
    "max_bytes": {
      "type": "integer",
      "minimum": 1024,
      "maximum": 52428800,
      "default": 10485760
    }
  }
}

`repricer.config.validate`

Проверить конфигурацию v2 и получить effective config и критерии привязки к памяти.

Параметр	Тип	Обязателен	Назначение и ограничения
config	объект	да	Полная конфигурация по руководству соответствующего домена, без секретов и caller scope.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "config"
  ],
  "properties": {
    "config": {
      "type": "object"
    }
  }
}

`repricer.plan`

Подготовить точный ценовой план и approval_url без отправки цен.

Параметр	Тип	Обязателен	Назначение и ограничения
target_ids	массив	да	Для ценового плана — артикулы; для рекламного профиля — кампании. не менее элементов: 1; не более элементов: 5
idempotency_key	строка	да	Стабильный ключ одной логической операции; при повторе сохраняйте его. не менее символов: 8; не более символов: 128

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "target_ids",
    "idempotency_key"
  ],
  "properties": {
    "target_ids": {
      "type": "array",
      "minItems": 1,
      "maxItems": 5,
      "items": {
        "type": "string",
        "pattern": "^[0-9]+$"
      }
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 128
    }
  }
}

`repricer.plan.get`

Прочитать план и состояние его исполнения.

Параметр	Тип	Обязателен	Назначение и ограничения
plan_id	строка	да	Идентификатор плана из ответа соответствующего метода.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string"
    }
  }
}

`repricer.reconcile`

Проверить загрузку WB и фактические цены, сохранить проверку; повторной отправки нет.

Параметр	Тип	Обязателен	Назначение и ограничения
plan_id	строка	да	Идентификатор плана из ответа соответствующего метода.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string"
    }
  }
}

`automations.templates.list`

Получить шаблоны предварительных расчётов и планов.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`automations.catalog`

Прочитать каталог пакетов и контракт биддера.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`automations.policy.validate`

Проверить структурированные условия; не запускает и не планирует работу.

Параметр	Тип	Обязателен	Назначение и ограничения
policy	объект	да	Структурированные условия поручения; не исполнимая произвольная программа.
policy.schema_version	значение	нет	Версия формата условий. только: 1
policy.domain	значение	нет	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "advertising-budget", "card-experiment", "catalog", "custom", "inventory-fbs", "pricing", "reputation", "supplies"]
policy.objective	строка	нет	Описание ожидаемого бизнес-результата. не менее символов: 1; не более символов: 1000
policy.mode	значение	нет	Режим работы в пределах разрешённых возможностей. варианты: ["observe", "shadow"]
policy.algorithm_id	строка	нет	Выбранный поддержанный алгоритм. шаблон: "^[a-z][a-z0-9_.-]{1,127}$"
policy.trigger	объект	нет	Условие запуска по контракту шаблона.
policy.targets	объект	нет	Для ценового плана — артикулы; для рекламного профиля — кампании.
policy.guardrails	объект	нет	Ограничения действий, не отменяющие системные пределы.
policy.domain_settings	объект	нет	Настройки выбранного домена по его контракту.
policy.evidence_refs	массив	нет	Непустые ссылки на основания и происхождение. не более элементов: 50

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "policy"
  ],
  "properties": {
    "policy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "schema_version": {
          "const": 1
        },
        "domain": {
          "enum": [
            "advertising",
            "advertising-budget",
            "card-experiment",
            "catalog",
            "custom",
            "inventory-fbs",
            "pricing",
            "reputation",
            "supplies"
          ]
        },
        "objective": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000
        },
        "mode": {
          "enum": [
            "observe",
            "shadow"
          ]
        },
        "algorithm_id": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_.-]{1,127}$"
        },
        "trigger": {
          "type": "object"
        },
        "targets": {
          "type": "object"
        },
        "guardrails": {
          "type": "object"
        },
        "domain_settings": {
          "type": "object"
        },
        "evidence_refs": {
          "type": "array",
          "maxItems": 50,
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

`automations.policy.plan`

Сохранить локальный неизменяемый план условий; WB не меняется.

Параметр	Тип	Обязателен	Назначение и ограничения
idempotency_key	строка	да	Стабильный ключ одной логической операции; при повторе сохраняйте его. шаблон: "^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$"
policy	объект	да	Структурированные условия поручения; не исполнимая произвольная программа.
policy.schema_version	значение	нет	Версия формата условий. только: 1
policy.domain	значение	нет	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "advertising-budget", "card-experiment", "catalog", "custom", "inventory-fbs", "pricing", "reputation", "supplies"]
policy.objective	строка	нет	Описание ожидаемого бизнес-результата. не менее символов: 1; не более символов: 1000
policy.mode	значение	нет	Режим работы в пределах разрешённых возможностей. варианты: ["observe", "shadow"]
policy.algorithm_id	строка	нет	Выбранный поддержанный алгоритм. шаблон: "^[a-z][a-z0-9_.-]{1,127}$"
policy.trigger	объект	нет	Условие запуска по контракту шаблона.
policy.targets	объект	нет	Для ценового плана — артикулы; для рекламного профиля — кампании.
policy.guardrails	объект	нет	Ограничения действий, не отменяющие системные пределы.
policy.domain_settings	объект	нет	Настройки выбранного домена по его контракту.
policy.evidence_refs	массив	нет	Непустые ссылки на основания и происхождение. не более элементов: 50

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "idempotency_key",
    "policy"
  ],
  "properties": {
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$"
    },
    "policy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "schema_version": {
          "const": 1
        },
        "domain": {
          "enum": [
            "advertising",
            "advertising-budget",
            "card-experiment",
            "catalog",
            "custom",
            "inventory-fbs",
            "pricing",
            "reputation",
            "supplies"
          ]
        },
        "objective": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000
        },
        "mode": {
          "enum": [
            "observe",
            "shadow"
          ]
        },
        "algorithm_id": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_.-]{1,127}$"
        },
        "trigger": {
          "type": "object"
        },
        "targets": {
          "type": "object"
        },
        "guardrails": {
          "type": "object"
        },
        "domain_settings": {
          "type": "object"
        },
        "evidence_refs": {
          "type": "array",
          "maxItems": 50,
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

`automations.operation.plan.register`

Зарегистрировать digest и приватную ссылку общего плана; не исполняет операцию.

Параметр	Тип	Обязателен	Назначение и ограничения
plan_id	строка	да	Идентификатор плана из ответа соответствующего метода. шаблон: "^operation-plan-[a-f0-9]{24}$"
plan_sha256	строка	да	Контрольная сумма точного зарегистрированного плана. шаблон: "^[a-f0-9]{64}$"
capability	значение	да	Зарегистрированная возможность, для которой подготовлен план. варианты: ["advertising.apply_actions", "pricing.apply_actions", "catalog.apply_content_actions", "communication.send_replies"]
artifact_ref	строка	да	Приватная ссылка на артефакт плана, не произвольный URL хранилища. шаблон: "^operations-artifact://[^\\s]{1,240}$"
effect_ceiling	значение	да	Предельный эффект плана; не включает исполнение. варианты: ["shadow", "approval-required"]
expires_at	строка	да	Срок действия с часовым поясом. формат: "date-time"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "plan_id",
    "plan_sha256",
    "capability",
    "artifact_ref",
    "effect_ceiling",
    "expires_at"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "pattern": "^operation-plan-[a-f0-9]{24}$"
    },
    "plan_sha256": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$"
    },
    "capability": {
      "enum": [
        "advertising.apply_actions",
        "pricing.apply_actions",
        "catalog.apply_content_actions",
        "communication.send_replies"
      ]
    },
    "artifact_ref": {
      "type": "string",
      "pattern": "^operations-artifact://[^\\s]{1,240}$"
    },
    "effect_ceiling": {
      "enum": [
        "shadow",
        "approval-required"
      ]
    },
    "expires_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

`automations.operation.plan.get`

Прочитать общий план и статус согласования; для исполнения цен есть отдельный путь репрайсера.

Параметр	Тип	Обязателен	Назначение и ограничения
plan_id	строка	да	Идентификатор плана из ответа соответствующего метода. шаблон: "^operation-plan-[a-f0-9]{24}$"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "pattern": "^operation-plan-[a-f0-9]{24}$"
    }
  }
}

`automations.credentials.requirements`

Узнать права X-MP и категории WB-ключей для домена без значений секретов.

Параметр	Тип	Обязателен	Назначение и ограничения
domain	значение	да	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "advertising-budget", "card-experiment", "catalog", "custom", "inventory-fbs", "pricing", "reputation", "supplies"]

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "enum": [
        "advertising",
        "advertising-budget",
        "card-experiment",
        "catalog",
        "custom",
        "inventory-fbs",
        "pricing",
        "reputation",
        "supplies"
      ]
    }
  }
}

`automations.status`

Прочитать состояние связанных рабочих доменов магазина.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false
}

`automations.config.get`

Прочитать конфигурацию и её контрольную сумму перед обновлением.

Параметр	Тип	Обязателен	Назначение и ограничения
domain	значение	да	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "pricing", "catalog", "responder"]

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "enum": [
        "advertising",
        "pricing",
        "catalog",
        "responder"
      ]
    }
  }
}

`automations.config.apply`

Проверить и сохранить полный observe/shadow config; включение биддера запускает расчёты, а не WB execution.

Параметр	Тип	Обязателен	Назначение и ограничения
domain	значение	да	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "pricing", "catalog", "responder"]
config	объект	да	Полная конфигурация по руководству соответствующего домена, без секретов и caller scope.
idempotency_key	строка	да	Стабильный ключ одной логической операции; при повторе сохраняйте его. шаблон: "^[A-Za-z0-9][A-Za-z0-9_.:-]{7,127}$"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "domain",
    "config",
    "idempotency_key"
  ],
  "properties": {
    "domain": {
      "enum": [
        "advertising",
        "pricing",
        "catalog",
        "responder"
      ]
    },
    "config": {
      "type": "object",
      "minProperties": 1
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{7,127}$"
    }
  }
}

`automations.shadow.run`

Выполнить один предварительный расчёт и сохранить отчёт без изменений WB.

Параметр	Тип	Обязателен	Назначение и ограничения
domain	значение	да	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "pricing", "catalog", "responder"]
idempotency_key	строка	да	Стабильный ключ одной логической операции; при повторе сохраняйте его. шаблон: "^[A-Za-z0-9][A-Za-z0-9_.:-]{7,127}$"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "domain",
    "idempotency_key"
  ],
  "properties": {
    "domain": {
      "enum": [
        "advertising",
        "pricing",
        "catalog",
        "responder"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{7,127}$"
    }
  }
}

`automations.runs.list`

Прочитать ограниченную историю запусков домена.

Параметр	Тип	Обязателен	Назначение и ограничения
domain	значение	да	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "pricing", "catalog", "responder"]
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 100

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "enum": [
        "advertising",
        "pricing",
        "catalog",
        "responder"
      ]
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}

`automations.jobs.create`

Поставить один расчёт в очередь и получить job_id.

Параметр	Тип	Обязателен	Назначение и ограничения
domain	значение	да	Рабочий домен: цены, реклама, контент или ответы. варианты: ["advertising", "pricing", "catalog", "responder"]
idempotency_key	строка	да	Стабильный ключ одной логической операции; при повторе сохраняйте его. шаблон: "^[A-Za-z0-9][A-Za-z0-9_.:-]{7,127}$"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "domain",
    "idempotency_key"
  ],
  "properties": {
    "domain": {
      "enum": [
        "advertising",
        "pricing",
        "catalog",
        "responder"
      ]
    },
    "idempotency_key": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{7,127}$"
    }
  }
}

`automations.jobs.get`

Прочитать состояние и полный результат задачи очереди, включая review_cases.

Параметр	Тип	Обязателен	Назначение и ограничения
job_id	строка	да	Идентификатор задачи очереди из jobs.create/list. формат: "uuid"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "format": "uuid"
    }
  }
}

`automations.jobs.list`

Прочитать ограниченный список задач очереди магазина.

Параметр	Тип	Обязателен	Назначение и ограничения
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 100; по умолчанию: 20

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20
    }
  }
}

`automations.emergency-stop`

Установить аварийную остановку контроллеров X-MP; не обещает остановить кампании непосредственно в WB.

Параметр	Тип	Обязателен	Назначение и ограничения
reason	строка	да	Причина остановки или изменения состояния. не менее символов: 1; не более символов: 500

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  }
}

`automations.reviews.catalog`

Получить сервисы отзывов, ограничения и prepare_schema.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`automations.reviews.prepare`

Проверить параметры и собрать несохранённый draft-only config; модель не вызывается.

Параметр	Тип	Обязателен	Назначение и ограничения
config_id	строка	да	Идентификатор версии конфигурации. шаблон: "^[A-Za-z0-9][A-Za-z0-9_.-]{1,127}$"
service_id	строка	да	Провайдер блока отзывов; native реализован, внешние требуют интеграции. не менее символов: 1; не более символов: 64
generation	строка	да	Шаблон либо подготовленный агентом черновик. варианты: ["template", "agent-draft"]
model_ref	строка	нет	Происхождение агентского черновика, не выбор/вызов модели. шаблон: "^[A-Za-z0-9][A-Za-z0-9_.:-]{1,127}$"
memory_binding	объект	да	Ссылки на явно прочитанные правила и задачу магазина.
memory_binding.instructions_ref	строка	да	Ссылка на версию правил памяти. шаблон: "^(?:memory\|task\|artifact\|task-revision\|memory-revision)://[A-Za-z0-9][A-Za-z0-9_./:@-]{1,255}$"
memory_binding.task_ref	строка	да	Ссылка на версию бизнес-задачи. шаблон: "^(?:memory\|task\|artifact\|task-revision\|memory-revision)://[A-Za-z0-9][A-Za-z0-9_./:@-]{1,255}$"
product_ids	массив	да	Список артикулов WB в пределах выбранного магазина. не менее элементов: 1; не более элементов: 20
rating_min	целое	да	Нижняя граница оценки отзыва. минимум: 1; максимум: 5
rating_max	целое	да	Верхняя граница оценки отзыва. минимум: 1; максимум: 5
excluded_terms	массив	да	Согласованные исключаемые выражения. не менее элементов: 0; не более элементов: 30
escalation_terms	массив	да	Дополнительные темы передачи человеку. не менее элементов: 0; не более элементов: 30
response_text	строка	нет	Текст шаблона или конкретного черновика. не менее символов: 2; не более символов: 1000
drafts	массив	нет	Массив точных черновиков по ID и хешу источника. не менее элементов: 1; не более элементов: 20
drafts[].review_id	строка	да	ID конкретного отзыва из прочитанных данных. шаблон: "^[A-Za-z0-9][A-Za-z0-9_.:-]{1,127}$"
drafts[].source_text_sha256	строка	да	SHA-256 UTF-8 адаптированного текста отзыва. шаблон: "^[a-f0-9]{64}$"
drafts[].response_text	строка	да	Текст шаблона или конкретного черновика. не менее символов: 2; не более символов: 1000
drafts[].evidence_refs	массив	да	Непустые ссылки на основания и происхождение. не менее элементов: 1; не более элементов: 10
max_items	целое	да	Максимальное число случаев за расчёт. минимум: 1; максимум: 20

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "config_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{1,127}$"
    },
    "service_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "generation": {
      "type": "string",
      "enum": [
        "template",
        "agent-draft"
      ]
    },
    "model_ref": {
      "type": "string",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{1,127}$"
    },
    "memory_binding": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "instructions_ref": {
          "type": "string",
          "pattern": "^(?:memory|task|artifact|task-revision|memory-revision)://[A-Za-z0-9][A-Za-z0-9_./:@-]{1,255}$"
        },
        "task_ref": {
          "type": "string",
          "pattern": "^(?:memory|task|artifact|task-revision|memory-revision)://[A-Za-z0-9][A-Za-z0-9_./:@-]{1,255}$"
        }
      },
      "required": [
        "instructions_ref",
        "task_ref"
      ]
    },
    "product_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 256,
        "pattern": "^[0-9]{1,20}$"
      },
      "minItems": 1,
      "maxItems": 20,
      "uniqueItems": true
    },
    "rating_min": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5
    },
    "rating_max": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5
    },
    "excluded_terms": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 256
      },
      "minItems": 0,
      "maxItems": 30,
      "uniqueItems": true
    },
    "escalation_terms": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 256
      },
      "minItems": 0,
      "maxItems": 30,
      "uniqueItems": true
    },
    "response_text": {
      "type": "string",
      "minLength": 2,
      "maxLength": 1000
    },
    "drafts": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "review_id": {
            "type": "string",
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]{1,127}$"
          },
          "source_text_sha256": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "response_text": {
            "type": "string",
            "minLength": 2,
            "maxLength": 1000
          },
          "evidence_refs": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 256,
              "pattern": "^(?:memory|task|artifact|task-revision|memory-revision)://[A-Za-z0-9][A-Za-z0-9_./:@-]{1,255}$"
            },
            "minItems": 1,
            "maxItems": 10,
            "uniqueItems": true
          }
        },
        "required": [
          "review_id",
          "source_text_sha256",
          "response_text",
          "evidence_refs"
        ]
      },
      "maxItems": 20,
      "minItems": 1
    },
    "max_items": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    }
  },
  "required": [
    "config_id",
    "service_id",
    "generation",
    "memory_binding",
    "product_ids",
    "rating_min",
    "rating_max",
    "excluded_terms",
    "escalation_terms",
    "max_items"
  ]
}

`monitor.compare`

Сравнить показатели вокруг события с покрытием и одновременными изменениями; причинность не доказывает, память не записывает.

Параметр	Тип	Обязателен	Назначение и ограничения
event_id	строка	да	Идентификатор наблюдаемого события для сравнения. формат: "uuid"
nm_id	целое	да	Артикул WB; соблюдайте тип именно этого метода. минимум: 1
days	целое	нет	Число дней окна до/после события. минимум: 1; максимум: 28; по умолчанию: 7
metrics	массив	нет	Список выбранных показателей; разные сервисы имеют собственный каталог. не менее элементов: 1; не более элементов: 12

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "event_id",
    "nm_id"
  ],
  "properties": {
    "event_id": {
      "type": "string",
      "format": "uuid"
    },
    "nm_id": {
      "type": "integer",
      "minimum": 1
    },
    "days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 28,
      "default": 7
    },
    "metrics": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 12
    }
  }
}

`datasets.list`

Узнать доступные dataset_key перед запросом или экспортом.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`cabinet.overview`

Получить компактный обзор и ограниченное число ведущих товаров.

Параметр	Тип	Обязателен	Назначение и ограничения
top_limit	целое	нет	Количество ведущих товаров в обзоре. минимум: 1; максимум: 20; по умолчанию: 10

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "top_limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "default": 10
    }
  }
}

`product.360`

Прочитать срез одного артикула за выбранный период.

Параметр	Тип	Обязателен	Назначение и ограничения
nm_id	строка	да	Артикул WB; соблюдайте тип именно этого метода. шаблон: "^[0-9]{1,19}$"
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "nm_id",
    "date_from",
    "date_to"
  ],
  "properties": {
    "nm_id": {
      "type": "string",
      "pattern": "^[0-9]{1,19}$"
    },
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    }
  }
}

`finance.summary`

Получить финансовую сводку с явными денежными базами и ограничениями.

Параметр	Тип	Обязателен	Назначение и ограничения
date_from	строка	да	Дата начала; смысл события или наблюдения зависит от метода. формат: "date"
date_to	строка	да	Включённая дата окончания; проверяйте допустимую длину периода. формат: "date"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "date_from",
    "date_to"
  ],
  "properties": {
    "date_from": {
      "type": "string",
      "format": "date"
    },
    "date_to": {
      "type": "string",
      "format": "date"
    }
  }
}

`memory.context`

Явно прочитать ограниченный контекст магазина.

Параметр	Тип	Обязателен	Назначение и ограничения
query	строка	да	Запрос для ограниченного поиска рабочего контекста. не более символов: 500
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 5
max_chars	целое	нет	Ограничение возвращаемого текста в символах. минимум: 1000; максимум: 6000

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 500
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5
    },
    "max_chars": {
      "type": "integer",
      "minimum": 1000,
      "maximum": 6000
    }
  },
  "required": [
    "query"
  ]
}

`xmp.client.instructions`

Прочитать индекс инструкций или1–3 skill; бизнес-правила не меняются.

Параметр	Тип	Обязателен	Назначение и ограничения
skills	массив	нет	Имена выбранных инструкций из текущего индекса. не менее элементов: 1; не более элементов: 3

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "skills": {
      "type": "array",
      "minItems": 1,
      "maxItems": 3,
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    }
  }
}

`xmp.update.check`

Проверить доступность совместимого клиентского выпуска.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`xmp.update.apply`

Применить проверенное обновление после confirm=true; права не расширяются.

Параметр	Тип	Обязателен	Назначение и ограничения
confirm	значение	да	Явное подтверждение обновления клиента; не разрешение на WB write. только: true
auto_update	да/нет	нет	Выбранная политика обновления устройства.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "confirm"
  ],
  "properties": {
    "confirm": {
      "const": true
    },
    "auto_update": {
      "type": "boolean"
    }
  }
}

`xmp.client.doctor`

Check client integrity, account identity, granted access and configured service states. Read-only; never enables grants, schedules or marketplace operations. Returns bounded diagnostics, not business data.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

`notifications.history`

Read bounded notification history for the key owner and bound account, including supported delivery evidence. Does not mark read or send messages.

Параметр	Тип	Обязателен	Назначение и ограничения
cursor	целое	нет	Непрозрачный курсор продолжения с теми же фильтрами. минимум: 0
limit	целое	нет	Число строк/событий за страницу, а не полнота всего источника. минимум: 1; максимум: 100
category	строка	нет	Состав и семантика описаны в руководстве домена. варианты: ["reports", "operations", "prices", "data"]
correlation_id	строка	нет	Состав и семантика описаны в руководстве домена. не более символов: 128

Точная JSON Schema

{
  "type": "object",
  "required": [],
  "additionalProperties": false,
  "properties": {
    "cursor": {
      "type": "integer",
      "minimum": 0
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "category": {
      "type": "string",
      "enum": [
        "reports",
        "operations",
        "prices",
        "data"
      ]
    },
    "correlation_id": {
      "type": "string",
      "maxLength": 128
    }
  }
}

`notifications.settings.get`

Read personal delivery preferences for this account and key owner. Version is required for a later update.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {}
}

`notifications.settings.update`

Save requested delivery preferences with exact current version and confirm=true. Requires tasks.write; no test message or marketplace execution. On conflict/timeout read preferences before retry.

Параметр	Тип	Обязателен	Назначение и ограничения
settings	объект	да	Состав и семантика описаны в руководстве домена.
settings.version	целое	да	Состав и семантика описаны в руководстве домена. минимум: 0
settings.reports	строка	да	Состав и семантика описаны в руководстве домена. варианты: ["immediate", "digest", "in_app_only", "off"]
settings.operations	строка	да	Состав и семантика описаны в руководстве домена. варианты: ["immediate", "digest", "in_app_only", "off"]
settings.prices	строка	да	Состав и семантика описаны в руководстве домена. варианты: ["immediate", "digest", "in_app_only", "off"]
settings.data	строка	да	Состав и семантика описаны в руководстве домена. варианты: ["immediate", "digest", "in_app_only", "off"]
settings.notify_no_changes	да/нет	да	Состав и семантика описаны в руководстве домена.
settings.timezone	строка	да	Состав и семантика описаны в руководстве домена. не менее символов: 1; не более символов: 100
settings.quiet_start	строка	да	Состав и семантика описаны в руководстве домена. шаблон: "^(?:[01][0-9]\|2[0-3]):[0-5][0-9]$"
settings.quiet_end	строка	да	Состав и семантика описаны в руководстве домена. шаблон: "^(?:[01][0-9]\|2[0-3]):[0-5][0-9]$"
settings.digest_time	строка	да	Состав и семантика описаны в руководстве домена. шаблон: "^(?:[01][0-9]\|2[0-3]):[0-5][0-9]$"
confirm	да/нет	да	Явное подтверждение обновления клиента; не разрешение на WB write. только: true

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "settings",
    "confirm"
  ],
  "properties": {
    "settings": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "version",
        "reports",
        "operations",
        "prices",
        "data",
        "notify_no_changes",
        "timezone",
        "quiet_start",
        "quiet_end",
        "digest_time"
      ],
      "properties": {
        "version": {
          "type": "integer",
          "minimum": 0
        },
        "reports": {
          "type": "string",
          "enum": [
            "immediate",
            "digest",
            "in_app_only",
            "off"
          ]
        },
        "operations": {
          "type": "string",
          "enum": [
            "immediate",
            "digest",
            "in_app_only",
            "off"
          ]
        },
        "prices": {
          "type": "string",
          "enum": [
            "immediate",
            "digest",
            "in_app_only",
            "off"
          ]
        },
        "data": {
          "type": "string",
          "enum": [
            "immediate",
            "digest",
            "in_app_only",
            "off"
          ]
        },
        "notify_no_changes": {
          "type": "boolean"
        },
        "timezone": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "quiet_start": {
          "type": "string",
          "pattern": "^(?:[01][0-9]|2[0-3]):[0-5][0-9]$"
        },
        "quiet_end": {
          "type": "string",
          "pattern": "^(?:[01][0-9]|2[0-3]):[0-5][0-9]$"
        },
        "digest_time": {
          "type": "string",
          "pattern": "^(?:[01][0-9]|2[0-3]):[0-5][0-9]$"
        }
      }
    },
    "confirm": {
      "type": "boolean",
      "const": true
    }
  }
}

`reports.list`

List up to ten Memory-backed report definitions and their schedule state for this account.

Параметров нет: передайте {}.

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {}
}

`reports.create`

Create an idempotent Memory-backed daily-review/1 report definition, initially paused. Sections sales/advertising/stock/change; not a complete financial audit.

Параметр	Тип	Обязателен	Назначение и ограничения
title	строка	да	Состав и семантика описаны в руководстве домена. не менее символов: 3; не более символов: 120
request_id	строка	да	Состав и семантика описаны в руководстве домена. формат: "uuid"
template	строка	нет	Состав и семантика описаны в руководстве домена. варианты: ["daily-review/1"]
sections	массив	нет	Состав и семантика описаны в руководстве домена. не менее элементов: 1; не более элементов: 4
timezone	строка	нет	Состав и семантика описаны в руководстве домена. не менее символов: 1; не более символов: 100
local_time	строка	нет	Состав и семантика описаны в руководстве домена. шаблон: "^(?:[01][0-9]\|2[0-3]):[0-5][0-9]$"
weekdays	массив	нет	Состав и семантика описаны в руководстве домена. не менее элементов: 1; не более элементов: 7

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "title",
    "request_id"
  ],
  "properties": {
    "title": {
      "type": "string",
      "minLength": 3,
      "maxLength": 120
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "template": {
      "type": "string",
      "enum": [
        "daily-review/1"
      ]
    },
    "sections": {
      "type": "array",
      "minItems": 1,
      "maxItems": 4,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "sales",
          "advertising",
          "stock",
          "change"
        ]
      }
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "local_time": {
      "type": "string",
      "pattern": "^(?:[01][0-9]|2[0-3]):[0-5][0-9]$"
    },
    "weekdays": {
      "type": "array",
      "minItems": 1,
      "maxItems": 7,
      "uniqueItems": true,
      "items": {
        "type": "integer",
        "minimum": 0,
        "maximum": 6
      }
    }
  }
}

`reports.run`

Queue one requested report generation using a stable request_id. Does not enable recurrence or execute marketplace changes.

Параметр	Тип	Обязателен	Назначение и ограничения
card_id	строка	да	Задача Seller Memory; возьмите реальный UUID. формат: "uuid"
request_id	строка	да	Состав и семантика описаны в руководстве домена. формат: "uuid"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "card_id",
    "request_id"
  ],
  "properties": {
    "card_id": {
      "type": "string",
      "format": "uuid"
    },
    "request_id": {
      "type": "string",
      "format": "uuid"
    }
  }
}

`reports.schedule`

Explicitly enable or disable the saved report schedule. Requires confirm=true and account tasks.write; changes recurrence, not marketplace data.

Параметр	Тип	Обязателен	Назначение и ограничения
card_id	строка	да	Задача Seller Memory; возьмите реальный UUID. формат: "uuid"
enabled	да/нет	да	Состав и семантика описаны в руководстве домена.
confirm	да/нет	да	Явное подтверждение обновления клиента; не разрешение на WB write. только: true

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "card_id",
    "enabled",
    "confirm"
  ],
  "properties": {
    "card_id": {
      "type": "string",
      "format": "uuid"
    },
    "enabled": {
      "type": "boolean"
    },
    "confirm": {
      "type": "boolean",
      "const": true
    }
  }
}

`reports.status`

Read the bound report job state; completion and delivery are separate.

Параметр	Тип	Обязателен	Назначение и ограничения
job_id	строка	да	Идентификатор задачи очереди из jobs.create/list. формат: "uuid"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job_id"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "format": "uuid"
    }
  }
}

`reports.result`

Read verified bounded report JSON from a scoped artifact; server verifies archive checksums, account, workspace and tenant.

Параметр	Тип	Обязателен	Назначение и ограничения
artifact_id	строка	да	Идентификатор файла из каталога артефактов. формат: "uuid"

Точная JSON Schema

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "artifact_id"
  ],
  "properties": {
    "artifact_id": {
      "type": "string",
      "format": "uuid"
    }
  }
}

Техническая справка для агента и разработчика

Этот раздел предназначен для настройки интеграции. Для обычной работы начните с шагов выше.