ApiSystem – Контент-менеджер
для Вашего интернет-магазина


Документация
  • Категории
    • Список категорий
    • Список подкатегорий
    • Информация о категории
    • Список фильтров категории
  • Модели товаров
    • Информация о модели
    • Список обзоров на модель
    • Список популярных моделей
    • Список предложений на модель
  • Товарные предложения
    • Информация о товарном предложении
  • Отзывы
    • Отзывы о модели
    • Отзывы о магазине
  • Магазины
    • Информация о магазине
    • Количество магазинов, работающих в регионе
  • Пункты выдачи товаров
    • Список пунктов выдачи модели
    • Пункты выдачи товаров магазина
  • Регионы
    • Список регионов
    • Список дочерних регионов
    • Информация о регионе
    • Текстовый поиск региона
  • Поиск и подбор по параметрам
    • Текстовый поиск
    • Подбор по параметрам в категории

Список категорий

Описание

GET /{version}/categories

Возвращает список категорий первого уровня (корневых) товарного дерева.

URL ресурса:

http://market.apisystem.name/{version}/categories

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

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

Версия API.

fields QUERY Enum list Нет

Параметры категории, которые необходимо показать в выходных данных.

Возможные значения:
  • PARENT — информация о родительской категории.
  • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
  • WARNINGS — предупреждения, связанные с показом категории.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
format QUERY Enum Нет

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

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

Тип сортировки категорий.

Возможные значения:
  • BY_NAME — сортировка категорий в алфавитном порядке;
  • BY_OFFERS_NUM — сортировка по количеству товарных предложений в каждой категории;
  • NONE — сортировка по умолчанию.
Значение по умолчанию: NONE.
Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1

Значение по умолчанию: 1.

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

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

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

Enum

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

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

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

context context

Object

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

categories categories

Object list

Список категорий.

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

String

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

time time

Date

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

link link

String

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

marketUrl marketUrl

String

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

region region

Object

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

currency currency

Object

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

alternateCurrency alternateCurrency

Object

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

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

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

String

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

span span

String

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

message message

String

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

Параметры, вложенные в categories
id id

Int32

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

name name

String

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

fullName fullName

String

Полное наименование категории.

parent parent

Int32

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

adult adult

Boolean

Признак категории, имеющей возрастное ограничение (18+).

link link

String

Ссылка на карточку категории на Яндекс.Маркете.

childCount childCount

Int32

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

modelCount modelCount

Int32

Количество моделей в категории.

offerCount offerCount

Int32

Количество товарных предложений в категории.

advertisingModel advertisingModel

Enum

Тип размещения товарных предложений в категории.

Возможные значения:
  • CPA — плата за заказы, оформленные прямо на Яндекс.Маркете.

  • CPC — плата только за клики по предложению магазина.

  • HYBRID — возможны оба варианта размещения товарных предложений в категории.

viewType viewType

Enum

Тип отображения товаров в категории.

Возможные значения:
  • LIST — список.

  • GRID — сетка.

warnings warnings

Object list

Предупреждения, связанные с категорией.

Параметры, вложенные в categories/warnings
text text

String

Текст предупреждения.

shortText shortText

String

Краткий текст предупреждения.

Предназначен для устройств с узким экраном.

age age

Int32

Возрастное ограничение для категории.

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

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

Список подкатегорий

Описание

GET /{version}/categories/{id}/children

Возвращает список категорий товарного дерева, вложенных в категорию с указанным в запросе идентификатором.

Ресурс является списочным.

URL ресурса:

http://market.apisystem.name/{version}/categories/{id}/children

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

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

Версия API.

id PATH Int32 Да

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

fields QUERY Enum list Нет

Параметры категории, которые необходимо показать в выходных данных.

Возможные значения:
  • PARENT — информация о родительской категории.
  • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
  • WARNINGS — предупреждения, связанные с показом категории.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
