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

Описание

GET /campaigns/{campaignId}

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

<response>
  <campaign domain="{string}" id="{int64}" state="{int32}">
    <state-reasons>
      <reason id="{int32}"/>
      ...
    </state-reasons>
  </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

campaigncampaign

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

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

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 — выключен или выключается из-за неактуальной информации.

Параметр выводится только для формата XML и является атрибутом параметра reason. Для формата 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" state="2">
    <state-reasons>
      <reason id="6"/>
      <reason id="9"/>
    </state-reasons>
  </campaign>
</response>