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

Описание

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

Позволяет магазину изменить параметры прайс-листа.

Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра).

Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение).

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

feedId

Int64

Идентификатор прайс-листа.

Структура тела POST-запроса:

<feed-parameters>
  <parameters>
    <parameter>
      <deleted>{boolean}</deleted>
      <name>{enum}</name>
      <values>
        <value>{int32}</value>
        ...
      </values>
    </parameter>
    ...
  </parameters>
</feed-parameters>

В теле POST-запроса передаются следующие параметры:

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

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

Тип

Значение

feed-parameters

Информация о параметрах прайс-листа.

Обязательный параметр, указывается только для формата XML.

Параметры, вложенные в feed-parameters

parameters parameters

Параметры прайс-листа.

Обязательный параметр.

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

parameter

Параметр прайс-листа.

Обязательный параметр, указывается только для формата XML.

Параметры, вложенные в parameter / parameters

deleted deleted Boolean

Удалить ли значение параметра.

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

  • true — удалить значение параметра.

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

name name Enum

Название параметра.

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

  • reparseIntervalMinutes — период скачивания прайс-листа.

    Яндекс.Маркет будет скачивать прайс-лист через количество минут, указанное в параметре value. Например, при value=1440, Яндекс.Маркет будет скачивать прайс-лист один раз в сутки.

    Внимание. Несмотря на установленное значение, Яндекс.Маркет скачает прайс-лист один раз в сутки.

Обязательный параметр.

values values

Значения параметра.

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

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

value Int32

Значение параметра.

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

  • Для name=reparseIntervalMinutes — минуты.

    Минимальное значение: 20.

    Максимальное значение: 1440. Рекомендуем указывать это значение.

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

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

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

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

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

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

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

Тип

Значение

response

Ответ.

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

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

errors errors

Список ошибок при выполнении запроса.

Выводится, если status="ERROR".

status status Enum

Статус выполнения запроса.

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

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

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

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

error

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

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

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

code code Enum

Код ошибки.

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

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

message message String

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

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

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

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

Описание

Пояснение

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

Ошибка 400 Bad Request

Could not parse feed reparse interval

В теле запроса для name=reparseIntervalMinutes в параметре value передано не число типа int32.

В значении параметра value укажите число типа int32.

Empty feed reparse interval minutes

В теле запроса для name=reparseIntervalMinutes параметр value передан пустым.

В значении параметра value укажите число типа int32.

Feed reparse interval minutes should be positive

В теле запроса для name=reparseIntervalMinutes в параметре value передано отрицательное число.

В значении параметра value укажите число от 20 до 1440.

Unknown parameter: {}

В теле запроса в параметре name передано некорректное значение.

В параметре name укажите возможное значение.

Ошибка 403 Forbidden

Access denied

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

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

Ошибка 404 Not Found

Feed not found: 'feedId'

В параметре feed-id передан некорректный идентификатор прайс-листа.

Проверьте корректность данных в запросе.

Примеры

Установка периода скачивания прайс-листа:

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

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

Тело POST-запроса:

-d '<feed-parameters>
  <parameters>
    <parameter>
      <name>reparseIntervalMinutes</name>
      <values>
        <value>1440</value>
      </values>
    </parameter>
  </parameters>
</feed-parameters>'

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

HTTP/1.1 200 OK
Date: Mon, 12 Mar 2018 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

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

Отмена установленного периода скачивания прайс-листа:

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

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

Тело POST-запроса:

-d '<feed-parameters>
  <parameters>
    <parameter>
      <deleted>true</deleted>
      <name>reparseIntervalMinutes</name>
    </parameter>
  </parameters>
</feed-parameters>'

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

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

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