format QUERY Enum Нет

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

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

Тип сортировки категорий.

Возможные значения:
  • BY_NAME — сортировка категорий в алфавитном порядке;
  • BY_OFFERS_NUM — сортировка по количеству товарных предложений в каждой категории;
  • NONE — сортировка по умолчанию.
Значение по умолчанию: NONE.
Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1

Значение по умолчанию: 1.

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

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

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

Enum

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

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

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

context context

Object

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

categories categories

Object list

Список категорий.

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

String

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

time time

Date

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

link link

String

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

marketUrl marketUrl

String

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

region region

Object

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

currency currency

Object

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

alternateCurrency alternateCurrency

Object

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

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

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

String

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

span span

String

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

message message

String

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

Параметры, вложенные в categories
id id

Int32

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

name name

String

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

fullName fullName

String

Полное наименование категории.

parent parent

Int32

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

adult adult

Boolean

Признак категории, имеющей возрастное ограничение (18+).

link link

String

Ссылка на карточку категории на Яндекс.Маркете.

childCount childCount

Int32

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

modelCount modelCount

Int32

Количество моделей в категории.

offerCount offerCount

Int32

Количество товарных предложений в категории.

advertisingModel advertisingModel

Enum

Тип размещения товарных предложений в категории.

Возможные значения:
  • CPA — плата за заказы, оформленные прямо на Яндекс.Маркете.

  • CPC — плата только за клики по предложению магазина.

  • HYBRID — возможны оба варианта размещения товарных предложений в категории.

viewType viewType

Enum

Тип отображения товаров в категории.

Возможные значения:
  • LIST — список.

  • GRID — сетка.

warnings warnings

Object list

Предупреждения, связанные с категорией.

Параметры, вложенные в categories/warnings
text text

String

Текст предупреждения.

shortText shortText

String

Краткий текст предупреждения.

Предназначен для устройств с узким экраном.

age age

Int32

Возрастное ограничение для категории.

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

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

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

Описание

GET /{version}/models/{id}

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

URL ресурса:

http://market.apisystem.name/{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_OTO — фото предложения.
  • OFFER_SHOP — магазин от которого поступило предложенение.
  • OFFER_VENDOR — информация о поставщике.
  • OTO — Изображение модели, используемое как основное изображение на карточке модели
  • OTOS — все доступные изображения модели.
  • PRICE — информация о ценах на модель.
  • RATING — иформация о рейтинге и оценках модели.
  • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
  • SHOP_RATING — рейтинг магазина.
  • SPECIFICATION — характеристики модели.
  • VENDOR — информация о производителе.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
  • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_OTO_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_OTO, OFFER_SHOP, OFFER_SUPPLIER, OFFER_VENDOR
  • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
  • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OTO, OFFER_SHOP, OTO, PRICE, RATING, SHOP_RATING, VENDOR
  • VENDOR_ALL = VENDOR_LINK
Значение по умолчанию: CATEGORY, OTO.
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} определяет текстовую строку поиска.

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

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

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

Enum

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

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

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

context context

Object

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

model model

Object

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

Модель

Параметры, вложенные в 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

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

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

String

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

span span

String

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

message message

String

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

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

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

Информация о категории

Описание

GET /{version}/categories/{id}

Возвращает информацию об указанной категории по ее идентификатору.

URL ресурса:

http://market.apisystem.name/{version}/categories/{id}

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

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

Версия API.

id PATH Int32 Да

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

fields QUERY Enum list Нет

Параметры категории, которые необходимо показать в выходных данных.

Возможные значения:
  • PARENT — информация о родительской категории.
  • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
  • WARNINGS — предупреждения, связанные с показом категории.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
format QUERY Enum Нет

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

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .

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

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

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

Enum

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

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

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

context context

Object

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

category category

Object

Информация о категории.

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

String

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

time time

Date

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

marketUrl marketUrl

String

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

region region

Object

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

