Сообщить, что прайс-лист обновился. Партнерский API Яндекс Маркета для модели ADV. Руководство разработчика

Сообщить, что прайс-лист обновился

Описание

POST /campaigns/{campaignId}/feeds/{feedId}/refresh

Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе.

Магазин обновляет прайс-лист, ссылку на который он указал в личном кабинете.
Магазин отправляет Маркету запрос методом POST /campaigns/{campaignId}/feeds/{feedId}/refresh.
Маркет начинает обновление данных магазина на сервисе.

Внимание. Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.

Примечание. В течение часа магазин может выполнить запрос не более трех раз для одного прайс-листа.

URL ресурса:

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

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


Параметр	Тип	Значение
Обязательные
campaignId	Int64	Идентификатор кампании. Чтобы узнать идентификатор, откройте сводку бизнеса «Рекламное продвижение», наведите указатель на название магазина и скопируйте из поля Кампания № число после дефиса. Например, если указано значение «11-12345678», то идентификатор кампании — 12345678.
feedId	Int64	Идентификатор прайс-листа.


Параметр	Тип	Значение
Обязательные
campaignId	Int64	Идентификатор кампании. Чтобы узнать идентификатор, откройте сводку бизнеса «Рекламное продвижение», наведите указатель на название магазина и скопируйте из поля Кампания № число после дефиса. Например, если указано значение «11-12345678», то идентификатор кампании — 12345678.
feedId	Int64	Идентификатор прайс-листа.

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

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

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

{
  "errors":
  [
    {
      "code": "{enum}",
      "message": "{string}"
    },
    ...
  ],
  "status": "{enum}"
}

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


Параметр для формата XML	Параметр для формата JSON	Тип	Значение
`response`			Ответ. Параметр возвращается только для формата XML.
Параметры, вложенные в response
`errors`	`errors`		Список ошибок при выполнении запроса. Выводится, если status="ERROR".
`status`	`status`	Enum	Статус выполнения запроса. Возможные значения: OK — запрос выполнен успешно. ERROR — произошла ошибка.
Параметры, вложенные в errors
`error`			Информация об ошибке. Параметр возвращается только для формата XML.
Параметры, вложенные в error / errors
`code`	`code`	Enum	Код ошибки. Возможные значения: BAD_REQUEST — не удалось выполнить запрос. NOT_FOUND — не указан один или несколько path-параметров. Подробную информацию смотрите в значении параметра message. REFRESH_FEED_ERROR — не удалось обновить прайс-лист. Попробуйте обратиться к ресурсу через некоторое время. Для формата XML является атрибутом параметра error.
`message`	`message`	String	Описание ошибки. Для формата XML является атрибутом параметра error.


Параметр для формата XML	Параметр для формата JSON	Тип	Значение
`response`			Ответ. Параметр возвращается только для формата XML.
Параметры, вложенные в response
`errors`	`errors`		Список ошибок при выполнении запроса. Выводится, если status="ERROR".
`status`	`status`	Enum	Статус выполнения запроса. Возможные значения: OK — запрос выполнен успешно. ERROR — произошла ошибка.
Параметры, вложенные в errors
`error`			Информация об ошибке. Параметр возвращается только для формата XML.
Параметры, вложенные в error / errors
`code`	`code`	Enum	Код ошибки. Возможные значения: BAD_REQUEST — не удалось выполнить запрос. NOT_FOUND — не указан один или несколько path-параметров. Подробную информацию смотрите в значении параметра message. REFRESH_FEED_ERROR — не удалось обновить прайс-лист. Попробуйте обратиться к ресурсу через некоторое время. Для формата XML является атрибутом параметра error.
`message`	`message`	String	Описание ошибки. Для формата XML является атрибутом параметра error.

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

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


Описание	Пояснение	Способ возможного решения
Ошибка `403 Forbidden`
`Access denied`	Нет доступа к магазину.	Проверьте корректность идентификатора кампании.
Ошибка `404 Not Found`
`Not found active shop for campaign: 'campaignId'`	Магазин отключен.	Подключите магазин к Маркету заново. Подробнее см. в разделе Повторное подключение магазина Справки Маркета для модели ADV.


Описание	Пояснение	Способ возможного решения
Ошибка `403 Forbidden`
`Access denied`	Нет доступа к магазину.	Проверьте корректность идентификатора кампании.
Ошибка `404 Not Found`
`Not found active shop for campaign: 'campaignId'`	Магазин отключен.	Подключите магазин к Маркету заново. Подробнее см. в разделе Повторное подключение магазина Справки Маркета для модели ADV.

DOCSUP-23303: Ограничения

В течение часа можно отправить не более 3 запросов.

Примеры

Запрос:

curl -i -H 'Content-Type: application/xml' -X POST 'https://api.partner.market.yandex.ru/v2/campaigns/10001/feeds/12345/refresh.xml'

Ответ:

HTTP/1.1 200 OK
Date: Tue, 27 Feb 2018 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

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

Запрос:

curl -i -H 'Content-Type: application/json' -X POST 'https://api.partner.market.yandex.ru/v2/campaigns/10001/feeds/12345/refresh.json'

Ответ:

HTTP/1.1 200 OK
Date: Tue, 27 Feb 2018 00:42:42 GMT
Content-Type: application/json;charset=utf-8
...

{
  "status": "OK"
}

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

Изменение параметров прайс-листа

Управление показом предложений

В этой статье

Описание Входные данные Выходные данные Описание ошибок DOCSUP-23303: Ограничения Примеры

Изменение параметров прайс-листа

Управление показом предложений