--- metadata: - name: generator content: Diplodoc Platform v5.70.0 alternate: - https://yandex.ru/support/kit/ru/site-editor/custom-sections/utilities/data.md - href: https://yandex.ru/support/kit/ru/site-editor/custom-sections/utilities/data.md type: text/markdown title: Markdown version - href: https://yandex.ru/support/kit/ru/llms.txt?revision=r22105010 rel: describedby --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/kit/ru/llms.txt?revision=r22105010 # Модели данных Модели данных — это структурированные представления сущностей, которые определяют, какие данные используются в системе, как они связаны между собой и для каких задач применяются. #| || [B](#b) | [C](#c) | [D](#d) | [E](#e) | [F](#f)| [G](#g) | [I](#i) | [M](#m) | [P](#p) | [R](#r) | [S](#s) | [T](#t) | [U](#u) | [V](#v) || |# {#b} ## BlogListingModel {#blog-listing} Модель списка статей с метаданными. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `total` | `number` | Общее количество статей, соответствующих текущим фильтрам. | Да || || `items` | `BlogModel[]` | Массив статей на текущей странице. | Да || || `pagination.current` | `number` | Номер текущей страницы (начинается с 1). | Да || || `pagination.total` | `number` | Общее количество страниц. | Да || |# {% endcut %} Связанные модели: [BlogSnippetModel](#blog-snippet). ## BlogModel {#blog} Модель статьи блога с контентом, метаданными и мультимедиа. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `id` | `string` | Уникальный идентификатор статьи блога. | Да || || `slug` | `string` | ЧПУ идентификатор статьи. | Да || || `url` | `string` | Относительный канонический URL. | Да || || `title` | `string` | Заголовок статьи блога. | Да || || `content` | `string` | Полный текст статьи в формате markdown. | Да || || `shortDescription` | `string` | Краткое описание/выдержка из статьи. Рекомендуется 120-160 символов. | Нет || || `pubDate` | `string` | Дата и время публикации статьи. Формат: ISO 8601 строка. | Да || || `endDate` | `string` | Дата окончания актуальности/снятия с публикации. Формат: ISO 8601 строка. | Нет || || `tags` | `string[]` | Массив тегов для классификации статьи. | Да || || `previewMedia` | `ImageModel` | Обложка для сниппетов в списках статей. | Нет || || `desktopMedia` | `ImageModel` | Обложка для десктопной версии статьи. | Нет || || `mobileMedia` | `ImageModel` | Обложка для мобильной версии статьи. | Нет || |# {% endcut %} Связанные модели: [ImageModel](#ImageModel). ## BlogSnippetModel {#blog-snippet} Компактная модель карточки статьи блога для списков и подборок. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `id` | `string` | Уникальный идентификатор статьи. | Да || || `slug` | `string` | ЧПУ-идентификатор статьи. | Да || || `title` | `string` | Заголовок статьи. | Да || || `shortDescription` | `string` | Готовый или вычисленный текстовый анонс.| Нет || || `pubDate` | `string` | Дата публикации в формате ISO 8601. | Да || || `endDate` | `string` | Дата окончания актуальности в формате ISO 8601. | Нет || || `tags` | `string[]` | Теги статьи. | Да || || `previewMedia` | `ImageModel` | Обложка карточки. Если в ответе API нет корректного preview, система подставляет корректную мобильную обложку. | Нет || || `url` | `string` | Относительный канонический URL. | Да || || `linkUrl` | `string` | URL статьи из API. | Да || |# {% endcut %} Связанные модели: [ImageModel](#ImageModel). ## BreadcrumbModel {#breadcrumb} {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `title` | `string` | Заголовок хлебной крошки. | Да || || `url` | `string` | URL-адрес для навигации при клике на элемент хлебных крошек. | Нет || |# {% endcut %} {#c} ## CartBundleDiscountLadder {#cart-bundle-discount-ladder} Модель лестницы скидок — показывает, какая скидка действует при определенном количестве товаров. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `id` | `string` | Идентификатор акции. | Да || || `title` | `string` | Название акции. | Да || || `badge` | `ProductBadgeModel`, `undefined` | Бейдж акции. | Нет || || `stages` | `CartBundleDiscountLadderStage[]` | Массив ступеней лестницы скидок. Каждая ступень содержит порог количества товаров и размер скидки. | Да || |# {% endcut %} Связанные модели: [CartBundleDiscountLadderStage](#cart-bundle-discount-ladder-stage), [ProductBadgeModel](#product-badge). ## CartBundleDiscountLadderStage {#cart-bundle-discount-ladder-stage} Модель ступени скидки — показывает сколько товаров нужно купить, чтобы получить определенную скидку. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `quantity` | `number` | Количество товаров, необходимое для достижения ступени. | Да || || `discount` | `string` | Размер скидки ступени в процентах, записанный строкой без знака `%`. Например, `"5.00"` означает скидку 5%. | Да || |# {% endcut %} Связанные модели: [CartBundleDiscountLadder](#cart-bundle-discount-ladder). ## CategoryModel {#category} Модель категории товаров с поддержкой иерархической структуры (древовидное представление). Используется для навигации по каталогу, построения меню и фильтрации товаров. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `id` | `string` | Уникальный идентификатор категории. | Да || || `url` | `string` | Полный URL-адрес страницы категории. | Да || || `slug` | `string` | URL-friendly идентификатор категории. | Да || || `title` | `string` | Отображаемое название категории. | Да || || `Media` | `ImageModel` | Изображение категории. | Нет || || `children` | `CategoryModel[]` | Массив дочерних (вложенных) категорий. | Да || |# {% note info %} Рекурсивная структура позволяет создавать категории любой глубины вложенности. {% endnote %} {% endcut %} Связанные модели: [ImageModel](#ImageModel). ## CollectionModel {#collection} Модель коллекции товаров. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `id` | `string` | Уникальный идентификатор коллекции. | Да || || `url` | `string` | Полный URL-адрес страницы коллекции. | Да || || `slug` | `string` | URL-friendly идентификатор коллекции. | Да || || `title` | `string` | Отображаемое название категории. | Да || || `media` | `ImageModel` | Изображение коллекции. | Нет || |# {% endcut %} Связанные модели: [ImageModel](#ImageModel). ## CompanyModel {#company} Модель компании, включающая контактные данные и логотип. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `mail` | `CompanyCharacteristicModel[]` | Массив адресов электронной почты компании. | Да || || `phone` | `CompanyCharacteristicModel[]` | Массив телефонных номеров компании. | Да || || `address` | `CompanyCharacteristicModel[]` | Массив физических адресов компании. | Да || || `workingMode` | `CompanyCharacteristicModel[]` | Массив режимов работы компании/отделов | Да || || `socialNetworks` | `CompanyCharacteristicModel[]` | Массив ссылок на страницы компании в социальных сетях. | Нет || || `logo` | `ImageModel` | Логотип компании с метаданными изображения. | Нет || |# {% endcut %} Связанные модели: [CompanyCharacteristicModel](#company-characteristic), [ImageModel](#ImageModel). ## CompanyCharacteristicModel {#company-characteristic} Базовая модель для представления пары «название-значение» характеристики компании. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `name` | `string` | Название характеристики. | Да || || `value` | `string` | Значение характеристики. | Да || |# {% endcut %} {#d} ## DeliveryOptionModel {#delivery-option} Модель опции доставки товара. Содержит информацию о способе доставки, сроках и стоимости. Используется для отображения доступных вариантов доставки на странице оформления заказа или в карточке товара. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `method` | `COURIER`, `PICKUP_POINT` | Способ доставки. | Да || || `serviceType` | `YANDEX_DELIVERY`, `CDEK`, `META_SHIP_DALLI`, `META_SHIP_RUSSIAN_POST`, `OZON`, `META_SHIP_PECOM`, `META_SHIP_FIVE_POST`, `MERCHANT_SHIP` | Тип службы доставки или конкретного сервиса. | Да || || `serviceName` | `string` | Название и тип службы доставки в человекочитаемом формате. | Да || || `formattedDate` | `string` | Отформатированная дата доставки в человекочитаемом формате. | Да || || `price` | `number` | Стоимость доставки. | Да || |# {% endcut %} ## DiscountLadderModel {#discount-ladder} Модель списка вариантов товаров, участвующих в лестнице скидок, с данными акции и метаданными. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `discountLadder` | `CartBundleDiscountLadder`, `undefined` | Данные лестницы скидок из текущей корзины. Значение равно`undefined`, если данные акции отсутствуют. | Нет || || `items` | `ShoppingCartVariantModel[]` | Варианты товаров на текущей странице списка акции. При отсутствии данных содержит пустой массив. | Да || || `total` | `number` | Общее количество вариантов товаров в списке акции, а не только на текущей странице. При отсутствии данных — `0`. | Да || || `productsQuantity` | `number` | Количество единиц товаров по акции, добавленных в корзину. Рассчитывается как сумма `quantity` позиций первого набора с признаком `isLadder`. Если такого набора нет — `0`. Не равно количеству карточек в `items` или количеству разных вариантов товаров. | Да || || `pagination.current` | `number` | Номер текущей страницы из параметра `page` URL. Начинается с `1`. По умолчанию — `1`. | Да || || `pagination.total` | `number` | Общее количество страниц с учетом размера страницы. Для пустого списка — `0`. | Да || || `sorting.value` | `string` | Выбранное значение сортировки из параметра `sorting` URL. Если параметр отсутствует или не соответствует доступным опциям, используется `popularity`. Доступные значения `sorting.value`: * `popularity` — по популярности. * `new` — новые. * `price_asc` — сначала дешевле. * `price_desc` — сначала дороже. * `rating_desc` — по рейтингу; доступно только при включённых отзывах о товарах. | Да || || `sorting.options` | `ProductSortOption[]` | Список доступных опций сортировки. Каждая опция содержит: * `value` — значение для выбора; * `displayText` — подпись; * `sort_by` — поле сортировки; * `sort_order` — направление сортировки. | Да || |# {% note info %} Для компонента `ya-kit-products-sorting` передавайте `model.sorting.value`. В отличие от `ProductsListingModel`, эта модель не содержит поля `sorting.option`. {% endnote %} {% endcut %} Связанные модели: [CartBundleDiscountLadder](#cart-bundle-discount-ladder), [ShoppingCartVariantModel](#VariantModel). ## DOMBoundaryRectModel {#boundary-rect} Модель границ и размеров DOM‑элемента. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `width` | `number` | Ширина элемента. | Да || || `height` | `number` | Высота элемента. | Да || || `top` | `number` | Расстояние от верхнего края `viewport` до верхнего края элемента. | Да || || `left` | `number` | Расстояние от левого края `viewport` до левого края элемента. | Да || || `bottom` | `number` | Расстояние от верхнего края `viewport` до нижнего края элемента. | Да || || `right` | `number` | Расстояние от левого края `viewport` до правого края элемента. | Да || || `x` | `number` | Псевдоним для `left`. | Да || || `y` | `number` | Псевдоним для `top`. | Да || |# {% endcut %} {#e} ## EmailSubscriptionModel {#EmailSubs} Модель формы подписки на рассылку. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `currentStep` | `FORM`, `SUCCESS` | Общее количество статей, соответствующих текущим фильтрам. Значения: - `FORM` — отображается форма для ввода данных. - `SUCCESS` — успешная подписка. | Да || || `email` | `string` | Введенный пользователем адрес электронной почты. | Да || || `agreement` | `boolean` | Состояние чекбокса согласия на обработку персональных данных. | Нет || || `errors.email` | `number` | Сообщение об ошибке валидации адреса электронной почты. | Да || || `errors.agreement` | `number` | Сообщение об ошибке согласия. | Да || |# {% endcut %} {#f} ## FavouriteProductsListingModel {#FavouriteModel} Модель списка избранных товаров с метаданными. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `total` | `number` | Общее количество товаров, соответствующих текущим фильтрам. | Да || || `items` | `ProductSnippetModel[]` | Массив товаров на текущей странице. | Да || |# {% endcut %} Связанные модели: [ProductSnippetModel](#snippet-model). ## FeedbackModel {#feedback-model} Модель отзыва о варианте товара. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `feedbackId` | `string` | Уникальный идентификатор отзыва. | Да || || `pros` | `string` | Достоинства товара, указанные автором отзыва. | Нет || || `cons` | `string` | Недостатки товара, указанные автором отзыва. | Нет || || `comment` | `string` | Основной текст отзыва. | Да || || `userName` | `string` | Имя автора отзыва. | Нет || || `source` | `'YANDEX_MARKET'`, `'OZON'` | Источник отзыва. | Да || || `publishedAt` | `string` | Дата публикации отзыва. | Да || || `rating` | `number` | Оценка товара автором отзыва. | Да || || `media` | `FeedbackMediaItemModel[]` | Изображения и видео, прикреплённые к отзыву. | Да || |# {% endcut %} Связанные модели: [FeedbackMediaItemModel](#feedback-media-item-model). ## FeedbackFilterModel {#filter-model} Модель фильтра списка отзывов. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `title` | `string` | Отображаемое название фильтра. | Да || || `slug` | `string` | Значение фильтра для параметра `filter` URL. | Да || || `feedbackCount` | `number` | Количество отзывов, которые соответствуют фильтру. | Да || |# {% endcut %} ## FeedbackMediaItemModel {#feedback-media-item-model} Модель медиа, которое прикреплено к отзыву. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `feedbackMediaId` | `string` | Уникальный идентификатор медиа в отзыве. | Да || || `feedbackId` | `string` | Идентификатор связанного отзыва. | Да || || `media` | `MediaModel` | Изображение, видео или другой медиафайл. | Да || |# {% endcut %} Связанные модели: * [MediaModel](#media). * [FeedbackModel](#feedback-model). ## FeedbackRatingDistributionModel {#feedback-rating} Модель распределения оценок товара по количеству звезд. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `oneStar` | `number` | Количество оценок в одну звезду. | Да || || `twoStars` | `number` | Количество оценок в две звезды. | Да || || `threeStars` | `number` | Количество оценок в три звезды. | Да || || `fourStars` | `number` | Количество оценок в четыре звезды. | Да || || `fiveStars` | `number` | Количество оценок в пять звёзд. | Да || |# {% endcut %} ## FeedbackShortMetaModel {#feedback-short-meta-model} {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `url` | `string` | Ссылка на страницу всех отзывов товара на текущем домене магазина. Передавайте значение в `url` компонента или `to` ссылки. | Да || || `rating` | `number` | Средний рейтинг товара. | Да || || `feedbackCount` | `number` | Количество всех оценок, включая оценки без текста отзыва. | Да || || `textFeedbackCount` | `number` | Количество отзывов с текстом. | Да || || `ratingDistribution` | `FeedbackRatingDistributionModel` | Распределение оценок по количеству звёзд. | Да || || `source` | `Array<'YANDEX_MARKET', 'OZON'>` | Источники рейтинга и отзывов: Яндекс Маркет (`YANDEX_MARKET`) и Ozon (`OZON`). | Да || || `neuroSummary` | `string` | Нейросетевое саммари отзывов. | Нет || |# {% endcut %} Связанные модели: [FeedbackRatingDistributionModel](#feedback-rating). {#g} ## GroupingCharacteristicModel {#CharacteristicModel} Модель для группирующей характеристики товара, используется для переключения вариантов на странице товара. {% cut "Свойства" %} #| || **Название** | **Тип** | **Описание** | **Обязательное** || || `id` | `string` | Идентификатор характеристики. | Да || || `slug` | `string` | ЧПУ‑идентификатор характеристики. | Да || || `title` | `string` | Отображаемое название характеристики. Пример: «Цвет», «Размер». | Да || || `image` | `ImageModel` | Определяет способ отображения значений характеристики в интерфейсе. Возможные значения: * `SELECT` — значения отображаются в виде выпадающего списка (`