currency currency

Object

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

alternateCurrency alternateCurrency

Object

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

warnings warnings

Object list

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

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

String

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

span span

String

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

message message

String

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

Параметры, вложенные в category
id id

Int32

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

name name

String

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

fullName fullName

String

Полное наименование категории.

parent parent

Int32

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

adult adult

Boolean

Признак категории, имеющей возрастное ограничение (18+).

link link

String

Ссылка на карточку категории на Яндекс.Маркете.

childCount childCount

Int32

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

modelCount modelCount

Int32

Количество моделей в категории.

offerCount offerCount

Int32

Количество товарных предложений в категории.

advertisingModel advertisingModel

Enum

Тип размещения товарных предложений в категории.

Возможные значения:
  • CPA — плата за заказы, оформленные прямо на Яндекс.Маркете.

  • CPC — плата только за клики по предложению магазина.

  • HYBRID — возможны оба варианта размещения товарных предложений в категории.

viewType viewType

Enum

Тип отображения товаров в категории.

Возможные значения:
  • LIST — список.

  • GRID — сетка.

warnings warnings

Object list

Предупреждения, связанные с категорией.

Параметры, вложенные в category/warnings
text text

String

Текст предупреждения.

shortText shortText

String

Краткий текст предупреждения.

Предназначен для устройств с узким экраном.

age age

Int32

Возрастное ограничение для категории.

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

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

Список фильтров категории

Описание

GET /{version}/categories/{id}/filters

Возвращает список фильтров для фильтрации моделей и товарных предложений в указанной категории. В качестве входных данных можно укзать идентификатор категории второго и  более уровней вложенности. Указание фильтров во входных данных позволяет получить статистику по количеству моделей и товарных предложений, подпадающих под указанные условия фильтрации.

URL ресурса:

http://market.apisystem.name/{version}/categories/{id}/filters

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

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

Версия API.

id PATH Int32 Да

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

fields QUERY Enum list Нет

Группы параметров, которые необходимо отобразить в выходных данных.

Возможные значения:
  • ALLVENDORS — группа параметров для фильтра «Производитель».

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

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

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

  • SORTS — включение в выдачу доступных фильтров.
  • STATISTICS — Обогащение информацией статистикой по фильтрам
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
filter_set QUERY Enum Нет
Определяет набор фильтров в выходных данных.
Примечание. Значение BASIC равнозначно POPULAR.
Возможные значения:
  • ALL — все фильтры.
  • BASIC — базовый набор фильтров.
  • POPULAR — только популярные фильтры.
Значение по умолчанию: POPULAR.
format QUERY Enum Нет

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

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

Поле содержащее закодированную информацию о текстовом запросе после редиректа, на которую будет ориентироватся поиск.

sort QUERY Enum Нет

Задает тип сортировки значений в фильтрах.

Возможные значения:
  • NAME — сортировка по имени.
  • NONE — сортировка отсутствует.
Значение по умолчанию: NONE.
{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} определяет текстовую строку поиска.

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

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

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

Enum

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

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

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

context context

Object

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

sorts sorts

Object list

Список сортировок.

filters filters

Object list

Список фильтров.

Типы:
  • Фильтр.
  • Фильтр со значениями.
  • Числовой фильтр
Параметры, вложенные в context
id id

String

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

time time

Date

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

link link

String

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

marketUrl marketUrl

String

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

region region

Object

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

currency currency

Object

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

alternateCurrency alternateCurrency

Object

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

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

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

String

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

span span

String

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

message message

String

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

Параметры, вложенные в sorts
text text

String

Наименование типа сортировки.

field field

Enum

Тип сортировки.

