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

Внимание. Маркет постепенно перестает поддерживать XML. Поэтому мы рекомендуем переходить на JSON. Сейчас XML можно использовать, если добавить в запрос Content-Type: application/xml. Без этого будут ошибки.
  1. Описание
  2. Входные данные
  3. Выходные данные
  4. Описание ошибок
  5. Ограничения
  6. Примеры

Описание

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

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

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

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

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

Чтобы узнать идентификатор, войдите в личный кабинет, в меню слева выберите Настройки → Настройки API и скопируйте из поля Номер кампании число после дефиса. Например, если указано значение «11-213856», то идентификатор кампании — 213856.

feedId

Int64

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

Параметр

Тип

Значение

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

campaignId

Int64

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

Чтобы узнать идентификатор, войдите в личный кабинет, в меню слева выберите Настройки → Настройки API и скопируйте из поля Номер кампании число после дефиса. Например, если указано значение «11-213856», то идентификатор кампании — 213856.

feedId

Int64

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

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

{
  "parameters":
  [
    {
      "deleted": {boolean},
      "name": "{enum}",
      "values":
      [
        {int32},
        ...
      ]
    },
    ...
  ]
}

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

Параметр

Тип

Значение

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметр

Тип

Значение

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметр

Тип

Значение

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

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

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

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

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

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

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

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

Код ошибки.

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

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

Параметр

Тип

Значение

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

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

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

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

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

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

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

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

Код ошибки.

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

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

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

В случае ошибки сервер возвращает 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'

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

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

Описание

Пояснение

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

Ошибка 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'

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

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

Ограничения

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

Примеры

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

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

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

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

-d '{
  "parameters":
  [
    {
      "name": "reparseIntervalMinutes",
      "values":
      [
        1440
      ]
    }
  ]
}'

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

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

{
  "status": "OK"
}

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

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

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

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

-d '{
  "parameters":
  [
    {
      "deleted": true,
      "name": "reparseIntervalMinutes"
    }
  ]
}'

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

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

{
  "status": "OK"
}