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

Список точек продаж магазина

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

Описание

shop/{shop_id}/outlets

Возвращает список точек продаж указанного в запросе магазина. Ресурс является регионозависимым и списочным.

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

URL ресурса:

https://api.content.market.yandex.ru/v1/shop/{shop_id}/outlets.[format]

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

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

geo_id

Integer

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

Данный параметр является взаимоисключающим с параметром remote_ip.

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

Совет. Если вы не можете определить значение параметра geo_id, передавайте параметр remote_ip.

remote_ip

String

IP-адрес пользователя, по которому определяется его регион для формирования выдачи с учетом региона.

Данный параметр является взаимоисключающим с параметром geo_id.

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

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

boundary

String

Координаты квадрата на местности для выдачи точек продаж на карте.

В значении параметра через точку с запятой укажите координаты нижнего левого и верхнего правого углов квадрата на местности. Например, boundary=37.451642,55.704105;37.720807,55.749056.

count

Integer

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

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

Максимально возможное значение: 30.

latitude

Float

Широта местоположения пользователя.

longitude

Float

Долгота местоположения пользователя.

page

Integer

Номер страницы результатов, которую необходимо показать в ответе.

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

Максимально возможное значение: 50.

type

Enum

Фильтрация результирующих данных по типу точек продаж.

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

Значение по умолчанию: выводятся все точки продаж.

Если задано географическое положение пользователя (параметры latitude и longitude), то в описании каждой точки продаж выводится расстояние от данной точки продаж до пользователя. При этом сортировка точек продаж производится по полученному расстоянию.

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

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

