Информация о модели

Описание

GET /{version}/models/{id}

Возвращает информацию о модели

URL ресурса:

https://api.content.market.yandex.ru/{version}/models/{id}

Входные данные

Параметр Положе­ние Тип Обяза­тельность Описание
version PATH Enum Да

Версия API.

id PATH Int64 Да

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

fields QUERY Enum list Нет

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

Возможные значения:
  • CATEGORY — Информация о категории, к которой относится модель
  • DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
  • DISCOUNTS — информация о скидках на модель.
  • FACTS — Список достоинств и недостатков модели
  • FILTERS — список фильтров, доступных для отбора модификаций модели.
  • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».

    По умолчанию выводится информация о первых 12 производителях.

  • FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
  • FILTER_DESCRIPTION — описания фильтров.
  • FILTER_FOUND — количество моделей или товарных предложений:
    • found — если применить это значение фильтра с текущими условиями фильтрации.

    • initialFound — если применить только это значение фильтра без других фильтров.

  • FILTER_SORTS — включение в выдачу доступных фильтров.
  • FILTER_STATISTICS — Обогащение информацией статистикой по фильтрам
  • MEDIA — информация об отзывах и обзорах на модель.
  • MODIFICATIONS — краткая информация о модификациях (для групповой модели).
  • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
  • NAVIGATION_NODE_DATASOURCE — источник данных узла навигационного дерева.
  • NAVIGATION_NODE_ICONS — иконки навигационного дерева.
  • NAVIGATION_NODE_STATISTICS — статистика узла навигационного дерева.
  • OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
  • OFFER_ACTIVE_FILTERS — активные фильтры.
  • OFFER_CATEGORY — информация о категории предложения.
  • OFFER_DELIVERY — информация о доставке.
  • OFFER_DISCOUNT — скидка.
  • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
  • OFFER_OUTLET — информация о точке выдачи производетеля.
  • OFFER_PHOTO — фото предложения.
  • OFFER_SHOP — магазин от которого поступило предложенение.
  • OFFER_VENDOR — информация о поставщике.
  • PHOTO — Изображение модели, используемое как основное изображение на карточке модели
  • PHOTOS — все доступные изображения модели.
  • PRICE — информация о ценах на модель.
  • RATING — иформация о рейтинге и оценках модели.
  • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
  • SHOP_RATING — рейтинг магазина.
  • SPECIFICATION — характеристики модели.
  • VENDOR — информация о производителе.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
  • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_PHOTO_PICKER, FILTER_SORTS, FILTER_STATISTICS
  • NAVIGATION_NODE_ALL = NAVIGATION_NODE_DATASOURCE, NAVIGATION_NODE_ICONS, NAVIGATION_NODE_STATISTICS
  • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, OFFER_SUPPLIER, OFFER_VENDOR
  • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
  • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, PHOTO, PRICE, RATING, SHOP_RATING, VENDOR
  • VENDOR_ALL = VENDOR_LINK
Значение по умолчанию: CATEGORY, PHOTO.
format QUERY Enum Нет

Формат выходных данных.

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .
{filter_id} QUERY String or int64 Нет

Параметры задают условия фильтрации моделей и предложений на модель.

Чтобы задать фильтр необходимо добавить в запрос параметр следующего вида: {filter_id}={filter_value}.

Пример: 7980557=18446744073709529154, где

  • 7980557 — идентификатор фильтра;
  • 18446744073709529154 — значение фильтра.

Получить список фильтров, их идентификаторов и значений для определенной категории можно с помощью ресурса /{version}/categories/{id}/filters.

Значение параметра зависит от типа выбранного фильтра.

Допускается множество параметров.

Ограничения:
  • Для типа фильтра BOOLEAN — допустимые значения фильтра:
    • 1 | T | TRUE | Y | YES — равно TRUE.
    • 0 | F | FALSE | N | NO — равно FALSE.
  • Для типов фильтров ENUM, COLOR, SIZE — {filter_value} определяет список идентификаторов значений фильтра, разделенных запятыми, {value1_id},{value2_id},{value3_id}, где {valueN_id} — идентификатор значения.

  • Для типа фильтра NUMBER — {filter_value} определяет числовой диапазон значений, границы которого разделяются знаком ~ тильда. Форматы значений параметра:
    • {min_value}~ - с тильдой в конце - определяет только нижнюю границу фильтра.
    • ~{max_value} - с тильдой в начале - определяет только верхнюю границу фильтра.
    • {min_value}~{max_value} - с тильдой между числами - определяет нижнюю и вехнюю границы фильтра.
  • Для типа фильтра RADIO — {filter_value} определяет один идентификатор значения фильтра.

  • Для типа фильтра TEXT — {filter_value} определяет текстовую строку поиска.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

{
  "status" : "{enum}",
  "context" : {
    "region" : {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        Содержимое объекта
      }
    },
    "currency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "alternateCurrency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "warnings" : [
      {
        "type" : "{string}",
        "code" : "{string}",
        "message" : "{string}"
      },
      ...
    ],
    "id" : "{string}",
    "time" : "{date}",
    "link" : "{string}",
    "marketUrl" : "{string}"
  },
  "model" : {
    Содержимое объекта
  }
}

Описание параметров:

Параметр для формата JSON Параметр для формата XML Тип Описание
status status

Enum

Статус обработки запроса.

Возможные значения:
  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

context context

Object

Контекст обработки запроса.

model model

Object

Информация о модели

Модель

result-context-v2 Параметры, вложенные в context
id id

String

Уникальный идентификатор запроса.

time time

Date

Дата и время выполнения запроса в формате ISO 8601.

link link

String

Ссылка на текущий запрос.

marketUrl marketUrl

String

Ссылка на Яндекс.Маркет.

region region

Object

Информация о регионе запроса.

currency currency

Object

Валюта запроса.

alternateCurrency alternateCurrency

Object

Альтернативная валюта запроса.

warnings warnings

Object list

Список предупреждений, возникших при обработке запроса.

Предупреждение может быть связано с некритичной ошибкой, позволяющей продолжить обработку запроса. При этом результат может частично не соответствовать параметрам запроса.

region-v2 Параметры, вложенные в context/region
id id

Int32

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

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

country country

Object

Страна, к которой относится регион.

Регион

currency-v2 Параметры, вложенные в context/currency, context/alternateCurrency
id id

String

Код валюты.

name name

String

Название валюты.

warning Параметры, вложенные в context/warnings
type type

String

Тип предупрежедния.

code code

String

Код предупреждения.

message message

String

Сообщение с описанием предупреждения.

Возможные ошибки

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.