Обновление продукта

Обновляет существующий продукт по его идентификатору. При передаче category_ids список привязок категорий полностью заменяется. Архивированные категории из списка привязываются к продукту, но остаются ARCHIVED и не попадают в Product.category_ids, пока не будут разархивированы отдельно.

Request

PATCH

https://api.kit.yandex.net/v1/products/{id}

Body

application/json

{
  "category_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ],
  "size_table": {
    "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "enabled": true
  },
  "settings": {
    "grouping_characteristic_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ],
    "splitting_characteristic_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ]
  }
}

Name	Description
category_ids	Type: CategoryID[] Идентификаторы категорий для обновления (можно указать одну или несколько категорий). При обновлении список категорий продукта полностью заменяется на переданный. Правила: Продукт с неархивными товарами в статусе (`PUBLISHED/HIDDEN`) должен сохранить хотя бы одну активную категорию — пустой массив отклоняется. Допускается передача идентификаторов архивированных категорий: они привяжутся к продукту, но останутся в статусе `ARCHIVED` и не будут отображаться в `Product.category_ids`, пока категория не разархивирована с помощью запроса `POST /v1/categories/{id}/unarchive`. Min items: `1` Example `[ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ]`
settings	Type: ProductSettings Example `{ "grouping_characteristic_ids": [ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ], "splitting_characteristic_ids": [ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ] }`
size_table	All of 1 type Type: ProductSizeTable Таблица размеров для товара. Содержит изображение с размерной сеткой (размеры одежды, обуви и т.д.). Применяется ко всем вариантам продукта. Example `{ "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "enabled": true }` Example `{ "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "enabled": true }`

CategoryID

Идентификатор категории.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

ProductSizeTable

Таблица размеров для товара. Содержит изображение с размерной сеткой (размеры одежды, обуви и т.д.). Применяется ко всем вариантам продукта.

Name

Description

enabled

Type: boolean

Флаг включения/выключения отображения таблицы размеров.

true — таблица отображается на странице товара.
false — таблица скрыта от покупателей.

file_id

Type: string<uuid>

Уникальный идентификатор файла с таблицей размеров. Файл должен быть предварительно загружен через POST /v1/files.

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

Example

{
  "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "enabled": true
}

ProductSettings

Name

Description

grouping_characteristic_ids

Type: CharacteristicID[]

Массив идентификаторов характеристик для группировки.

Example

[
  "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
]

splitting_characteristic_ids

Type: CharacteristicID[]

Массив идентификаторов характеристик для разбиения.

Example

[
  "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
]

Example

{
  "grouping_characteristic_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ],
  "splitting_characteristic_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ]
}

Responses

200 OK

Продукт.

Body

application/merge-patch+json

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "category_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ],
  "group_id": "group-123",
  "size_table": {
    "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "enabled": true
  },
  "settings": {
    "grouping_characteristic_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ],
    "splitting_characteristic_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ]
  }
}

Name	Description
category_ids	Type: CategoryID[] Идентификаторы активных (неархивированных) категорий продукта. Продукт может быть привязан к нескольким категориям, в том числе к архивированным — такие привязки сохраняются, но в этом поле не отображаются, пока категория имеет статус ARCHIVED. Если все привязанные категории архивированы, массив может быть пустым до разархивации категории или товара. Min items: `1` Example `[ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ]`
id	Type: ProductID Идентификатор продукта. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
settings	Type: ProductSettings Example `{ "grouping_characteristic_ids": [ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ], "splitting_characteristic_ids": [ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ] }`
group_id	Type: string Идентификатор группы товаров в Excel. Example: `group-123`
size_table	Type: ProductSizeTable Таблица размеров для товара. Содержит изображение с размерной сеткой (размеры одежды, обуви и т.д.). Применяется ко всем вариантам продукта. Example `{ "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "enabled": true }`

ProductSettings

Name

Description

grouping_characteristic_ids

Type: CharacteristicID[]

Массив идентификаторов характеристик для группировки.

Example

[
  "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
]

splitting_characteristic_ids

Type: CharacteristicID[]

Массив идентификаторов характеристик для разбиения.

Example

[
  "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
]

Example

{
  "grouping_characteristic_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ],
  "splitting_characteristic_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ]
}

ProductID

Идентификатор продукта.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Получение продукта по ID

Получение списка похожих карточек товара.