Изменения в документации

Версия 2.41 от 30 июля 2018 года.

В ресурс PUT /campaigns/{campaignId}/bids добавлены входной и выходной параметры dont-pull-up-bids — признак автоматического повышения ставок bid и cbid до минимальных значений.

В ресурс POST /campaigns/{campaignId}/bids/recommended со входными параметрами target=MODEL-CARD, target=MARKET-SEARCH, target=SEARCH и ресурс POST /campaigns/{campaignId}/bids/recommended/top/market-search добавлен выходной параметр dont-pull-up-bids — признак автоматического повышения ставок bid и cbid до минимальных значений.

Версия 2.39 от 15 июня 2018 года.

Программа «Заказ на Маркете» закрыта. Удалены все относящиеся к ней ресурсы и параметры.

Список изменений

Удалены ресурсы:

  • POST /cart;
  • POST /order/accept;
  • POST /order/items;
  • POST /order/status;
  • POST /order/shipment/status;
  • PUT /campaigns/{campaignId}/orders/{orderId}/items;
  • PUT /campaigns/{campaignId}/orders/{orderId}/status;
  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;
  • GET /campaigns/{campaignId}/orders;
  • GET /campaigns/{campaignId}/orders/{orderId};
  • POST /campaigns/{campaignId}/quality/self-check;
  • GET /delivery/services;
  • GET /campaigns/{campaignId}/quality/cpa/report;
  • GET /campaigns/{campaignId}/quality/cpa/order-cancel-reasons.

В ресурсах GET /campaigns, GET /campaigns/{campaignId}, GET /campaigns/by_login/{login} удалены выходные параметры prepay-enabled, state-cpa, state-reasons-cpa.

В ресурсах GET /campaigns/{campaignId}/offers, GET /campaigns/{campaignId}/offers/all, POST /campaigns/{campaignId}/bids, PUT /campaigns/{campaignId}/bids, GET /campaigns/{campaignId}/bids/settings удалены входные и выходные параметры fee.

Изменен ресурс POST /campaigns/{campaignId}/bids/recommended:

  • Ресурс возвращает рекомендации для карточки модели со входным параметром target=MODEL-CARD. Входной параметр target=MODEL-CARD-CPA удален, входной параметр target=CARD-PRICES-CPO не рекомендуется к использованию.
  • В ресурсе со входным параметром target=MODEL-CARD удалены входной параметр reference-values и выходной параметр model-card-cpa. Выходной параметр card-prices-cpa не рекомендуется к использованию.
  • Ресурс со входными параметрами target=MODEL-CARD, target=MARKET-SEARCH, target=SEARCH возвращает только рекомендации ставок bid и cbid. Удалены выходные параметры fee, min-fee, quality-factor.

Ресурс POST /campaigns/{campaignId}/bids/recommended/top/market-search возвращает только рекомендации ставок bid и cbid. Удалены выходные параметры fee, min-fee.

В ресурсах GET /campaigns/{campaignId}/stats/main, GET /campaigns/{campaignId}/stats/main-daily, GET /campaigns/{campaignId}/stats/main-weekly, GET /campaigns/{campaignId}/stats/main-monthly удалены входные параметры fields=cpa и выходные параметры accepted-orders, accepted-orders-cpa-spending, accepted-orders-gmv, created-orders, created-orders-cpa-spending, created-orders-gmv, place-group="8".

В ресурсе GET /campaigns/{campaignId}/stats/offers удалены входной параметр fields=cpa и выходные параметры accepted-orders, accepted-orders-cpa-spending, accepted-orders-items, accepted-orders-gmv, created-orders, created-orders-cpa-spending, created-orders-items, created-orders-gmv, cpa-spending, order-items.

В ресурсах GET /campaigns/{campaignId}/quality/tickets, GET /campaigns/{campaignId}/quality/tickets/{ticketId} удалены выходные параметры check-method="5".

В ресурсах GET /campaigns/{campaignId}/quality/tickets, GET /campaigns/{campaignId}/quality/tickets/{ticketId} изменены коды и названия ошибок в выходном параметре error-code.

Версия 2.38 от 7 мая 2018 года.

Добавлены ресурсы для управления ценами на предложения:

Версия 2.37 от 4 мая 2018 года.

Добавлены ресурсы:

