Создание настроек похожих карточек

Создает настройки похожих карточек для указанной карточки товара. Если настройки для карточки уже существуют, возвращает 409.

Request

POST

https://api.kit.yandex.net/v1/similar-cards/{product_card_id}

Body

application/json
{
  "binding_mode": "ALL_VARIANTS"
}

Name

Description

binding_mode

Type: SimilarCardBindingMode

Режим привязки похожих карточек:

  • ALL_VARIANTS — похожи все товары магазина.
  • SELECTED_CARDS — похожи выбранные карточки товара.
  • SELECTED_CATEGORIES_COLLECTIONS — похожи товары из выбранных категорий и коллекций.

Enum: ALL_VARIANTS, SELECTED_CARDS, SELECTED_CATEGORIES_COLLECTIONS

SimilarCardBindingMode

Режим привязки похожих карточек:

  • ALL_VARIANTS — похожи все товары магазина.
  • SELECTED_CARDS — похожи выбранные карточки товара.
  • SELECTED_CATEGORIES_COLLECTIONS — похожи товары из выбранных категорий и коллекций.

Type: string

Enum: ALL_VARIANTS, SELECTED_CARDS, SELECTED_CATEGORIES_COLLECTIONS

Responses

201 Created

Настройки успешно созданы.

Body

application/json
{
  "product_card_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "binding_mode": "ALL_VARIANTS"
}

Name

Description

binding_mode

Type: SimilarCardBindingMode

Режим привязки похожих карточек:

  • ALL_VARIANTS — похожи все товары магазина.
  • SELECTED_CARDS — похожи выбранные карточки товара.
  • SELECTED_CATEGORIES_COLLECTIONS — похожи товары из выбранных категорий и коллекций.

Enum: ALL_VARIANTS, SELECTED_CARDS, SELECTED_CATEGORIES_COLLECTIONS

product_card_id

Type: ProductCardID

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

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

ProductCardID

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

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

409 Conflict

Конфликт данных.

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