<outlets
[no-highlight[

Значение

Список точек продаж магазина.

]no-highlight]
total
[no-highlight[

Значение

Общее количество результатов в списке.

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

]no-highlight]
="{количество_результатов}" count
[no-highlight[

Значение

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

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

]no-highlight]
="{количество_результатов_на_странице}" page
[no-highlight[

Значение

Номер выводимой страницы результатов.

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

]no-highlight]
="{номер_страницы}"> <outlet
[no-highlight[

Значение

Описание точки продаж/точек продаж.

Каждая точка продаж описывается в отдельном параметре outlet.

]no-highlight]
id
[no-highlight[

Значение

Идентификатор точки продаж.

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

]no-highlight]
="{идентификатор_точки_продаж}" shop-id
[no-highlight[

Значение

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

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

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

Значение

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

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

]no-highlight]
="{название_магазина}" type
[no-highlight[

Значение

Тип точки продаж.

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

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

]no-highlight]
="{тип_точки_продаж}"> <name
[no-highlight[

Значение

Наименование точки продаж.

]no-highlight]
>{наименование_предложения}</name> <phone
[no-highlight[

Значение

Телефон точки продаж.

]no-highlight]
country
[no-highlight[

Значение

Код страны.

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

]no-highlight]
="{код_страны}" city
[no-highlight[

Значение

Код города.

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

]no-highlight]
="{код_города}" number
[no-highlight[

Значение

Номер телефона.

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

]no-highlight]
="{номер_телефона}"/> <schedule
[no-highlight[

Значение

Время работы точки продаж.

Параметр может включать несколько интервалов.

]no-highlight]
> <working-time
[no-highlight[

Значение

Описание интервала времени работы точки продаж.

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

]no-highlight]
day-from
[no-highlight[

Значение

День недели, с которого начинается интервал работы.

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

]no-highlight]
="{номер_дня_недели}" day-till
[no-highlight[

Значение

День недели, которым заканчивается интервал работы.

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

]no-highlight]
="{номер_дня_недели}" time-from
[no-highlight[

Значение

Время начала рабочего дня.

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

]no-highlight]
="{время}" time-till
[no-highlight[

Значение

Время окончания рабочего дня.

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

]no-highlight]
="{время}"/> ... </schedule> <description
[no-highlight[

Значение

Описание точки продаж.

]no-highlight]
>{описание}</description> <contacts-page
[no-highlight[

Значение

URL, по которому размещена информация о точке продаж.

]no-highlight]
>{URL_точки_продаж}</contacts-page> <geo
[no-highlight[

Значение

Информация о географическом местоположении точки продаж.

]no-highlight]
latitude
[no-highlight[

Значение

Широта местоположения.

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

]no-highlight]
="{широта_местоположения}" longitude
[no-highlight[

Значение

Долгота местоположения.

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

]no-highlight]
="{долгота_местоположения}" distance
[no-highlight[

Значение

Расстояние от точки продаж до пользователя.

Указывается, если в запросе задано местоположение пользователя.

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

]no-highlight]
="{расстояние}"> <geo-id
[no-highlight[

Значение

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

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

Значение

Адрес точки продаж.

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

]no-highlight]
country
[no-highlight[

Значение

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

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

]no-highlight]
="{название_страны}" locality
[no-highlight[

Значение

Наименование населенного пункта.

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

]no-highlight]
="{название_населенного_пункта}" street
[no-highlight[

Значение

Наименование улицы.

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

]no-highlight]
="{название_улицы}" premise-number
[no-highlight[

Значение

Номер дома.

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

]no-highlight]
="{номер_дома}" building-number
[no-highlight[

Значение

Номер строения.

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

]no-highlight]
="{номер_строения}" block-number
[no-highlight[

Значение

Корпус дома.

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

]no-highlight]
="{корпус}" office-number
[no-highlight[

Значение

Номер офиса.

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

]no-highlight]
="{номер_офиса}"/> </outlet> ... </outlets>
{
  "outlets
[no-highlight[

Значение

Список точек продаж магазина.

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

Значение

Общее количество результатов в списке.

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

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

Значение

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

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

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

Значение

Номер выводимой страницы результатов.

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

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

Значение

Описание точки продаж/точек продаж.

Каждая точка продаж описывается в отдельном параметре outlet.

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

Значение

Идентификатор точки продаж.

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

]no-highlight]
": "{идентификатор_точки_продаж}", "shopId
[no-highlight[

Значение

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

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

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

Значение

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

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

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

Значение

Тип точки продаж.

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

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

]no-highlight]
": "{тип_точки_продаж}", "pointName
[no-highlight[

Значение

Наименование точки продаж.

]no-highlight]
": "{наименование_предложения}", "phone
[no-highlight[

Значение

Телефон точки продаж.

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

Значение

Код страны.

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

]no-highlight]
": "{код_страны}", "city
[no-highlight[

Значение

Код города.

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

]no-highlight]
": "{код_города}", "number
[no-highlight[

Значение

Номер телефона.

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

]no-highlight]
": "{номер_телефона}" }, "schedule
[no-highlight[

Значение

Время работы точки продаж.

Параметр может включать несколько интервалов.

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

Значение

День недели, с которого начинается интервал работы.

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

]no-highlight]
": "{номер_дня_недели}", "workingDaysTill
[no-highlight[

Значение

День недели, которым заканчивается интервал работы.

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

]no-highlight]
": "{номер_дня_недели}", "workingHoursFrom
[no-highlight[

Значение

Время начала рабочего дня.

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

]no-highlight]
": "{время}", "workingHoursTill
[no-highlight[

Значение

Время окончания рабочего дня.

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

]no-highlight]
": "{время}" }, ... ], "pointDescription
[no-highlight[

Значение

Описание точки продаж.

]no-highlight]
": "{описание}", "contactsPage
[no-highlight[

Значение

URL, по которому размещена информация о точке продаж.

]no-highlight]
": {URL_точки_продаж}, "geo
[no-highlight[

Значение

Информация о географическом местоположении точки продаж.

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

Значение

Широта местоположения.

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

]no-highlight]
": "{широта_местоположения}", "longitude
[no-highlight[

Значение

Долгота местоположения.

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

]no-highlight]
": "{долгота_местоположения}", "distance
[no-highlight[

Значение

Расстояние от точки продаж до пользователя.

Указывается, если в запросе задано местоположение пользователя.

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

]no-highlight]
": {расстояние}, "geoId
[no-highlight[

Значение

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

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

Значение

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

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

]no-highlight]
": "{название_страны}", "localityName
[no-highlight[

Значение

Наименование населенного пункта.

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

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

Значение

Наименование улицы.

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

]no-highlight]
": "{название_улицы}", "premiseNumber
[no-highlight[

Значение

Номер дома.

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

]no-highlight]
": "{номер_дома}", "building
[no-highlight[

Значение

Номер строения.

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

]no-highlight]
": "{номер_строения}", "block
[no-highlight[

Значение

Корпус дома.

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

]no-highlight]
": "{корпус}", "officeNumber
[no-highlight[

Значение

Номер офиса.

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

]no-highlight]
": "{номер_офиса}" }, ... ] } }

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

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

Список точек продаж магазина.

Параметры, вложенные в outlets
total total Integer

Общее количество результатов в списке.

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

count count Integer

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

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

page page Integer

Номер выводимой страницы результатов.

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

outlet outlet

Описание точки продаж/точек продаж.

Каждая точка продаж описывается в отдельном параметре outlet.

Параметры, вложенные в outlet
id pointId String

Идентификатор точки продаж.

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

shop-id shopId Long

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

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

shop-name shopName String

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

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

type pointType Enum

Тип точки продаж.

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

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

name pointName String

Наименование точки продаж.

phone phone

Телефон точки продаж.

schedule schedule

Время работы точки продаж.

Параметр может включать несколько интервалов.

description pointDescription String

Описание точки продаж.

contacts-page contactsPage String

URL, по которому размещена информация о точке продаж.

geo geo

Информация о географическом местоположении точки продаж.

address

Адрес точки продаж.

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

country String

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

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

localityName String

Наименование населенного пункта.

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

thoroughfareName String

Наименование улицы.

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

premiseNumber String

Номер дома.

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

building String

Номер строения.

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

block String

Корпус дома.

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

officeNumber String

Номер офиса.

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

Параметры, вложенные в phone
country country String

Код страны.

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

city city String

Код города.

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

number number String

Номер телефона.

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

Параметры, вложенные в schedule
working-time

Описание интервала времени работы точки продаж.

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

Параметры, вложенные в working-time/schedule
day-from workingDaysFrom String

День недели, с которого начинается интервал работы.

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

day-till workingDaysTill String

День недели, которым заканчивается интервал работы.

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

time-from workingHoursFrom String

Время начала рабочего дня.

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

time-till workingHoursTill String

Время окончания рабочего дня.

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

Параметры, вложенные в geo
latitude latitude String

Широта местоположения.

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

longitude longitude String

Долгота местоположения.

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

distance distance Integer

Расстояние от точки продаж до пользователя.

Указывается, если в запросе задано местоположение пользователя.

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

geo-id geoId Integer

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

Параметры, вложенные в address
country String

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

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

locality String

Наименование населенного пункта.

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

street String

Наименование улицы.

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

premise-number String

Номер дома.

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

building-number String

Номер строения.

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

block-number String

Корпус дома.

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

office-number String

Номер офиса.

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

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

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

Примеры

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

GET https://api.content.market.yandex.ru/v1/shop/1163/outlets.xml?geo_id=213&count=1

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

<outlets count="1" total="2" page="1">
  <outlet id="1226" shop-id="1163" shop-name="Shop_Name" type="DEPOT">
    <name>Магазин на Юго-западной</name>
    <phone country="7" city="499" number="123-4567"/>
    <schedule>
      <working-time day-from="1" day-till="5" time-from="12:00" time-till="20:00"/>
    </schedule>
    <description>Предварительно оформляйте резерв</description>
    <contacts-page>http://shop_name.ru/contacts</contacts-page>
    <geo latitude="55.670640" longitude="37.479178">
      <geo-id>213</geo-id>
    </geo>
    <address locality="Москва" street="Проспект Вернадского" premise-number="78" building-number="7"/>
  </outlet>
</outlets>

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

GET https://api.content.market.yandex.ru/v1/shop/1163/outlets.json?geo_id=213&count=1

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

{
  "outlets":
  {
    "total": 2,
    "count": 1,
    "outlet":
    [
      {
        "phone":
        {
          "number": "123-4567",
          "country": "7",
          "city": "499"
        },
        "geo":
        {
          "geoId": 213,
          "longitude": "37.479178",
          "latitude": "55.670640"
        },
        "building": "7",
        "pointId": "1226",
        "pointName": "Магазин на Юго-западной",
        "pointType": "DEPOT",
        "localityName": "Москва",
        "thoroughfareName": "Проспект Вернадского",
        "premiseNumber": "78",
        "schedule":
        [
          {
            "workingDaysFrom": "1",
            "workingDaysTill": "5",
            "workingHoursFrom": "12:00",
            "workingHoursTill": "20:00"
          }
        ],
        "pointDescription": "Предварительно оформляйте резерв",
        "contactsPage": "http://shop_name.ru/contacts",
        "shopId": 1163,
        "shopName": "Shop_Name"
      }
    ],
    "page": 1
  }
}
shop/{shop_id}/outlets Точки продаж