Получение бейджа по уникальному идентификатору

Получает бейдж по уникальному идентификатору.

Request

GET

https://api.kit.yandex.net/v1/badges/{badge_id}

Responses

200 OK

Бейдж.

Body

application/json
{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "slug": "sale",
  "label": "Акция",
  "color": "#FFFFFFFF",
  "caption": "Отображается при наличии скидки",
  "tooltip": "Отображается при наличии скидки",
  "priority": 1,
  "is_system": true,
  "binding_mode": "SELECTED_VARIANTS"
}

Name

Description

binding_mode

Type: BadgeBindingMode

Режим привязки бейджа:

  • SELECTED_VARIANTS — привязка к товарам.
  • SELECTED_CATEGORIES_COLLECTIONS — привязка к категориям и коллекциям.

Enum: SELECTED_VARIANTS, SELECTED_CATEGORIES_COLLECTIONS

caption

Type: string

Описание системных бейджей в b2b кабинете. Нельзя выставить или обновить вручную.

Example: Отображается при наличии скидки

color

Type: string

Цвет бейджа в формате hex.

Example: #FFFFFFFF

id

Type: BadgeID

ID бейджа.

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

is_system

Type: boolean

Является ли бейдж системным. Системные бейджи предсозданы и их нельзя обновлять.

label

Type: string

Название бейджа.

Example: Акция

priority

Type: integer

Приоритет бейджа.

slug

Type: string

URL-идентификатор бейджа.

Example: sale

tooltip

Type: string

Текст описания по клику.

Example: Отображается при наличии скидки

BadgeID

ID бейджа.

Type: string<uuid>

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

BadgeBindingMode

Режим привязки бейджа:

  • SELECTED_VARIANTS — привязка к товарам.
  • SELECTED_CATEGORIES_COLLECTIONS — привязка к категориям и коллекциям.

Type: string

Enum: SELECTED_VARIANTS, SELECTED_CATEGORIES_COLLECTIONS

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