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

Поиск магазина по хосту или URL

Краткое содержание

Описание

/shops

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

Можно дополнительно задать регион поиска магазина.

URL ресурса:

https://api.content.market.yandex.ru/v1/shops.[format]

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

ПараметрТипЗначение
Обязательные
fields Строка

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

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

  • пустое значение — в выходных данных будут идентификатор магазина и его название;

  • juridical — юридическая информация о магазине;

  • rating  — рейтинг и количество оценок магазина.

В значении параметра можно комбинировать параметры, разделяя их запятой. Например, fields=juridical,rating.

host Строка

Хост или URL магазина, который требуется найти.

Внимание! 

При поиске поддомен (включая www) не отбрасывается.

Если в параметре host вы указали www.media.seller.ru, магазин media.seller.ru найден не будет.

Если в параметре host вы указали media.seller.ru, магазин seller.ru найден не будет.

Необязательные

geo_id

Integer

Идентификатор региона, в котором необходимо найти указанный магазин.

Примечание. Если в запросе не указать идентификатор региона, выводится информация о найденных магазинах во всех регионах.

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

Структура выходных данных:

Внимание! В выходных данных выводятся служебные параметры, которые не описаны в таблице.
<result
[no-highlight[

Значение

Описание найденного магазина и список его параметров.

Параметр выводится только для формата XML.

]no-highlight]
time
[no-highlight[

Значение

Время ответа API в миллисекундах.

Для формата XML является атрибутом параметра result.

]no-highlight]
="{время_ответа_API}"> <shops
[no-highlight[

Значение

Описание магазина с указанными во входных данных параметрами.

]no-highlight]
> <shop id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра shop.

]no-highlight]
="{идентификатор_магазина}"> <createdAt
[no-highlight[

Значение

Дата регистрации магазина на Маркете.

Формат: ГГГГ-ММ-ДД.

]no-highlight]
>{дата_регистрации_магазина}</createdAt> <factAddress
[no-highlight[

Значение

Фактический адрес магазина.

]no-highlight]
>{фактический_адрес}</factAddress> <gradeTotal
[no-highlight[

Значение

Количество оценок магазина.

]no-highlight]
>{количество_оценок}</gradeTotal> <juridicalAddress
[no-highlight[

Значение

Юридический адрес магазина.

]no-highlight]
>{юридический_адрес}</juridicalAddress> <name
[no-highlight[

Значение

Юридическое название магазина.

]no-highlight]
>{юридическое_название_магазина}</name> <ogrn
[no-highlight[

Значение

Регистрационный номер юридического лица.

]no-highlight]
>{регистрационный_номер}</ogrn> <rating
[no-highlight[

Значение

Рейтинг магазина.

]no-highlight]
>{значение_рейтинга}</rating> <regionId
[no-highlight[

Значение

Идентификатор региона, в котором находится магазин.

]no-highlight]
>{идентификатор_региона}</regionId> <shopName
[no-highlight[

Значение

Название магазина.

]no-highlight]
>{название_магазина}</shopName> <status
[no-highlight[

Значение

Статус магазина на Маркете.

]no-highlight]
>{статус_магазина_на_Маркете}</status> <type
[no-highlight[

Значение

Тип организации.

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

  • CHP — частный предприниматель (ЧП);

  • IP — индивидуальный предприниматель (ИП);

  • NONE — тип организации не указан;

  • OOO — общество с ограниченной ответственностью (ООО);

  • OTHER — другой тип организации;

  • PBOUL — предприятие без образования юридического лица (ПБОЮЛ);

  • ZAO — закрытое акционерное общество (ЗАО).

]no-highlight]
>{тип_организации}</type> <url
[no-highlight[

Значение

URL, содержащий контактную информацию магазина.

Примечание. Параметр может быть пустым, если магазин не добавил контактную информацию.
]no-highlight]
>{URL}</url> </shop> </shops> </result>
{
  "time
[no-highlight[

Значение

Время ответа API в миллисекундах.

Для формата XML является атрибутом параметра result.

]no-highlight]
": {время_ответа_API}, "shops
[no-highlight[

Значение

Описание магазина с указанными во входных данных параметрами.

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

Значение

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

Для формата XML является атрибутом параметра shop.

]no-highlight]
": {идентификатор_магазина}, "createdAt
[no-highlight[

Значение

Дата регистрации магазина на Маркете.

Формат: ГГГГ-ММ-ДД.

]no-highlight]
": "{дата_регистрации_магазина}", "factAddress
[no-highlight[

Значение

Фактический адрес магазина.

]no-highlight]
": "{фактический_адрес}", "gradeTotal
[no-highlight[

Значение

Количество оценок магазина.

]no-highlight]
": {количество_оценок}, "juridicalAddress
[no-highlight[

Значение

Юридический адрес магазина.

]no-highlight]
": "{юридический_адрес}", "name
[no-highlight[

Значение

Юридическое название магазина.

]no-highlight]
": "{юридическое_название_магазина}", "ogrn
[no-highlight[

Значение

Регистрационный номер юридического лица.

]no-highlight]
": "{регистрационный_номер}", "rating
[no-highlight[

Значение

Рейтинг магазина.

]no-highlight]
": {значение_рейтинга}, "regionId
[no-highlight[

Значение

Идентификатор региона, в котором находится магазин.

]no-highlight]
": {идентификатор_региона}, "shopName
[no-highlight[

Значение

Название магазина.

]no-highlight]
": "{название_магазина}", "status
[no-highlight[

Значение

Статус магазина на Маркете.

]no-highlight]
": "{статус_магазина_на_Маркете}", "type
[no-highlight[

Значение

Тип организации.

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

  • CHP — частный предприниматель (ЧП);

  • IP — индивидуальный предприниматель (ИП);

  • NONE — тип организации не указан;

  • OOO — общество с ограниченной ответственностью (ООО);

  • OTHER — другой тип организации;

  • PBOUL — предприятие без образования юридического лица (ПБОЮЛ);

  • ZAO — закрытое акционерное общество (ЗАО).

]no-highlight]
": "{тип_организации}", "url
[no-highlight[

Значение

URL, содержащий контактную информацию магазина.

Примечание. Параметр может быть пустым, если магазин не добавил контактную информацию.
]no-highlight]
": "{URL}" } ] }

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

Параметр для формата XMLПараметр для формата JSONТипЗначение
result

Описание найденного магазина и список его параметров.

Параметр выводится только для формата XML.

Параметры, вложенные в result
time time Число

Время ответа API в миллисекундах.

Для формата XML является атрибутом параметра result.

shops shops

Описание магазина с указанными во входных данных параметрами.

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

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

Для формата XML является атрибутом параметра shop.

createdAt createdAt Date

Дата регистрации магазина на Маркете.

Формат: ГГГГ-ММ-ДД.

factAddress factAddress Строка

Фактический адрес магазина.

gradeTotal gradeTotal Число

Количество оценок магазина.

juridicalAddress juridicalAddress Строка

Юридический адрес магазина.

name name String

Юридическое название магазина.

ogrn ogrn String

Регистрационный номер юридического лица.

rating rating Число

Рейтинг магазина.

regionId regionId Число

Идентификатор региона, в котором находится магазин.

shopName shopName Строка

Название магазина.

status status String

Статус магазина на Маркете.

type type Enum

Тип организации.

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

  • CHP — частный предприниматель (ЧП);

  • IP — индивидуальный предприниматель (ИП);

  • NONE — тип организации не указан;

  • OOO — общество с ограниченной ответственностью (ООО);

  • OTHER — другой тип организации;

  • PBOUL — предприятие без образования юридического лица (ПБОЮЛ);

  • ZAO — закрытое акционерное общество (ЗАО).

url url String

URL, содержащий контактную информацию магазина.

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

Описания ошибок

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

Примеры

Пример запроса:

GET https://api.content.market.yandex.ru/v1/shops.xml?fields=juridical,rating&host=muromec.ru&geo_id=10649

Пример ответа:

<result time="1447421818500">
  <shops>
    <shop id="195111">
      <createdAt>2001-04-23</createdAt>
      <factAddress>309502 г. Старый Оскол, мкр-н Дубрава, квартал 1, д. 22</factAddress>
      <gradeTotal>63689</gradeTotal>
      <juridicalAddress>г. Москва, ул. Нижняя Красносельская, д. 32/10, к. 20</juridicalAddress>
      <name>Илья Муромец Менеджмент</name>
      <ogrn>1057246840111</ogrn>
      <rating>4</rating>
      <regionId>10649</regionId>
      <shopName>Илья Муромец Старый Оскол</shopName>
      <status>actual</status>
      <type>OOO</type>
      <url>www.muromec.ru</url>
    </shop>
  </shops>
</result>

Пример запроса:

GET https://api.content.market.yandex.ru/v1/shops.json?fields=juridical,rating&host=muromec.ru&geo_id=10649

Пример ответа:

{
  "time": 1447422415559,
  "shops":
  [
    {
      "id": 195111,
      "createdAt": "2001-04-23",
      "factAddress": "309502 г. Старый Оскол, мкр-н Дубрава, квартал 1, д. 22",
      "gradeTotal": 63689,
      "juridicalAddress": "г. Москва, ул. Нижняя Красносельская, д. 32/10, к. 20",
      "name": "Илья Муромец Менеджмент",
      "ogrn": "1057246840111",
      "rating": 4,
      "regionId": 10649,
      "shopName": "Илья Муромец Старый Оскол",
      "status": "actual",
      "type": "OOO",
      "url": "www.muromec.ru"
    }
  ]
}
shops Поиск магазина по хосту или URL