Скрытие предложений и настройки скрытия

Описание

POST /campaigns/{campaignId}/hidden-offers

Метод позволяет:

  1. Скрыть предложения магазина на Маркете на указанное время. В теле запроса можно передать от одного до 500 предложений.

  2. Изменить время скрытия предложений и комментарии.

    Чтобы внести изменения, передайте в теле запроса идентификатор уже скрытого предложения, идентификатор его прайс-листа и новые значения параметров comment и / или ttl-in-hours. При этом предыдущие значения этих параметров будут удалены.

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

<hidden-offers>
  <hidden-offer feed-id="{int64}" offer-id="{string}" comment="{string}" ttl-in-hours="{int32}"/>
  ...
</hidden-offers>

Параметры тела POST-запроса:

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

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

Тип

Значение

hidden-offers hiddenOffers

Список предложений, которые нужно скрыть.

В теле запроса можно передать от одного до 500 предложений.

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

Параметры, вложенные в hidden-offers

hidden-offer

Предложение, которое нужно скрыть.

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

Параметры, вложенные в hidden-offer / hiddenOffers

feed-id feedId Int64

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

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

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

offer-id offerId

String

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

Максимальная длина — 50 символов.

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

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

comment comment String

Комментарий магазина.

Максимальная длина комментария — 100 символов.

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

ttl-in-hours ttlInHours Int32

Количество часов до возобновления показа предложения.

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

Максимальное значение: 720.

Значение по умолчанию: 48.

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

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

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

<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

Код ошибки.

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

  • DUPLICATE_OFFER — в теле запроса передано два или более предложения с одинаковыми значениями параметров offer-id / offerId.

  • INVALID_COMMENT — в теле запроса в параметре comment передано больше 100 символов.

  • INVALID_FEED_ID — в теле запроса в параметре feed-id / feedId передан идентификатор прайс-листа, который не существует или не относится к магазину campaignId.

  • INVALID_OFFER_ID — в теле запроса в параметре offer-id / offerId передан пустой идентификатор предложения или его длина превышает 50 символов.

  • INVALID_TTL — в теле запроса в параметре ttl-in-hours / ttlInHours передано больше 720 часов.

  • LIMIT_EXCEEDED — превышен индивидуальный лимит скрытий предложений.

  • REQUEST_LIMIT_EXCEEDED — в теле запроса в параметре hidden-offers / hiddenOffers передано больше 500 предложений.

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

message message String

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

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

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

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

Ограничения

В одном запросе можно скрыть или изменить параметры скрытия не более чем 500 предложений.

В течение минуты можно скрыть или изменить параметры скрытия определенного количества предложений. Если у магазина:

  • не более 200 000 предложений — 1000 предложений;
  • более 200 000 предложений — ограничение определяется по формуле:
    (количество предложений магазина) / 200
Примечание.

Количество предложений магазина считается по данным за последние семь дней (не включая сегодня).

Примеры

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

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

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

-d '<hidden-offers>
  <hidden-offer feed-id="67891" offer-id="101Ab12313C" comment="До поставки новой партии товара" ttl-in-hours="1"/>
</hidden-offers>'

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

HTTP/1.1 200 OK
Date: Sat, 12 Aug 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

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