Все предложения магазина

Описание

GET /campaigns/{campaignId}/offers/all

Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Яндекс.Маркете. Возвращает результат в виде сегментов нефиксированного размера.

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс.Маркета, с которой соотнесено предложение, а также аукционные ставки на него.

Примечание. Метод доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

chunk

Int32

Номер сегмента с результатами.

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

Примечание. Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.
Внимание. Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать page=0 и т. д.

feedId

Int64

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

Внимание. Ассортимент Яндекс.Маркета обновляется примерно раз в 3-6 часов. Значения ставок обновляются в течение 3 часов — при идентификации товаров по названию и в течение 30 минут при идентификации товаров по ID. Поэтому не имеет смысла выполнять запрос по одним и тем же предложениям чаще чем раз в час либо раз в 30 минут соответственно.

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

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

<response>
  <offers>
    <offer bid="{double}" blocked="{boolean}" currency="{enum}" discount="{integer}" feed-id="{integer}" id="{string}" market-category-id="{integer}" model-id="{integer}" pre-discount-price="{float}" price="{float}" shop-category-id="{string}">
      <name>{string}</name>
      <url>{string}</url>
    </offer>
    ...
  </offers>
</response>

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

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

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

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

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

offersoffers

Список предложений магазина.

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

offer

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

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

bidbidDouble

Примененная общая ставка, в условных единицах (может отличаться от выставленной магазином).

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

blockedblockedBoolean

Признак блокировки предложения.

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

  • false — предложение активно, параметр не выводится.

  • true — предложение заблокировано.

Параметр выводится, если предложение заблокировано и не попадает в выдачу Яндекс.Маркета. Это может произойти из-за отключения магазина.

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

currencycurrencyEnum

Валюта, в которой указана цена предложения.

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

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

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

discountdiscountInt32

Скидка на предложение, в %.

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

feed-idfeedIdInt64

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

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

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

ididString

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

Параметр выводится, если в прайс-листе задан уникальный идентификатор. Если в прайс-листе содержится несколько предложений с одинаковыми идентификаторами, параметр id указывается только для первого из них, для остальных параметры id и feed-id не выводятся.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

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

market-category-idmarketCategoryIdInt32

Идентификатор категории предложения в дереве категорий Яндекс.Маркета.

Примечание. Информацию о работе с категориями можно получить в контентном API Яндекс.Маркета в разделе Категории.

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

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

model-idmodelIdInt32

Идентификатор модели Яндекс.Маркета, с которой соотнесено предложение.

Если предложение не соотнесено ни с какой карточкой модели, то параметр modelid содержит значение 0.

Примечание. Идентификатор модели присутствует в URL карточки модели в виде значения параметра product. Например: https://market.yandex.ru/product/13584121.

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

pre-discount-pricepreDiscountPriceFloat

Цена предложения без скидки.

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

pricepriceFloat

Цена предложения.

До версии 2.0 партнерского API Яндекс.Маркета у параметра был тип — string.

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

shop-category-idshopCategoryIdString

Идентификатор категории предложения, указанный магазином в прайс-листе.

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

Параметр доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

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

namenameString

Наименование предложения.

urlurlString

URL-адрес предложения на сайте магазина.

Ограничения

Количество запросов к ресурсу, которое возможно выполнить в течение суток, рассчитывается индивидуально и зависит от следующих показателей:

  • количество предложений.

Примечание.

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

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/21169538/offers/all.xml?chunk=2'

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

HTTP/1.1 200 OK
Date: Sat, 19 Mar 2016 12:08:12 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <offers>
    <offer bid="1.16" currency="RUR" discount="17" feed-id="375216" id="1636288" market-category-id="913" model-id="8350595" pre-discount-price="8990" price="7490" shop-category-id="129">
      <name>Бинокли, Телескопы Nikon Aculon T11 8-24x25 (черный)</name>
      <url>http://nuf-nuf.yandex.ru/product/21003</url>
    </offer>
  </offers>
</response>