Изменения в других ресурсах:

  • В ресурс GET /campaigns добавлены входные параметры page и pageSize, которые позволяют получать список магазинов постранично.

  • В ресурс POST /campaigns/{campaignId}/bids/recommended с входными параметрами target=CARD-PRICES-CPO , target=MARKET-SEARCH и/или target=SEARCH добавлено ограничение на длину параметра тела запроса name — до 512 символов.

Версия 2.36 от 30 января 2018 года.
Версия 2.35 от 12 января 2018 года.

Добавлен ресурс для получения отчета по индексации прайс-листа магазина: GET /campaigns/{campaignId}/feeds/{feedId}/index-logs.

Добавлены результаты автоматических проверок прайс-листа в ресурсы: GET /campaigns/{campaignId}/feeds и GET /campaigns/{campaignId}/feeds/{feedId}.

Версия 2.34 от 30 ноября 2017 года.

В ресурс POST /campaigns/{campaignId}/bids/recommended добавлен входной параметр region_id, который позволяет получать рекомендации ставок и размеров комиссий для указанного региона.

Версия 2.33 от 13 ноября 2017 года.

Добавлены интервалы времени доставки заказа (параметры from-time и to-time) в ресурсы:

  • POST /cart;

  • POST /order/accept;

  • POST /order/items;

  • POST /order/status;

  • POST /order/shipment/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;

  • GET /campaigns/{campaignId}/orders;

  • GET /campaigns/{campaignId}/orders/{orderId}.

Версия 2.32 от 7 ноября 2017 года.

Добавлены ресурсы для изменения состава заказа и уведомления магазина об изменении состава в личном кабинете:

  • PUT /campaigns/{campaignId}/orders/{orderId}/items;

  • POST /order/items.

Версия 2.31 от 29 сентября 2017 года.

Добавлена информация о посылках в ресурсы:

  • PUT /campaigns/{campaignId}/orders/{orderId}/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;

  • GET /campaigns/{campaignId}/orders;

  • GET /campaigns/{campaignId}/orders/{orderId}.

Версия 2.30 от 24 августа 2017 года.

Добавлены ресурсы для управления точками продаж магазина:

В ресурсы GET /campaigns/{campaignId}/outlets и GET /campaigns/{campaignId}/outlets/{outletId} добавлены новые параметры, а часть старых не рекомендованы к использованию.

Версия 2.29 от 17 августа 2017 года.

Для ресурса POST /campaigns/{campaignId}/bids/recommended с входными параметрами target=MARKET-SEARCH и / или target=SEARCH введены ограничения для параметра тела запроса query: от 2 до 2000 символов.

Версия 2.28 от 8 августа 2017 года.

В ресурс GET /campaigns/{campaignId}/stats/offers и группу GET /campaigns/{campaignId}/stats/main* добавлены параметры, в которых выводится статистика по оформленным и подтвержденным заказам.

Версия 2.27 от 7 августа 2017 года.

В связи с запуском программы «Акции Маркета», добавлен параметр promos в ресурсы, связанные с программой « Заказ на Маркете ».

Версия 2.26 от 28 июля 2017 года.

Добавлен новый ресурс — POST /campaigns/{campaignId}/bids/recommended/top/market-search, который позволяет получить список популярных запросов в поиске Яндекс.Маркета, рекомендованных для предложения, и значения ставок и / или размеров комиссий.

Версия 2.25 от 27 июля 2017 года.

При работе в программе «Доставка партнерами Маркета» появилась возможность передать Яндекс.Маркету вес и габариты заказа с помощью API. Также добавлен новый ресурс POST /order/shipment/status, который уведомляет магазин о смене статуса заказа в службе доставки-партнере Яндекс.Маркета.

Версия 2.24 от 12 июля 2017 года.

Добавлен входной параметр orderByPrice в ресурс POST /models/offers.

Версия 2.23 от 8 июля 2017 года.

Согласно Федеральному закону №54, добавлены параметры, в которых указаны СНО магазина и ставки НДС для товаров и услуги доставки, в следующие ресурсы:

  • POST /cart;

  • POST /order/accept;

  • POST /order/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;

  • GET /campaigns/{campaignId}/orders;

  • GET /campaigns/{campaignId}/orders/{orderId}.

