Список цен, установленных через API

Описание

GET /campaigns/{campaignId}/offer-prices

Запрос возвращает список цен на предложения, установленных через партнерский API Яндекс.Маркета.

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

Необязательные

limit

Int32

Количество записей о ценах в выходных данных.

Минимальное значение: 1.

Максимальное значение: 2000.

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

Используется вместе с параметром offset.

Если задан limit, параметры page и pageSize игнорируются.

offset

Int32

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

Минимальное значение: 0.

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

Используется вместе с параметром limit.

Если задан offset, параметры page и pageSize игнорируются.

page

Int32

Номер страницы результатов.

Минимальное значение: 1.

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

Используется вместе с параметром pageSize.

page игнорируется, если задан limit и / или offset.

pageSize

Int32

Количество записей о ценах на странице.

Минимальное значение: 1.

Максимальное значение: 2000.

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

Используется вместе с параметром page.

pageSize игнорируется, если задан limit и / или offset.

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

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

<response>
  <errors>
    <error code="{enum}" message="{string}"/>
    ...
  </errors>
  <result>
    <offers>
      <offer id="{string}" updated-at="string">
        <feed id="{int64}"/>
        <price currency-id="{enum}" discount-base="{float}" value="{float}"/>
      </offer>
      ...
    </offers>
    <total>{int32}</total>
  </result>
  <status>{enum}</status>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

errors errors

Список ошибок при выполнении запроса.

Выводится, если status="ERROR".

result result

Результат выполнения запроса.

Выводится, если status="OK".

status status Enum

Статус выполнения запроса.

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

  • OK — запрос выполнен успешно.

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

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

error

Информация об ошибке.

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

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

code code Enum

Код ошибки.

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

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

  • REQUEST_LIMIT_EXCEEDED — в параметре запроса limit или pageSize передано значение больше 2000.

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

message message String

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

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

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

total total Int32

Количество всех цен магазина, измененных через API.

offers offers

Список предложений с ценами, измененными через API.

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

offer

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

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

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

feed feed

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

id id String

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

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

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

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

price price

Информация о цене предложения, установленной через API.

updated-at updatedAt Date

Дата и время последнего обновления цены предложения через API.

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

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

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

id id Int64

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

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

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

currency-id currencyId Enum

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

Возможно только значение RUR — российский рубль.

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

discount-base discountBase Float

Цена предложения без скидки, установленная через API.

Значение параметра должно быть больше value. Подробнее см. требования к скидкам Помощи Маркета.

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

value value Float

Цена предложения, установленная через API.

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

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

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

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

Описание

Пояснение

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

Ошибка 400 Bad Request

Page number must be positive: 'page'

Номер страницы должен быть положительным числом.

Проверьте корректность передаваемого номера страницы.

Page size is too big: 'pageSize'. Max page size is 'maxPageSize'

Указан слишком большой размер страницы.

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

Page size must be positive: 'pageSize'

Размер страницы должен быть положительным числом.

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

discount should be between 5% and 95%

Скидка на товар должна быть не меньше 5% и не больше 95% от текущей цены. Проверьте разницу между установленной ценой без скидки и ценой предложения.

Ограничения

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

(количество предложений магазина) * 25
Примечание.

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

Примеры

Запрос:

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10001/offer-prices.xml?limit=2'

Ответ:

HTTP/1.1 200 OK
Date: Tue, 17 April 2018 11:38:51 GMT
Content-Type: application/xml;charset=utf-8
...

<response>  
  <result>
    <offers>
      <offer id="1636288" updated-at="2018-04-13T13:13:01+03:00">
        <feed id="479633"/>
        <price currency-id="RUR" value="1500.00"/>
      </offer>
      <offer id="1687614" updated-at="2018-04-12T09:44:42+03:00">
        <feed id="479633"/>
        <price currency-id="RUR" discount-base="900.00" value="820.00"/>
      </offer>
    </offers>
    <total>4</total>
  </result>
  <status>OK</status>
</response>