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

Описание

GET /campaigns/{campaignId}

Возвращает информацию о магазине.

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

<response>
  <campaign domain="{string}" id="{int64}" prepay-enabled="{boolean}" state="{int32}" state-cpa="{enum}">
    <state-reasons>
      <reason id="{int32}"/>
      ...
    </state-reasons>
    <state-reasons-cpa>
      <state-reason-cpa>{enum}</state-reason-cpa>
      ...
    </state-reasons-cpa>
  </campaign>
</response>
Структура выходных данных для формата XML до версии 2.0 партнерского API Яндекс.Маркета
<response>
  <campaign>
    <campaign domain="{string}" id="{int64}" state="{int32}">
      <state-reasons>
        <reason id="{int32}"/>
        ...
      </state-reasons>
    </campaign>
  </campaign>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

campaign campaign

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

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

domain domain String

URL магазина.

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

id id Int64

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

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

prepay-enabled prepayEnabled Boolean
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Предоплата при приеме заказов с Яндекс.Маркета.

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

  • false — предоплата включена.

  • true — предоплата отключена.

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

state state Int32

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

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

  • 1 — включен.

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

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

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

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

state-cpa stateCpa Enum
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Статус программы « Заказ на Маркете » для магазина.

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

  • OFF — отключена.

  • ON — подключена.

  • SWITCHING_ON — в процессе подключения.

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

state-reasons stateReasons

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

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

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

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

state-reasons-cpa stateReasonsCpa
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

Список причин, объясняющих статус магазина в рамках программы « Заказ на Маркете ».

Выводится, если параметр state-cpa=OFF.

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

reason

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

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

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

id Int32

Код причины.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

state-reason-cpa Enum
Внимание. Параметр перестанет выводиться после закрытия программы «Заказ на Маркете».

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

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

  • CPA_API_NEED_INFO — предоставлено недостаточно информации для участия в программе.

  • CPA_CONTRACT — отсутствует договор об участии в программе либо истек срок его действия.

  • CPA_FEED — в прайс-листе отсутствуют предложения, участвующие в программе.

  • CPA_PARTNER — программа отключена по инициативе пользователя.

  • CPA_QUALITY_API — программа отключена из-за проблем обработки запросов через API.

  • CPA_QUALITY_AUTO — программа отключена автоматически за ошибки качества.

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

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

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

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

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

Описание

Пояснение

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

Ошибка 403 Forbidden

Access denied

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

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

Примеры

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

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

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

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

<response>
  <campaign domain="nif-nif.yandex.ru" id="10001" prepay-enabled="false" state="2" state-cpa="OFF">
    <state-reasons>
      <reason id="6"/>
      <reason id="9"/>
    </state-reasons>
    <state-reasons-cpa>
      <state-reason-cpa>CPA_CPC</state-reason-cpa>
      <state-reason-cpa>CPA_PARTNER</state-reason-cpa>
      <state-reason-cpa>CPA_QUALITY_OTHER</state-reason-cpa>
    </state-reasons-cpa>
  </campaign>
</response>