Версия 2.22 от 15 июня 2017 года.
  • В ресурсах GET /campaigns/{campaignId}/outlets и GET /campaigns/{campaignId}/outlets/{outletId} появилась возможность получать информацию о регионе точки продаж и фильтровать точки по региону.

  • В ресурсе POST /campaigns/{campaignId}/bids/recommended появилась возможность получать совместные рекомендации ставки cbid и размера комиссии fee для размещения на карточке модели с помощью входного параметра target=CARD-PRICES-CPO.

Версия 2.21 от 8 июня 2017 года.

В ресурс POST /cart добавлен параметр delivery-currency.

Версия 2.20 от 25 апреля 2017 года.

В связи с запуском программы «Доставка партнерами Маркета»:

  • Описан порядок взаимодействия через API в рамках программы.

  • Добавлены параметры delivery-partner-type и delivery-service-id в ресурсы POST /order/accept и POST /order/status.

Добавлен новый ресурс GET /delivery/services, позволяющий получить справочник служб доставки.

Версия 2.19 от 31 марта 2017 года.

Появилась возможность передавать информацию для отслеживания перемещений заказа. Изменения коснулись следующих ресурсов:

  • GET /campaigns/{campaignId}/orders;

  • GET /campaigns/{campaignId}/orders/{orderId};

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;

  • PUT /campaigns/{campaignId}/orders/{orderId}/status.

Версия 2.18 от 27 марта 2017 года.
  • Добавлены новые параметры в ресурс POST /campaigns/{campaignId}/bids/recommended.

  • Яндекс.Маркет полностью перешел на работу с новым белорусским рублем. Теперь белорусская валюта передается только значением BYN. Использование BYR недопустимо.

Версия 2.17 от 21 марта 2017 года.

Добавлен выходной параметр fee-ue в ресурсы:

  • PUT /campaigns/{campaignId}/orders/{orderId}/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;

  • GET /campaigns/{campaignId}/orders;

  • GET /campaigns/{campaignId}/orders/{orderId}.

Версия 2.16 от 15 февраля 2017 года.

Для группы ресурсов GET /campaigns/{campaignId}/stats/main* добавлена возможность получить статистику по показам предложений.

Версия 2.15 от 5 декабря 2016 года.
  • В связи с запуском самопроверки с помощью API добавлена группа страниц «Отладка и проверки API».

  • Добавлен ресурс POST /campaigns/{campaignId}/quality/self-check.

Версия 2.14 от 13 октября 2016 года.

Добавлены новые параметры в ресурс POST /campaigns/{campaignId}/bids/recommended.

Версия 2.13 от 26 сентября 2016 года.

В ресурс GET /campaigns/{campaignId}/stats/offers добавлены выходные параметры cpa-spending и order-items.

Версия 2.12 от 15 сентября 2016 года.

В связи с запуском программы «Забронировать на Маркете»:

  • в ресурсы GET /campaigns/{campaignId}/orders, GET /campaigns/{campaignId}/orders/{orderId}, PUT /campaigns/{campaignId}/orders/{orderId}/delivery и PUT /campaigns/{campaignId}/orders/{orderId}/status в выходные данные добавлен параметр is-booked;

  • в описание ресурса POST /cart добавлен раздел «Особенности передачи данных по пунктам самовывоза и диапазону дат доставки»;

  • на странице ресурса POST /cart в разделе Ответные данные от магазина подробно расписаны значения параметров from-date, outlets, outlet и вложенного в него id;

  • добавлено описание порядка взаимодействия через API в рамках программы «Забронировать на Маркете».

Версия 2.11 от 13 сентября 2016 года.

В ресурсы GET /campaigns/{campaignId}/outlets и GET /campaigns/{campaignId}/outlets/{outletId} добавлена группа параметров, вложенных в параметр delivery-rule.

Версия 2.10 от 17 августа 2016 года.
Версия 2.9 от 23 июня 2016 года.

В связи с запуском программы «Забронировать на Маркете» в ресурс POST /cart добавлены:

  • В ресурс GET /campaigns/{campaignId}/outlets в выходные данные добавлен параметр is-book-now — можно ли забронировать товар (оформить заказ в рамках программы «Забронировать на Маркете») в точке продаж.

  • В ресурс GET /campaigns/{campaignId}/outlets/{outletId} в выходные данные добавлен параметр is-book-now — можно ли забронировать товар (оформить заказ в рамках программы «Забронировать на Маркете») в точке продаж.

  • В ресурс POST /cart добавлены параметры:

    • в раздел передаваемые магазину данные — isBooked — будет ли заказ оформлен в рамках программы «Забронировать на Маркете»;

    • в раздел ответные данные от магазина — reserved-until — дата, до которой магазин готов забронировать заказ для покупателя в точке продаж.

  • В ресурс POST /order/accept добавлен параметр isBooked — признак, что заказ оформлен в рамках программы «Забронировать на Маркете».

