Руководство разработчика
Ресурсы API

Подбор производителя по названию

Описание

GET /{version}/vendors/match

Возвращает производителя, наиболее подходящего под заданное во входных данных название

URL ресурса:

https://api.content.market.yandex.ru/{version}/vendors/match

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

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

Версия контентного API.

name QUERY String Да

Название производителя, данные которого необходимо найти

fields QUERY Enum list Нет

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

Возможные значения:

  • CATEGORIES — Описание категорий, в которых представлен данный производитель
  • CATEGORY_PARENT — информация о родительской категории.
  • CATEGORY_STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
  • CATEGORY_WARNINGS — предупреждения, связанные с показом категории.
  • TOP_CATEGORIES — Список наиболее популярных категорий товаров производителя

Псевдонимы значений:

  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
  • CATEGORY_ALL = CATEGORY_LINK, CATEGORY_PARENT, CATEGORY_STATISTICS, CATEGORY_WARNINGS

format QUERY Enum Нет

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

Возможные значения:

  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.

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

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

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

{
  "status
[no-highlight[

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

Возможные значения:

  • OK — операция выполнена успешно.

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

]no-highlight]
" : "{enum}", "context
[no-highlight[

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

]no-highlight]
" : { "region
[no-highlight[

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

]no-highlight]
" : { "id
[no-highlight[

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

]no-highlight]
" : {int32}, "name
[no-highlight[

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

]no-highlight]
" : "{string}", "type
[no-highlight[

Тип региона.

Возможные значения:

  • 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 — другой тип населенного пункта.

]no-highlight]
" : "{enum}", "childCount
[no-highlight[

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

]no-highlight]
" : {int32}, "country
[no-highlight[

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

Регион

]no-highlight]
" : { Содержимое объекта } }, "currency
[no-highlight[

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

]no-highlight]
" : { "id
[no-highlight[

Код валюты.

]no-highlight]
" : "{string}", "name
[no-highlight[

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

]no-highlight]
" : "{string}" }, "alternateCurrency
[no-highlight[

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

]no-highlight]
" : { "id
[no-highlight[

Код валюты.

]no-highlight]
" : "{string}", "name
[no-highlight[

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

]no-highlight]
" : "{string}" }, "warnings
[no-highlight[

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

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

]no-highlight]
" : [ { "type
[no-highlight[

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

]no-highlight]
" : "{string}", "code
[no-highlight[

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

]no-highlight]
" : "{string}", "message
[no-highlight[

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

]no-highlight]
" : "{string}" }, ... ], "id
[no-highlight[

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

]no-highlight]
" : "{string}", "time
[no-highlight[

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

]no-highlight]
" : {date}, "link
[no-highlight[

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

]no-highlight]
" : "{string}", "marketUrl
[no-highlight[

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

]no-highlight]
" : "{string}" }, "vendor
[no-highlight[

Информация о производителе

Производитель

]no-highlight]
" : { Содержимое объекта } }
<result status
[no-highlight[

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

Возможные значения:

  • OK — операция выполнена успешно.

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

]no-highlight]
="{enum}"> <context
[no-highlight[

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

]no-highlight]
id
[no-highlight[

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

]no-highlight]
="{string}" time
[no-highlight[

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

]no-highlight]
="{date}" link
[no-highlight[

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

]no-highlight]
="{string}" marketUrl
[no-highlight[

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

]no-highlight]
="{string}"> <region
[no-highlight[

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

]no-highlight]
id
[no-highlight[

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

]no-highlight]
="{int32}" name
[no-highlight[

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

]no-highlight]
="{string}" type
[no-highlight[

Тип региона.

Возможные значения:

  • 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 — другой тип населенного пункта.

]no-highlight]
="{enum}" childCount
[no-highlight[

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

]no-highlight]
="{int32}"> <country
[no-highlight[

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

Регион

]no-highlight]
>Содержимое объекта</country> </region> <currency
[no-highlight[

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

]no-highlight]
id
[no-highlight[

Код валюты.

]no-highlight]
="{string}" name
[no-highlight[

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

]no-highlight]
="{string}"/> <alternateCurrency
[no-highlight[

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

]no-highlight]
id
[no-highlight[

Код валюты.

]no-highlight]
="{string}" name
[no-highlight[

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

]no-highlight]
="{string}"/> <warnings
[no-highlight[

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

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

]no-highlight]
> <warning type
[no-highlight[

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

]no-highlight]
="{string}" code
[no-highlight[

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

]no-highlight]
="{string}" message
[no-highlight[

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

]no-highlight]
="{string}"/> ... </warnings> </context> <vendor
[no-highlight[

Информация о производителе

Производитель

]no-highlight]
>Содержимое объекта</vendor> </result>

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

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

Enum

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

Возможные значения:

  • OK — операция выполнена успешно.

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

context context

Object

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

vendor vendor

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

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

code code

String

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

message message

String

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

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

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

/{version}/vendors/match Подбор производителя по названию Производители