a1-yandex-kit-catalog
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseA1 Yandex KIT — Catalog
A1 Yandex KIT — 目录
Communication
沟通规范
Before producing any user-facing message, read and apply
completely.
../a1-yandex-kit/references/merchant-communication.mdCovers the catalog domain of the Yandex KIT e-commerce API — tags: Товары,
Категории товаров, Характеристики товаров, Видео, Коллекции, Контекстные коллекции, Бейджи.
In KIT's model the variant () is the sellable unit carrying SKU, prices
and per-warehouse stocks, and a product () groups variants, so most
«товар» operations act on variants. A variant carries two distinct identifiers:
and (карточка товара) — the card-scoped endpoints
( and collection card management,
«Добавление/Удаление карточек») take , never a product id; read it
from the variant first. Variant documents (инструкции, сертификаты, паспорта) live under
: upload the file via first, then
attach it by ; the title must not contain or , and
must be unique per variant (an occupied value returns 409 — nothing
is reordered automatically). Mind the content types: , ,
and use JSON Merge Patch
( — send only the fields to change; clears only
the fields the schema marks nullable, see the skill), while the other
updates are plain .
/v1/variants/v1/productsproduct_idproduct_card_id/v1/products/cards/{product_card_id}/similar...product_card_id/v1/variants/{id}/attachmentsPOST /v1/filesfile_id:/display_sequenceUpdateVariantUpdateCategoryUpdateCharacteristicUpdateVariantAttachmentapplication/merge-patch+jsonnulla1-yandex-kitapplication/jsonFor catalog-wide syncs prefer the bulk endpoints over per-variant PATCHes:
and take
up to 5000 items each and are synchronous and atomic — one invalid item (unknown or
archived variant, a variant repeated in the batch, a malformed price) rejects the whole
request with 400 and applies nothing, listing every offender in . In a price item
both fields are optional: omit a key to keep the current value, send to reset it
(resetting works only on unpublished variants).
POST /v1/variants/prices/bulk_updatePOST /v1/variants/stocks/bulk_updateerrorsnullpriceProduct videos are a separate tag: use for a local file
() or for a public link. Both accept
videos up to 100 MB in mp4/mov/webm/avi/flv and deduplicate by content. Poll
— → → , at most once every
5 seconds — and link only a ready video. A variant accepts at most one video and only
alongside at least one image in the same list. Sending to
replaces the whole list, so preserve every existing image and untouched
entry. Characteristics carry two extras beyond the values
themselves: groups (, ordered by ) and
colors (), where recolors an
existing value addressed by the value itself — there is no id — accepting a hex code or
the special / .
POST /v1/videosmultipart/form-dataPOST /v1/videos/from_urlGET /v1/videos/{video_id}UPLOADEDPROCESSINGREADYmediamediaUpdateVariant/v1/characteristics/groupsdisplay_sequence/v1/characteristics/colorsUpdateCharacteristicColormulticolouredtransparentFor authentication (), the base URL (, all paths under ), the 3 rps rate limit and the error contract, see the skill.
Authorization: Bearer <token>https://api.kit.yandex.net/v1/{code, message, trace_id}a1-yandex-kit在生成任何面向用户的消息之前,请完整阅读并遵循中的要求。
../a1-yandex-kit/references/merchant-communication.md本文档覆盖Yandex KIT电商API的目录领域,涉及标签:商品、商品分类、商品属性、视频、集合、上下文集合、徽章。在KIT的模型中,变体()是可售卖单元,包含SKU、价格和各仓库库存;而商品()用于组合变体,因此大多数“商品”操作实际作用于变体。变体包含两个不同的标识符:和(商品卡片)——以卡片为范围的接口(以及集合卡片管理、“添加/删除卡片”)仅接收,而非商品id;需先从变体中读取该值。变体文档(说明书、证书、手册)存储在下:需先通过上传文件,再通过关联;文档标题不得包含或,且在每个变体中必须唯一(若值已被占用,会返回409,系统不会自动重新排序)。注意内容类型:、、和使用JSON Merge Patch(——仅发送需要修改的字段;仅会清除 schema 标记为可空的字段,详见技能),而其他更新操作使用普通的。
/v1/variants/v1/productsproduct_idproduct_card_id/v1/products/cards/{product_card_id}/similar...product_card_id/v1/variants/{id}/attachmentsPOST /v1/filesfile_id:/display_sequenceUpdateVariantUpdateCategoryUpdateCharacteristicUpdateVariantAttachmentapplication/merge-patch+jsonnulla1-yandex-kitapplication/json对于全目录同步,优先使用批量接口而非逐个变体的PATCH请求:和每次最多支持5000个条目,且是同步且原子性的——只要有一个无效条目(未知或已归档的变体、批次中重复的变体、格式错误的价格),整个请求会返回400且不会应用任何更改,并在中列出所有问题条目。价格条目中的两个字段都是可选的:省略键值将保留当前值,发送将重置该值(仅未发布的变体可重置)。
POST /v1/variants/prices/bulk_updatePOST /v1/variants/stocks/bulk_updateerrorsnullprice商品视频是独立的标签:本地文件使用(),公共链接使用。两者均支持最大100MB的mp4/mov/webm/avi/flv格式视频,并会根据内容去重。轮询查看状态—— → → ,轮询间隔至少5秒——仅可关联状态为READY的视频。每个变体最多关联一个视频,且必须与至少一张图片在同一个列表中。向发送会替换整个列表,因此需保留所有现有图片和未修改的条目。除属性值本身外,属性还包含两个额外内容:属性组(,按排序)和颜色(),其中用于修改现有颜色值的颜色——该值无id,需通过值本身指定,支持十六进制代码或特殊值/。
POST /v1/videosmultipart/form-dataPOST /v1/videos/from_urlGET /v1/videos/{video_id}UPLOADEDPROCESSINGREADYmediaUpdateVariantmedia/v1/characteristics/groupsdisplay_sequence/v1/characteristics/colorsUpdateCharacteristicColormulticolouredtransparent关于认证()、基础URL(,所有路径均在下)、每秒3次的请求速率限制以及错误格式,请参阅技能。
Authorization: Bearer <token>https://api.kit.yandex.net/v1/{code, message, trace_id}a1-yandex-kitWorkflow
工作流程
Run the bundled scripts from this skill's directory — they are self-contained
(Node.js >= 20, builtins + a vendored validator, no , no network).
npm install-
Search for the operation you need:bash
node scripts/search_docs.mjs "<query>" [--tag "<Тег>"] [--limit N]Matches operation ids, paths, tags and the Russian summaries/descriptions, e.g..node scripts/search_docs.mjs "создать товар" -
Inspect the full contract of one operation — path/query parameters plus the fully dereferenced request/response schemas:bash
node scripts/search_docs.mjs --operation CreateProduct -
Validate a drafted request body offline before sending anything:bash
node scripts/validate.mjs --operation CreateProduct --body '<json>' # or: node scripts/validate.mjs --operation CreateProduct --body-file body.jsonPrints(exit 0) or the list of schema violations (exit 1).VALID -
Execute the operation:
- prefer the matching MCP tool from «Related MCP tools» below (e.g.
mcp-yandex-kit,create_product);update_variant - any operation without a dedicated tool: the MCP tool — it validates the body against the same schema before sending;
kit_request - or plain HTTP:
(mind the 3 rps limit).
curl -H "Authorization: Bearer $YANDEX_KIT_TOKEN" https://api.kit.yandex.net/v1/...
- prefer the matching
从本技能目录中运行捆绑的脚本——这些脚本是独立的(Node.js >= 20,仅使用内置模块和 vendored 验证器,无需,无需网络)。
npm install-
搜索所需操作:bash
node scripts/search_docs.mjs "<query>" [--tag "<Тег>"] [--limit N]匹配操作ID、路径、标签以及俄文摘要/描述,例如。node scripts/search_docs.mjs "создать товар" -
查看单个操作的完整契约——路径/查询参数以及完全解引用的请求/响应schema:bash
node scripts/search_docs.mjs --operation CreateProduct -
离线验证拟发送的请求体,再实际发送:bash
node scripts/validate.mjs --operation CreateProduct --body '<json>' # 或:node scripts/validate.mjs --operation CreateProduct --body-file body.json验证通过时输出(退出码0),否则输出schema违规列表(退出码1)。VALID -
执行操作:
- 优先使用下方“相关MCP工具”中对应的工具(例如
mcp-yandex-kit、create_product);update_variant - 无专用工具的操作:使用MCP工具——它会在发送前根据相同的schema验证请求体;
kit_request - 或使用普通HTTP请求:
(注意每秒3次的速率限制)。
curl -H "Authorization: Bearer $YANDEX_KIT_TOKEN" https://api.kit.yandex.net/v1/...
- 优先使用下方“相关MCP工具”中对应的
Endpoints (71 operations)
接口(共71个操作)
Товары
商品
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение списка продуктов |
| POST | | | Создание нового продукта |
| GET | | | Получение продукта по ID |
| PATCH | | | Обновление продукта |
| GET | | | Получение списка похожих карточек товара. |
| POST | | | Добавление похожих карточек товара |
| POST | | | Удаление похожих карточек товара |
| GET | | | Получение списка товаров |
| POST | | | Создание нового товара |
| GET | | | Получение товара по ID |
| PATCH | | | Обновление товара |
| DELETE | | | Безвозвратное удаление архивного товара |
| POST | | | Архивирование товара |
| POST | | | Восстановление товара из архива |
| GET | | | Получение внешних идентификаторов товара |
| PUT | | | Установка внешнего идентификатора |
| DELETE | | | Удаление внешнего идентификатора |
| GET | | | Получение документов товара |
| POST | | | Прикрепление документа к товару |
| PATCH | | | Обновление документа товара |
| DELETE | | | Открепление документа от товара |
| POST | | | Массовое обновление остатков |
| POST | | | Массовое обновление цен |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 获取商品列表 |
| POST | | | 创建新商品 |
| GET | | | 根据ID获取商品 |
| PATCH | | | 更新商品 |
| GET | | | 获取相似商品卡片列表 |
| POST | | | 添加相似商品卡片 |
| POST | | | 删除相似商品卡片 |
| GET | | | 获取变体列表 |
| POST | | | 创建新变体 |
| GET | | | 根据ID获取变体 |
| PATCH | | | 更新变体 |
| DELETE | | | 永久删除已归档变体 |
| POST | | | 归档变体 |
| POST | | | 从归档中恢复变体 |
| GET | | | 获取变体外部标识符 |
| PUT | | | 设置外部标识符 |
| DELETE | | | 删除外部标识符 |
| GET | | | 获取变体文档 |
| POST | | | 为变体附加文档 |
| PATCH | | | 更新变体文档 |
| DELETE | | | 移除变体文档 |
| POST | | | 批量更新库存 |
| POST | | | 批量更新价格 |
Категории товаров
商品分类
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение списка категорий |
| POST | | | Создание новой категории |
| GET | | | Получение категории по ID |
| PATCH | | | Обновление категории |
| POST | | | Архивирование категории |
| POST | | | Восстановление категории из архива |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 获取分类列表 |
| POST | | | 创建新分类 |
| GET | | | 根据ID获取分类 |
| PATCH | | | 更新分类 |
| POST | | | 归档分类 |
| POST | | | 从归档中恢复分类 |
Характеристики товаров
商品属性
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение списка характеристик |
| POST | | | Создание новой характеристики |
| GET | | | Получение характеристики по ID |
| PATCH | | | Обновление характеристики |
| POST | | | Архивирование характеристики |
| POST | | | Восстановление характеристики из архива |
| GET | | | Получение списка групп характеристик |
| POST | | | Создание группы характеристик |
| GET | | | Получение группы характеристик по ID |
| PATCH | | | Обновление группы характеристик |
| DELETE | | | Удаление группы характеристик |
| GET | | | Получение списка цветов |
| PATCH | | | Обновление hex-кода для значения цветовой характеристики |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 获取属性列表 |
| POST | | | 创建新属性 |
| GET | | | 根据ID获取属性 |
| PATCH | | | 更新属性 |
| POST | | | 归档属性 |
| POST | | | 从归档中恢复属性 |
| GET | | | 获取属性组列表 |
| POST | | | 创建属性组 |
| GET | | | 根据ID获取属性组 |
| PATCH | | | 更新属性组 |
| DELETE | | | 删除属性组 |
| GET | | | 获取颜色列表 |
| PATCH | | | 更新颜色属性值的十六进制代码 |
Видео
视频
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение списка видео |
| POST | | | Загрузка видео |
| POST | | | Загрузка видео по ссылке |
| GET | | | Получение видео по идентификатору |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 获取视频列表 |
| POST | | | 上传视频 |
| POST | | | 通过链接上传视频 |
| GET | | | 根据ID获取视频 |
Коллекции
集合
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение коллекции по ID |
| PATCH | | | Обновление коллекции |
| DELETE | | | Удаление коллекции |
| POST | | | Добавление карточек в статическую коллекцию |
| POST | | | Удаление карточек из статической коллекции |
| GET | | | Получение ручного порядка карточек коллекции |
| POST | | | Перемещение карточек в статической коллекции |
| GET | | | Получение списка коллекций |
| POST | | | Создание коллекции |
| GET | | | Получение ID товаров коллекции по ID |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 根据ID获取集合 |
| PATCH | | | 更新集合 |
| DELETE | | | 删除集合 |
| POST | | | 向静态集合添加卡片 |
| POST | | | 从静态集合移除卡片 |
| GET | | | 获取集合卡片手动排序 |
| POST | | | 在静态集合中移动卡片 |
| GET | | | 获取集合列表 |
| POST | | | 创建集合 |
| GET | | | 根据集合ID获取变体ID |
Контекстные коллекции
上下文集合
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение списка контекстных коллекций |
| POST | | | Создание контекстной коллекции |
| GET | | | Получение контекстной коллекции по ID |
| PATCH | | | Обновление контекстной коллекции |
| DELETE | | | Удаление контекстной коллекции |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 获取上下文集合列表 |
| POST | | | 创建上下文集合 |
| GET | | | 根据ID获取上下文集合 |
| PATCH | | | 更新上下文集合 |
| DELETE | | | 删除上下文集合 |
Бейджи
徽章
| Method | Path | OperationId | Summary (RU) |
|---|---|---|---|
| GET | | | Получение бейджа по уникальному идентификатору |
| PATCH | | | Обновление бейджа |
| DELETE | | | Удаление бейджа |
| GET | | | Получение списка бейджей |
| POST | | | Создание бейджа |
| GET | | | Получение уникальных идентификаторов товаров бейджа |
| GET | | | Получение идентификаторов категорий бейджа |
| GET | | | Получение идентификаторов коллекций бейджа |
| POST | | | Добавление объектов в бейдж |
| POST | | | Удаление объектов из бейджа |
| 方法 | 路径 | 操作ID | 摘要(中文) |
|---|---|---|---|
| GET | | | 根据唯一ID获取徽章 |
| PATCH | | | 更新徽章 |
| DELETE | | | 删除徽章 |
| GET | | | 获取徽章列表 |
| POST | | | 创建徽章 |
| GET | | | 获取徽章关联的变体唯一ID |
| GET | | | 获取徽章关联的分类ID |
| GET | | | 获取徽章关联的集合ID |
| POST | | | 向徽章添加对象 |
| POST | | | 从徽章移除对象 |
Related MCP tools
相关MCP工具
Curated tools for these tags (the server also exposes the meta trio —
, , — reaching all
162 operations):
mcp-yandex-kitsearch_operationsget_operation_schemakit_request- — List products of the store (paginated).
list_products - — Get a single product by its ID, including its category bindings.
get_product - — Create a new product.
create_product - — Update an existing product (plain JSON PATCH, not merge-patch).
update_product - — List variants (sellable items / SKUs) of the store, with optional filters (paginated).
list_variants - — Get a single variant by its ID (name, SKU, pricing, stocks, media, status).
get_variant - — Create a new variant (sellable item) under an existing product.
create_variant - — Update an existing variant via JSON Merge Patch: send only the fields to change (e.g. pricing or stocks).
update_variant - — Update prices of up to 5000 variants in one synchronous, atomic request — the fast path for syncing a whole catalog instead of calling update_variant per item.
bulk_update_prices - — Archive a variant (soft delete: status becomes ARCHIVED, item is hidden from the storefront but restorable) or unarchive it (status becomes HIDDEN; publish it afterwards via update_variant).
variant_action - — List product categories of the store (paginated).
list_categories - — Get a single product category by its ID.
get_category - — Create a new product category.
create_category - — Update an existing category via JSON Merge Patch: send only the fields to change.
update_category - — Archive a category (soft delete: hidden from the storefront, restorable) or unarchive it.
category_action - — List product characteristics (paginated).
list_characteristics - — Get one product characteristic by ID.
get_characteristic - — Create a product characteristic.
create_characteristic - — Update a product characteristic.
update_characteristic - — List product characteristic groups (paginated).
list_characteristic_groups - — Get one product characteristic group by ID.
get_characteristic_group - — Create a product characteristic group.
create_characteristic_group - — Update a product characteristic group.
update_characteristic_group - — List the color values of the store's characteristics with their hex codes (paginated).
list_characteristic_colors - — Set the hex code of a color characteristic value.
update_characteristic_color - — List product videos of the store (paginated), oldest upload first.
list_videos - — Get a single video by its ID with the current processing status.
get_video - — Upload a product video via multipart/form-data and queue it for processing.
upload_video - — Upload a product video by public link and queue it for processing — use it instead of upload_video when the file lives on the web rather than on this machine.
upload_video_from_url - — List collections of the store (paginated).
list_collections - — Get a single collection by its ID (title, slug, status, type, SEO fields).
get_collection - — Create a new collection.
create_collection - — Update an existing collection (plain JSON PATCH; only the provided fields are changed).
update_collection - — Permanently delete a collection by its ID.
delete_collection - — Add product cards to a STATIC collection or remove them from it.
manage_collection_cards
Контекстные коллекции and Бейджи have no dedicated tools — reach them through + .
search_operationskit_request为上述标签整理的工具(服务器还提供三个元工具——、、——可覆盖全部162个操作):
mcp-yandex-kitsearch_operationsget_operation_schemakit_request- — 列出商店商品(分页)。
list_products - — 根据ID获取单个商品,包括其分类绑定信息。
get_product - — 创建新商品。
create_product - — 更新现有商品(普通JSON PATCH,非合并补丁)。
update_product - — 列出商店变体(可售卖单元/SKU),支持可选筛选(分页)。
list_variants - — 根据ID获取单个变体(名称、SKU、定价、库存、媒体、状态)。
get_variant - — 在现有商品下创建新变体(可售卖单元)。
create_variant - — 通过JSON Merge Patch更新现有变体:仅发送需要修改的字段(例如定价或库存)。
update_variant - — 在一个同步、原子性请求中更新最多5000个变体的价格——相比逐个调用update_variant,这是全目录同步的快速路径。
bulk_update_prices - — 归档变体(软删除:状态变为ARCHIVED,商品从商店前台隐藏但可恢复)或取消归档(状态变为HIDDEN;之后需通过update_variant发布)。
variant_action - — 列出商店商品分类(分页)。
list_categories - — 根据ID获取单个商品分类。
get_category - — 创建新商品分类。
create_category - — 通过JSON Merge Patch更新现有分类:仅发送需要修改的字段。
update_category - — 归档分类(软删除:从商店前台隐藏,可恢复)或取消归档。
category_action - — 列出商品属性(分页)。
list_characteristics - — 根据ID获取单个商品属性。
get_characteristic - — 创建商品属性。
create_characteristic - — 更新商品属性。
update_characteristic - — 列出商品属性组(分页)。
list_characteristic_groups - — 根据ID获取单个商品属性组。
get_characteristic_group - — 创建商品属性组。
create_characteristic_group - — 更新商品属性组。
update_characteristic_group - — 列出商店属性的颜色值及其十六进制代码(分页)。
list_characteristic_colors - — 设置颜色属性值的十六进制代码。
update_characteristic_color - — 列出商店商品视频(分页),按上传时间从旧到新排序。
list_videos - — 根据ID获取单个视频及其当前处理状态。
get_video - — 通过multipart/form-data上传商品视频并排队处理。
upload_video - — 通过公共链接上传商品视频并排队处理——当文件存储在网络而非本地时,优先使用此工具。
upload_video_from_url - — 列出商店集合(分页)。
list_collections - — 根据ID获取单个集合(标题、别名、状态、类型、SEO字段)。
get_collection - — 创建新集合。
create_collection - — 更新现有集合(普通JSON PATCH;仅修改提供的字段)。
update_collection - — 根据ID永久删除集合。
delete_collection - — 向STATIC集合添加商品卡片或从中移除。
manage_collection_cards
上下文集合和徽章暂无专用工具——可通过 + 操作。
search_operationskit_request