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

Количество магазинов, работающих в регионе

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

Описание

regions/{region_id}/shops/summary

Возвращает информацию о количестве магазинов и типах их работы в указанном регионе.

В запросе вместо {region_id} указывается идентификатор региона.

URL ресурса:

https://api.content.market.yandex.ru/v1/regions/{region_id}/shops/summary.[format]

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

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

Информация о количестве магазинов и типах их работы в указанном регионе.

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

  • delivery_count — количество магазинов, которые осуществляют доставку в указанный регион;

  • home_count — количество магазинов, которые находятся в указанном регионе;

  • total_count — общее количество магазинов, которые работают с указанным регионом: находятся в указанном регионе и осуществляют в него доставку.

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

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

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

<shopsSummary
[no-highlight[

Значение

Информация о количестве магазинов и форматах их работы в указанном регионе.

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

]no-highlight]
> <homeCount
[no-highlight[

Значение

Количество магазинов, которые находятся в указанном регионе.

]no-highlight]
>{количество_магазинов_в_указанном_регионе}</homeCount> <deliveryCount
[no-highlight[

Значение

Количество магазинов, которые осуществляют доставку в указанный регион.

]no-highlight]
>{количество_магазинов_осуществляющих_доставку_в_указанный_регион}</deliveryCount> <totalCount
[no-highlight[

Значение

Общее количество магазинов, которые работают в указанном регионе: находятся в указанном регионе и осуществляют в него доставку.

]no-highlight]
>{общее_количество_магазинов_работающих_с_указанным_регионом}</totalCount> </shopsSummary>
{
  "homeCount
[no-highlight[

Значение

Количество магазинов, которые находятся в указанном регионе.

]no-highlight]
": {количество_магазинов_в_указанном_регионе}, "deliveryCount
[no-highlight[

Значение

Количество магазинов, которые осуществляют доставку в указанный регион.

]no-highlight]
": {количество_магазинов_осуществляющих_доставку_в_указанный_регион}, "totalCount
[no-highlight[

Значение

Общее количество магазинов, которые работают в указанном регионе: находятся в указанном регионе и осуществляют в него доставку.

]no-highlight]
": {общее_количество_магазинов_работающих_с_указанным_регионом} }

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

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

Информация о количестве магазинов и форматах их работы в указанном регионе.

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

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

Количество магазинов, которые находятся в указанном регионе.

deliveryCount deliveryCount Число

Количество магазинов, которые осуществляют доставку в указанный регион.

totalCount totalCount Число

Общее количество магазинов, которые работают в указанном регионе: находятся в указанном регионе и осуществляют в него доставку.

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

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

Примеры

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

GET https://api.content.market.yandex.ru/v1/regions/59/shops/summary.xml?fields=delivery_count,home_count,total_count

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

<shopsSummary>
  <homeCount>848</homeCount>
  <deliveryCount>9034</deliveryCount>
  <totalCount>9037</totalCount>
</shopsSummary>

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

GET 
https://api.content.market.yandex.ru/v1/regions/59/shops/summary.json?fields=delivery_count,home_count,total_count

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

{
  "homeCount": 848,
  "deliveryCount": 9042,
  "totalCount": 9045
}
regions/{region_id}/shops/summary Магазины