Магазины пользователя

Описание

GET /campaigns

Возвращает список магазинов пользователя на Яндекс.Маркете. Список совпадает со списком магазинов, отображающихся в личном кабинете Яндекс.Маркета на странице «Мои магазины». Для агентских пользователей список состоит из подагентских магазинов.

Примечание.

Результаты рекомендуется получать постранично. Для этого укажите в запросе параметры page и pageSize.

Иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns.[format]

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

Параметр

Тип

Значение

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

page Int32

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

Используется вместе с параметром pageSize.

Если указан номер страницы, превышающий общее количество найденных страниц, возвращается сообщение об ошибке.

Если параметры page и pageSize не заданы, выдаются все найденные результаты.

pageSize Int32

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

Используется вместе с параметром page.

Если параметры page и pageSize не заданы, выдаются все найденные результаты.

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

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

<response>
  <campaigns>
    <campaign domain="{string}" id="{int64}" state="{int32}">
      <state-reasons>
        <reason id="{int32}"/>
        ...
      </state-reasons>
    </campaign>
    ...
  </campaigns>
  <pager current-page="{int32}" from="{int32}" pages-count="{int32}" page-size="{int32}" to="{int32}" total="{int32}"/>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

campaigns campaigns

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

pager pager

Сводка по результатам поиска.

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

campaign

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

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

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

domain domain String

URL магазина.

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

id id Int64

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

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

state state Int32

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

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

  • 1 — включен.

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

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

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

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

state-reasons stateReasons

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

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

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

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

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

reason

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

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

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

id Int32

Код причины.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

current-page currentPage Int32

Порядковый номер текущей страницы результатов.

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

from from Int32

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

Если ничего не найдено, значение параметра: 0.

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

pages-count pagesCount Int32

Количество страниц с результатами поиска.

Значение может увеличиваться по мере увеличения номера страницы. Конечное количество страниц будет достигнуто, когда значение параметра pages-count будет равно значению параметра current-page.

Если ничего не найдено, значение параметра: 0.

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

page-size pageSize Int32

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

Если ничего не найдено, значение параметра: 0.

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

to to Int32

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

Если ничего не найдено, значение параметра: 0.

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

total total Int32

Общее количество найденных магазинов.

Значение может увеличиваться по мере увеличения номера страницы. Конечное количество найденных записей будет достигнуто, когда значение параметра total будет равно значению параметра to.

Если ничего не найдено, значение параметра: 0.

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

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

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

Примеры

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

curl -i -H 'Content-Type: application/xml' GET 'https://api.partner.market.yandex.ru/v2/campaigns.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="nif-nif.yandex.ru" id="10001" state="2">
      <state-reasons>
        <reason id="6"/>
        <reason id="9"/>
      </state-reasons>
    </campaign>
    <campaign domain="nuf-nuf.yandex.ru" id="10002" state="4">
      <state-reasons>
        <reason id="21"/>
      </state-reasons>
    </campaign>
    <campaign domain="naf-naf.yandex.ru" id="10003" state="1"/>
  </campaigns>
  <pager current-page="1" from="1" pages-count="1" page-size="3" to="3" total="3"/>
</response>