Удаление всех цен, установленных через API
Описание
POST /campaigns/{campaignId}/offer-prices/removals
Запрос удаляет все цены на предложения, установленные через API. После удаления начнут действовать цены из прайс-листов.
200 OK
. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта.URL ресурса:
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offer-prices/removals.[format]
Входные данные
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
campaignId | Int64 | Идентификатор кампании. Чтобы узнать идентификатор, войдите в личный кабинет магазина, нажмите на его название и скопируйте из поля Кампания № число после дефиса. Например, если указано значение «11-213856», то идентификатор кампании — 213856. ![]() |
Параметр | Тип | Значение |
---|---|---|
Обязательные | ||
campaignId | Int64 | Идентификатор кампании. Чтобы узнать идентификатор, войдите в личный кабинет магазина, нажмите на его название и скопируйте из поля Кампания № число после дефиса. Например, если указано значение «11-213856», то идентификатор кампании — 213856. ![]() |
Структура тела POST-запроса:
Параметры тела POST-запроса:
Параметр для формата XML | Параметр для формата JSON | Тип | Значение |
---|---|---|---|
offer-price-removal | Информация о удалении цен предложений. Обязательный параметр, указывается только для формата XML. | ||
Параметры, вложенные в offer-price-removal | |||
remove-all | removeAll | Boolean | Удаление всех цен предложений, установленных через API. Обязательный параметр со значением true. Для формата XML является атрибутом параметра offer-price-removal. |
Параметр для формата XML | Параметр для формата JSON | Тип | Значение |
---|---|---|---|
offer-price-removal | Информация о удалении цен предложений. Обязательный параметр, указывается только для формата XML. | ||
Параметры, вложенные в offer-price-removal | |||
remove-all | removeAll | Boolean | Удаление всех цен предложений, установленных через API. Обязательный параметр со значением true. Для формата XML является атрибутом параметра offer-price-removal. |
Выходные данные
Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.
Описание параметров:
Параметр для формата XML | Параметр для формата JSON | Тип | Значение |
---|---|---|---|
response | Ответ. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в response | |||
errors | errors | Список ошибок при выполнении запроса. Выводится, если status="ERROR". | |
status | status | Enum | Статус выполнения запроса. Возможные значения:
|
Параметры, вложенные в errors | |||
error | Информация об ошибке. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в error / errors | |||
code | code | Enum | Код ошибки. Возможные значения:
Для формата XML является атрибутом параметра error. |
message | message | String | Описание ошибки. Для формата XML является атрибутом параметра error. |
Параметр для формата XML | Параметр для формата JSON | Тип | Значение |
---|---|---|---|
response | Ответ. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в response | |||
errors | errors | Список ошибок при выполнении запроса. Выводится, если status="ERROR". | |
status | status | Enum | Статус выполнения запроса. Возможные значения:
|
Параметры, вложенные в errors | |||
error | Информация об ошибке. Параметр возвращается только для формата XML. | ||
Параметры, вложенные в error / errors | |||
code | code | Enum | Код ошибки. Возможные значения:
Для формата XML является атрибутом параметра error. |
message | message | String | Описание ошибки. Для формата XML является атрибутом параметра error. |
Описание ошибок
В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.
Ограничения
Если в течение последней минуты с помощью данного запроса уже были удалены все цены, при повторном выполнении запроса проверяется, у скольких предложений удалились цены в прошлый раз . Если превышено ограничение, запрос не выполнится, и сервер сообщит об ошибке. Ограничение зависит от количества предложений магазина:
для небольших магазинов (не более 10 000 предложений) — 50 предложений;
для остальных магазинов это ограничение определяется по формуле:
(количество предложений магазина) / 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-removal 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>
Пример запроса:
curl -i -H 'Content-Type: application/json' -X POST 'https://api.partner.market.yandex.ru/v2/campaigns/10001/offer-prices/removals.json'
Тело POST-запроса:
-d '{
"removeAll": true
}'
Пример ответа:
HTTP/1.1 200 OK
Date: Sat, 12 Apr 2018 08:37:40 GMT
Content-Type: application/json;charset=utf-8
...
{
"status": "OK"
}