Возможные значения:
  • RELEVANCY — сортировка по релевантности.

  • PRICE — сортировка по цене.

  • RATING — сортировка по рейтингу.

  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).

  • POPULARITY — сортировка по популярности.

  • DISCOUNT — сортировка по размеру скидки.
    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).
  • QUALITY — сортировка по рейтингу.

  • OPINIONS — сортировка по количеству отзывов.

  • DATE — сортировка по дате.

  • DELIVERY_TIME — сортировка по времени доставки.

  • NOFFERS — сортировка по количеству предложений

options options

Object list

Доступные варианты для данного типа сортировки.

Параметры, вложенные в sorts/options
id id

String

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

how how

Enum

Направление сортировки.

Возможные значения:
  • ASC — по возрастанию;

  • DESC — по убыванию.

text text

String

Наименование данного варианта сортировки

Параметры, вложенные в filters Типы: Фильтр., Фильтр со значениями., Числовой фильтр
id id

String

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

name name

String

Наименование фильтра.

type type

String

Тип фильтра.

Возможные значения:
  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.
description description

String

Описание фильтра.

unit unit

String

Единицы измерения значений фильтра.

defaultUnit defaultUnit

String

Код единиц измерения значений фильтра, используемых по умолчанию.

values values

Object list

Список значений фильтра

Типы:
  • Значение фильтра
  • Значение COLOR фильтра
  • Значение SIZE фильтра
  • Значение Filters.FilterType#OTO_PICKER фильтра
max max

String

Максимальное значение числового фильтра

min min

String

Минимальное значение числового фильтра

value value

String

Выбранное значение числового фильтра

precision precision

Int32

Кол-во знаков поле запятой у значений фильтра

Параметры, вложенные в filters/values Типы: Значение фильтра, Значение COLOR фильтра, Значение SIZE фильтра, Значение Filters.FilterType#OTO_PICKER фильтра
id id

String

Идентификатор значения фильтра, используется для установки значения фильтра

name name

String

Текстовое описание значение фильтра

initialFound initialFound

Int64

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

found found

Int64

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

checked checked

Boolean

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

color color

String

Значение цвета
Внимание. Только для фильтров типов COLOR и Filters.FilterType#OTO_PICKER
unitId unitId

String

Код единицы измерения размера значения фильтра
Внимание. Только для фильтра типа SIZE
oto oto

String

Ссылку на картинку для выбора цвета
Внимание. Только для фильтра типа Filters.FilterType#OTO_PICKER

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

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

Список обзоров на модель

Описание

GET /{version}/models/{id}/reviews

Ресурс является списочным.

URL ресурса:

http://market.apisystem.name/{version}/models/{id}/reviews

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

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

Версия API.

id PATH Int64 Да

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

format QUERY Enum Нет

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

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .
Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1

Значение по умолчанию: 1.

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

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

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

Enum

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

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

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

context context

Object

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

reviews reviews

Object list

Список обзоров на модель

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

String

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

time time

Date

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

marketUrl marketUrl

String

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

region region

Object

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

currency currency

Object

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

alternateCurrency alternateCurrency

Object

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

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

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

String

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

span span

String

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

message message

String

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

Параметры, вложенные в reviews
url url

String

URL обзорной статьи на модель

title title

String

Заголовок обзора на модель

favIcon favIcon

String

URL значка веб-сайта с обзором на модель

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

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

Список предложений на модель

Описание

GET /{version}/models/{id}/offers

Возвращает список товарных предложений, соотнесенных с указанной моделью.

Ресурс является списочным.

URL ресурса:

http://market.apisystem.name/{version}/models/{id}/offers

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

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

Версия API.

id PATH Int64 Да

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

delivery_included QUERY Boolean Нет

Признак включения цены доставки в цену товарного предложения.

Возможные значения:
  • 0 | F | FALSE | N | NO — ЛОЖЬ
  • 1 | T | TRUE | Y | YES — ИСТИНА
Значение по умолчанию: ЛОЖЬ.
fields QUERY Enum list Нет

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

