Удаление всех цен, установленных через API

Описание

POST /campaigns/{campaignId}/offer-prices/removals

Запрос удаляет все цены на предложения, установленные через API. После удаления начнут действовать цены из прайс-листов.

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

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offer-prices/removals.[format]

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

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

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

Тип

Значение

offer-price-removal

Информация о удалении цен предложений.

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

Параметры, вложенные в offer-price-removal

remove-all removeAll Boolean

Удаление всех цен предложений, установленных через API.

Обязательный параметр со значением true.

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

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

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

<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

Код ошибки.

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

  • REQUEST_LIMIT_EXCEEDED — превышено количество предложений, для которых можно удалить цены в течение минуты.

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

message message String

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

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

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

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

Ограничения

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

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

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

Примеры

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

curl -i -H 'Content-Type: application/xml' -X POST 'https://api.partner.market.yandex.ru/v2/campaigns/10001/offer-prices/removals.xml'

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

-d '<offer-price-removals remove-all="true"/>'

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

HTTP/1.1 200 OK
Date: Sat, 12 Apr 2018 08:37:40 GMT
Content-Type: application/xml;charset=utf-8
...

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