Магазины, доступные логину

Описание

GET /campaigns/by_login/{login}

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

login

String

Логин пользователя.

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

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

<response>
  <campaigns>
    <campaign domain="{string}" id="{int64}" state="{int32}">
      <state-reasons>
        <reason id="{int32}"/>
        ...
      </state-reasons>
    </campaign>
    ...
  </campaigns>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

campaignscampaigns

Список магазинов.

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

campaign

Описание магазина.

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

Параметры, вложенные в campaign / campaigns

domaindomainString

URL магазина.

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

ididInt64

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

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

statestateInt32

Статус магазина.

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

  • 1 — включен.

  • 2 — выключен.

  • 3 — включается.

  • 4 — выключается.

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

state-reasonsstateReasons

Список причин, объясняющих статус магазина.

Выводится, если параметр state имеет значения:

  • 2 — выключен.

  • 4 — выключается.

Параметры, вложенные в state-reasons

reason

Описание причины.

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

Параметры, вложенные в reason / stateReasons

idInt32

Код причины.

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

  • 5 — проверяется.

  • 6 — требуется проверка.

  • 7 — выключен или выключается менеджером.

  • 9 — выключен или выключается из-за финансовых проблем.

  • 11 — выключен или выключается из-за ошибок в прайс-листе.

  • 12 — выключен или выключается партнером.

  • 13 — выключен или выключается за неприемлемое качество.

  • 15 — выключен или выключается из-за обнаружения дублирующих витрин.

  • 16 — выключен или выключается из-за прочих проблем качества.

  • 20 — выключен или выключается по расписанию.

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

  • 24 — выключен или выключается за недостаток информации о магазине.

  • 25 — выключен или выключается из-за неактуальной информации.

  • 26 — выключен или выключается из-за ограничения расходов на клики в сутки.
  • 27 — выключен или выключается партнером.

  • 28 — выключен или выключается за неприемлемое качество.

  • 29 — выключен или выключается из-за прочих проблем качества.

Параметр выводится только для формата XML и является атрибутом параметра reason. Для формата JSON выводится код причины в виде числа.

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

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

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

Описание

Пояснение

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

Ошибка 403 Forbidden

Access denied

Доступ к ресурсу запрещен.

Авторизованный логин имеет доступ только к эквивалентным логинам. В случае агентства — к подагентским логинам.

Ошибка 404 Not Found

Login not found: 'login'

Указанный в запросе логин login не найден.

Проверьте корректность логина.

Примеры

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

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

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

HTTP/1.1 200 OK
Date: Fri, 4 Aug 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <campaigns>
    <campaign domain="nuf-nuf.yandex.ru" id="10002" state="4">
      <state-reasons>
        <reason id="21"/>
      </state-reasons>
    </campaign>
  </campaigns>
</response>