Обновление контекстной коллекции

Обновляет контекстную коллекцию по уникальному идентификатору.

Request

PATCH

https://api.kit.yandex.net/v1/context-collections/{id}

Body

application/json
{
  "title": "Похожие по цвету",
  "comment": "Показывает товары того же цвета",
  "conditions": [
    {
      "type": "CHARACTERISTIC",
      "operator": "EQ",
      "characteristic_slug": "color"
    }
  ],
  "default_sort": "POPULARITY"
}

Name

Description

comment

Type: string

Внутренний комментарий.

Max length: 5000

Example: Показывает товары того же цвета

conditions

Type: ContextCollectionCondition[]

Список условий подбора.

Min items: 1

Example
[
  {
    "type": "CHARACTERISTIC",
    "operator": "EQ",
    "characteristic_slug": "color"
  }
]

default_sort

Type: ContextCollectionDefaultSort

Сортировка подобранных товаров по умолчанию:

  • POPULARITY — по популярности.
  • CHEAPEST — сначала дешевые.
  • EXPENSIVE — сначала дорогие.
  • NEWEST — сначала новые.
  • OLDEST — сначала старые.

Default: POPULARITY

Enum: POPULARITY, CHEAPEST, EXPENSIVE, NEWEST, OLDEST

title

Type: string

Название контекстной коллекции.

Min length: 1

Max length: 2000

Example: Похожие по цвету

ContextCollectionConditionType

Тип условия подбора:

  • CHARACTERISTIC — сравнение по характеристике.
  • CATEGORY — сравнение по категории.
  • COLLECTION — сравнение по коллекции.
  • BRAND — сравнение по бренду.
  • BADGE — сравнение по бейджу.

Type: string

Enum: CHARACTERISTIC, CATEGORY, COLLECTION, BRAND, BADGE

ContextCollectionConditionOperator

Оператор условия подбора. В External API поддерживается только равенство.

Type: string

Const: EQ

Example: example

ContextCollectionCondition

Name

Description

operator

Type: ContextCollectionConditionOperator

Оператор условия подбора. В External API поддерживается только равенство.

Enum: EQ

type

Type: ContextCollectionConditionType

Тип условия подбора:

  • CHARACTERISTIC — сравнение по характеристике.
  • CATEGORY — сравнение по категории.
  • COLLECTION — сравнение по коллекции.
  • BRAND — сравнение по бренду.
  • BADGE — сравнение по бейджу.

Enum: CHARACTERISTIC, CATEGORY, COLLECTION, BRAND, BADGE

characteristic_slug

Type: string

Слаг характеристики для сравнения. Обязателен, если type = CHARACTERISTIC.

Example: color
Example
{
  "type": "CHARACTERISTIC",
  "operator": "EQ",
  "characteristic_slug": "color"
}

ContextCollectionDefaultSort

Сортировка подобранных товаров по умолчанию:

  • POPULARITY — по популярности.
  • CHEAPEST — сначала дешевые.
  • EXPENSIVE — сначала дорогие.
  • NEWEST — сначала новые.
  • OLDEST — сначала старые.

Type: string

Default: POPULARITY

Enum: POPULARITY, CHEAPEST, EXPENSIVE, NEWEST, OLDEST

Responses

200 OK

Контекстная коллекция успешно обновлена.

Body

application/json
{
  "id": "0196a577-b86c-7c8f-893d-2f1dfbc57f5d",
  "title": "Похожие по цвету",
  "comment": "Показывает товары того же цвета",
  "conditions": [
    {
      "type": "CHARACTERISTIC",
      "operator": "EQ",
      "characteristic_slug": "color"
    }
  ],
  "default_sort": "POPULARITY",
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z"
}

Name

Description

comment

Type: string

Внутренний комментарий.

Example: Показывает товары того же цвета

conditions

Type: ContextCollectionCondition[]

Список условий подбора.

Min items: 1

Example
[
  {
    "type": "CHARACTERISTIC",
    "operator": "EQ",
    "characteristic_slug": "color"
  }
]

created_at

Type: string<date-time>

Дата создания контекстной коллекции.

Example: 2020-01-01T00:00:00Z

default_sort

Type: ContextCollectionDefaultSort

Сортировка подобранных товаров по умолчанию:

  • POPULARITY — по популярности.
  • CHEAPEST — сначала дешевые.
  • EXPENSIVE — сначала дорогие.
  • NEWEST — сначала новые.
  • OLDEST — сначала старые.

Default: POPULARITY

Enum: POPULARITY, CHEAPEST, EXPENSIVE, NEWEST, OLDEST

id

Type: ContextCollectionID

Идентификатор контекстной коллекции.

Example: 0196a577-b86c-7c8f-893d-2f1dfbc57f5d

title

Type: string

Название контекстной коллекции.

Example: Похожие по цвету

updated_at

Type: string<date-time>

Дата последнего обновления контекстной коллекции.

Example: 2020-01-01T00:00:00Z

ContextCollectionID

Идентификатор контекстной коллекции.

Type: string<uuid>

Example: 0196a577-b86c-7c8f-893d-2f1dfbc57f5d

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
Предыдущая
Удаление контекстной коллекции
Следующая
Список ресурсов