Возможные значения:
  • FILTERS — Список фильтров в результатах запроса офферов
  • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».

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

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

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

  • FILTER_SORTS — включение в выдачу доступных фильтров.
  • FILTER_STATISTICS — Обогащение информацией статистикой по фильтрам
  • OFFER_ACTIVE_FILTERS — активные фильтры.
  • OFFER_CATEGORY — информация о категории предложения.
  • OFFER_DELIVERY — информация о доставке.
  • OFFER_DISCOUNT — скидка.
  • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
  • OFFER_OUTLET — информация о точке выдачи производетеля.
  • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
  • OFFER_OTO — фото предложения.
  • OFFER_SHOP — магазин от которого поступило предложенение.
  • OFFER_VENDOR — информация о поставщике.
  • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
  • SHOP_RATING — рейтинг магазина.
  • SORTS — Доступные варианты сортировок для запроса
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
  • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_OTO_PICKER, FILTER_SORTS, FILTER_STATISTICS
  • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_OTO, OFFER_SHOP, OFFER_SUPPLIER, OFFER_VENDOR
  • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
  • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_OTO, OFFER_SHOP, SHOP_RATING
  • VENDOR_ALL = VENDOR_LINK
format QUERY Enum Нет

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

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

Вариант группировки товарных предложений

Возможные значения:
  • NONE — Группировка предложений отключена. В выдаче присутствуют все предложения
  • OFFER — Группировать предложениям
  • SHOP — Группировка предложений осуществляется по магазину. В выдаче присутствует по одному предложению магазина
shop_regions QUERY Int32 list Нет

Идентификаторы регионов магазинов.

{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} определяет текстовую строку поиска.

Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1, максимальное значение: 50

Значение по умолчанию: 1.
Параметры сортировки
how QUERY Enum Нет

Направление сортировки.

Возможные значения:
  • ASC — по возрастанию;
  • DESC — по убыванию.
Значение по умолчанию: Зависит от поля, по которому сортируем (так по цене сортировка по возрастанию, а по популярности по убыванию).
sort QUERY Enum Нет

Тип сортировки товарных предложений

Возможные значения:
  • DATE — сортировка по дате.
  • DELIVERY_TIME — сортировка по времени доставки.
  • DISCOUNT — сортировка по размеру скидки.
    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).
  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).
  • NOFFERS — сортировка по количеству предложений
  • OPINIONS — сортировка по количеству отзывов.
  • POPULARITY — сортировка по популярности.
  • PRICE — сортировка по цене.
  • QUALITY — сортировка по рейтингу.
  • RATING — сортировка по рейтингу.
  • RELEVANCY — сортировка по релевантности.
Значение по умолчанию: RELEVANCY.
Гео-координаты пользователя, для определения региона
Ограничение. Оба парметра должны быть определены совместно. Не допускается указывать один без другого.
latitude QUERY Double Нет

Широта

Ограничения:
  • Минимальное значение: -90.0, максимальное значение: 90.0.

longitude QUERY Double Нет

Долгота

Ограничения:
  • Минимальное значение: -180.0, максимальное значение: 180.0.

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

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

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

Enum

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

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

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

context context

Object

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

offers offers

Object list

Список товарных предложений модели

Предложение

filters filters

Object list

Список фильтров, доступных для фильтрации товарных предложений модели

Типы:
  • Фильтр.
  • Фильтр со значениями.
  • Числовой фильтр
sorts sorts

Object list

Список доступных сортировок товарных предложений модели

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

String

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

time time

Date

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

link link

String

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

marketUrl marketUrl

String

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

region region

Object

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

currency currency

Object

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

alternateCurrency alternateCurrency

Object

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

page page

Object

Информация о параметрах страницы запроса.

processingOptions processingOptions

Object

Опции обработки запроса

warnings warnings

Object list

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

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

Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

Параметры, вложенные в context/processingOptions
adult adult

Boolean

Признак наличия в выдаче информации, имеющей возрастные ограничения 18+

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

String

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

span