Отправить магазин на самопроверку

Внимание. В конце мая Яндекс.Маркет закрывает программу «Заказ на Маркете». В мае магазины уже не смогут подключиться к этой программе. Подробнее.
  1. Описание
  2. Входные данные
  3. Выходные данные
  4. Описание ошибок
  5. Примеры

Описание

POST /campaigns/{campaignId}/quality/self-check

Отправляет магазин на прохождение самопроверки. Метод работает только для тестового API магазина.

Отрицательные результаты прохождения самопроверки не влияют на участие магазина в программе « Заказ на Маркете »:

  • на возможность подключиться к программе, если магазин еще не подключен к ней;

  • на дальнейшее участие, если магазин уже подключен к программе.

Примечание. Вы можете отправить свой магазин на самопроверку с помощью запроса данным методом (только для тестового API) или в личном кабинете (для тестового или основного API). Независимо от способа отправки, результаты самопроверки доступны только в личном кабинете — на странице Проверки → Контрольный заказ (вкладка Самопроверка).

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

<response>
  <errors>
    <error code="{enum}" message="{string}"/>
    ...
  </errors>
  <status>{enum}</status>
  <result status="{enum}"/>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

errors errors

Список ошибок.

Выводится, если параметр status=ERROR.

status status Enum

Статус ответа.

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

  • ERROR — произошла ошибка.

  • OK — запрос выполнен успешно.

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

error

Информация об ошибке.

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

Параметры, вложенные в error / errors

code code Enum

Код ошибки.

Возможные значения перечислены в разделе Описание ошибок.

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

message message String

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

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

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

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

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

Описание

Пояснение

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

Ошибка 400 Bad Request

Check order already started

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

Дождитесь завершения самопроверки.

Ошибка 403 Forbidden

Access denied

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

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

Примеры

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

curl -i -H 'Content-Type: application/xml' -X POST 'https://api.partner.market.yandex.ru/v2/campaigns/1234/quality/self-check.xml'

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

HTTP/1.1 200 OK
Date: Thu, 14 Jul 2016 12:08:12 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <status>OK</status>
</response>