Список прайс-листов магазина

Описание

GET /campaigns/{campaignId}/feeds

Возвращает список прайс-листов, размещенных на Яндекс.Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов.

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

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

<response>
  <feeds>
    <feed expire-date="{date}" id="{int64}" login="{string}" name="{string}" password="{string}" upload-date="{date}" url="{string}">
      <content rejected-offers-count="{int32}" status="{enum}" total-offers-count="{int32}">
        <error type="{enum}"/>
      </content>
      <download status="{enum}">
        <error http-status-code="{int32}" type="{enum}">
          <description>{string}</description>
        </error>
      </download>
      <placement total-offers-count="{int32}"/>
      <publication status="{enum}">
        <full file-time="{date}" published-time="{date}"/>
        <price-and-stock-update file-time="{date}" published-time="{date}"/>
      </publication>
    </feed>
    ...
  </feeds>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

feedsfeeds

Список прайс-листов.

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

feed

Информация о прайс-листе.

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

Параметры, вложенные в feed / feeds

expire-dateexpireDateDate

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

Формат даты: ДД-ММ-ГГГГ.

Внимание. Если у магазина хотя бы один прайс-лист становится не актуальным, магазин выключается.

Параметр выводится при размещении прайс-листа на сервере Яндекс.Маркета.

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

ididInt64

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

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

loginloginString

Логин для авторизации при скачивании прайс-листа.

Параметр выводится при размещении прайс-листа на сайте магазина и в случае ограничения доступа к нему.

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

namenameString

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

Параметр выводится при размещении прайс-листа на сервере Яндекс.Маркета.

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

passwordpasswordString

Пароль для авторизации при скачивании прайс-листа.

Параметр выводится при размещении прайс-листа на сайте магазина и в случае ограничения доступа к нему.

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

upload-dateuploadDateDate

Дата загрузки прайс-листа на Яндекс.Маркет.

Формат даты: ДД-ММ-ГГГГ.

Параметр выводится при размещении прайс-листа на сервере Яндекс.Маркета.

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

urlurlString

URL прайс-листа.

Параметр выводится при размещении прайс-листа на сайте магазина.

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

contentcontent

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

downloaddownload

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

placementplacement

Информация о размещении предложений из прайс-листа на Яндекс.Маркете на момент выполнения запроса.

publicationpublication

Информация о последней публикации предложений из прайс-листа на Яндекс.Маркете.

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

rejected-offers-countrejectedOffersCountInt32

Количество предложений, в которых найдены ошибки на этапе загрузки прайс-листа.

Выводится, если параметр content status=OK.

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

statusstatusEnum

Статус проверки содержимого прайс-листа.

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

  • ERROR — найдены ошибки.

  • NA — прайс-лист не загружался более семи дней или на этапе загрузки произошла ошибка.

  • OK — ошибок не найдено.

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

total-offers-counttotalOffersCountInt32

Количество предложений в прайс-листе.

Выводится, если параметр content status=OK.

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

errorerror

Информация об ошибке в содержимом прайс-листа.

Выводится, если параметр content status=ERROR.

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

typetypeEnum

Тип ошибки в содержимом прайс-листа.

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

  • PARSE_ERROR — ошибка при проверке прайс-листа, не связанная с форматом YML. Например, прайс-лист пустой или его не удалось разархивировать.

  • PARSE_XML_ERROR — несоответствие техническим требованиям формата YML. Например, элементы и их значения описаны некорректно.

  • TOO_MANY_REJECTED_OFFERS — более чем в половине предложений из прайс-листа найдены ошибки. Все предложения из прайс-листа не будут опубликованы на Яндекс.Маркете.

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

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

statusstatusEnum

Статус последней загрузки прайс-листа.

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

  • ERROR — произошла ошибка.

  • NA — прайс-лист не загружался более семи дней.

  • OK — успешная загрузка.

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

errorerror

Информация об ошибке при загрузке прайс-листа.

Выводится, если параметр download status=ERROR.

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

http-status-codehttpStatusCodeInt32

HTTP-код ошибки индексации прайс-листа.

Выводится, если type=DOWNLOAD_HTTP_ERROR.

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

typetypeEnum

Тип ошибки загрузки прайс-листа.

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

  • DOWNLOAD_ERROR — ошибка загрузки прайс-листа. Например, проблема с DNS-сервером или обрыв интернет-соединения.

    Проблема описана в параметре description.

  • DOWNLOAD_HTTP_ERROR — Яндекс.Маркет передал запрос на получение прайс-листа и получил в ответ HTTP-код, отличный от 2xx.

    HTTP-код выведен в параметре http-status-code.

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

descriptiondescriptionString

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

Выводится, если type=DOWNLOAD_ERROR.

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

total-offers-counttotalOffersCount

Int32

Количество предложений из прайс-листа, которые размещаются на Яндекс.Маркете в момент выполнения запроса.

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

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

statusstatus

Enum

Статус последней публикации предложений из прайс-листа.

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

  • NA — прайс-лист не публиковался более семи дней.

  • OK — успешная публикация.

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

fullfull

Последнее полное обновление данных на Яндекс.Маркете.

Выводится, если параметр publication status=OK.

price-and-stock-updatepriceAndStockUpdate

Последнее обновление цен и наличия товаров на Яндекс.Маркете.

Если последнее по времени обновление было полным, в параметре выводятся те же данные, что и в параметре full.

Выводится, если параметр publication status=OK.

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

file-timefileTime

Date

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

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

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

published-timepublishedTimeDate

Дата и время публикации предложений из прайс-листа на Яндекс.Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

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

Параметры, вложенные в price-and-stock-update / priceAndStockUpdate

file-timefileTime

Date

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

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

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

published-timepublishedTimeDate

Дата и время публикации предложений из прайс-листа на Яндекс.Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

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

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

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

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 403 Forbidden

Access denied

Нет доступа к магазину.

Проверьте корректность идентификатора магазина.

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10001/feeds.xml'

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

HTTP/1.1 200 OK
Date: Fri, 15 Dec 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <feeds>
    <feed id="12345" login="badbadwolf" password="afraid" url="http://nuf-nuf.yandex.ru/price.xml">
      <content rejected-offers-count="0" status="OK" total-offers-count="534"/>
      <download status="OK"/>
      <placement total-offers-count="534"/>
      <publication status="OK">
        <full file-time="2017-12-14T21:42:42+03:00" published-time="2017-12-14T23:42:42+03:00"/>
        <price-and-stock-update file-time="2017-12-14T21:42:42+03:00" published-time="2017-12-14T22:42:42+03:00"/>
      </publication>
    </feed>
    <feed id="61891" login="badwolfbad" password="password" url="http://nif-nif.yandex.ru/price.xml">
      <content status="ERROR">
        <error type="TOO_MANY_REJECTED_OFFERS"/>
      </content>
      <download status="OK"/>
      <placement total-offers-count="0"/>
      <publication status="NA"/>
    </feed>
  </feeds>
</response>