Регион магазина

Описание

GET /campaigns/{campaignId}/region

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

Примечание. Метод доступен начиная с версии 1.2 партнерского API Яндекс.Маркета.

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/region.[format]

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

Параметр

Тип

Значение

Обязательные

campaignId

Int64

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

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

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

<response>
  <region id="{int64}" name="{string}" type="{enum}">
    <parent id="{int64}" name="{string}" type="{enum}">
      ...
    </parent>
  </region>
</response>

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

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

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

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

regionregion

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

Параметр выводится, только если магазин указал регион в личном кабинете Яндекс.Маркета.

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

ididInt64

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

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

namenameString

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

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

typetypeEnum

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

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

parentparent

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

Указываются родительские регионы до уровня страны.

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

ididInt64

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

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

namenameString

Название родительского региона.

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

typetypeEnum

Тип родительского региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

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

parentparent

Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.

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

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

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 403 Forbidden

Access denied

Нет доступа к магазину.

Проверьте корректность идентификатора магазина.

Примеры

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

curl -i -H 'Content-Type: application/xml' 'https://api.partner.market.yandex.ru/v2/campaigns/21193095/region.xml'

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

HTTP/1.1 200 OK
Date: Wed, 25 Jan 2017 14:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <region id="213" name="Москва" type="CITY">
    <parent id="1" name="Москва и Московская область" type="REPUBLIC">
      <parent id="3" name="Центральный федеральный округ" type="AREA">
        <parent id="225" name="Россия" type="COUNTRY"/>
      </parent>
    </parent>
  </region>
</response>