Версия 2.8 от 9 июня 2016 года.
Версия 2.7 от 28 апреля 2016 года.

Добавлены ресурсы:

Версия 2.6 от 14 апреля 2016 года.

Добавлены ресурсы:

Версия 2.5 от 9 ноября 2015 года.

Добавлен ресурс:

Версия 2.4 от 11 февраля 2014 года.

Добавлены ресурсы:

Версия 2.3 от 6 ноября 2013 года.

Добавлен ресурс:

Обновлены ресурсы:

  • GET /campaigns/{campaignId}/orders — добавлен новый параметр type в выходных данных;

  • GET /campaigns/{campaignId}/orders/{orderId} — добавлен новый параметр type в выходных данных;

  • GET /campaigns/{campaignId}/region — добавлен новый параметр type в выходных данных;

  • GET /regions — изменены ограничения, добавлен новый параметр type в выходных данных;

  • GET /regions/{regionId} — изменены ограничения, добавлен новый параметр type в выходных данных;

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery — обновлено описание ошибок;

  • PUT /campaigns/{campaignId}/orders/{orderId}/status — обновлено описание ошибок.

Версия 2.2 от 8 октября 2013 года.

Добавлены ресурсы:

  • GET /campaigns/{campaignId}/orders;

  • GET /campaigns/{campaignId}/orders/{orderId};

  • POST /cart;

  • POST /order/accept;

  • POST /order/status;

  • PUT /campaigns/{campaignId}/orders/{orderId}/delivery;

  • PUT /campaigns/{campaignId}/orders/{orderId}/status.

Версия 2.1 от 16 мая 2013 года.

Добавлены ресуры:

Обновлены ресурсы:

Версия 2.0 от 5 марта 2013 года.
Внимание. Версия 2.0 партнерского API для ресурсов, с помощью которых выполняются запросы к Яндекс.Маркету, несовместима с более ранними версиями.

Добавлены ресурсы:

Обновлены ресурсы:

  • GET /campaigns/{campaignId} и GET /campaigns/{campaignId}/logins — изменена структура выходных данных и обновлено описание ошибок;

  • GET /campaigns/{campaignId}/balance — изменена структура выходных данных;

  • GET campaigns/{campaignId}/offers — добавлена возможность поиска предложений по категориям прайс-листа, а также выдача идентификатора предложения из прайс-листа в ответе, изменена структура выходных данных;

  • GET /campaigns/{campaignId}/stats/main — введено ограничение на период времени, за который доступна статистика по показам, и изменена структура выходных данных;

  • GET /campaigns/{campaignId}/stats/offers — добавлена возможность получения статистики для конкретного предложения и изменена структура выходных данных;

  • GET /models — изменена структура выходных данных для информации о результатах поиска;

  • POST /campaigns/{campaignId}/bids/recommended и PUT /campaigns/{campaignId}/bids/recommended — добавлена возможность получать или устанавливать рекомендованные значения для общей ставки, а также возможность работать со ставками по идентификатору предложения;

  • PUT /campaigns/{campaignId}/bids — добавлена возможность работать со ставками по идентификатору предложения и изменена структура выходных данных;

  • PUT /campaigns/{campaignId}/bids/recommended — изменена структура выходных данных.

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

Версия 1.2 от 31 июля 2012 года.

В партнерском API Яндекс.Маркета появилась возможность получения информации о средних ценах для моделей, а также о ценах для предложений моделей.

Добавлены ресурсы:

В описание каждого ресурса добавлена структура ответа на запрос, также для ресурсов типа POST и PUT добавлена структура тела запроса. Имена параметров в описаниях структур кликабельны: при нажатии появляется всплывающая подсказка с описанием параметра.

Изменены ресурсные ограничения для ресурсов:

Версия 1.1 от 28 марта 2012 года.

Обновлены ресурсы:

Версия 1.0 (beta) от 28 февраля 2012 года.

Добавлены ресурсы: