Информация о скрытых предложениях

Описание

GET /campaigns/{campaignId}/hidden-offers

Возвращает список скрытых предложений магазина. Предложения отсортированы в лексикографическом порядке: сначала по возрастанию идентификаторов прайс-листов, затем по возрастанию идентификаторов предложений.

Результаты возвращаются постранично. Выходные данные содержат идентификаторы предыдущей и следующей страницы.

URL ресурса:

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

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

page_token String

Идентификатор страницы c результатами.

Если параметр не указан, возвращается самая старая страница.

Рекомендуется передавать значение выходного параметра next-page-token, полученное при последнем запросе.

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

limit

Int32

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

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

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

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

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

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

offset

Int32

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

Скрытые предложения выводятся отсортированными в лексикографическом порядке: сначала по возрастанию значений параметров feed-id, затем по возрастанию значений offer-id.

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

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

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

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

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

page_number

Int32

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

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

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

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

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

page_size

Int32

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

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

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

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

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

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

feed_id

Int64

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

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

Обязательный параметр, если указан offer_id.

offer_id

String

Идентификатор скрытого предложения.

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

Максимальная длина — 50 символов.

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

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

<response>
  <errors>
    <error code="{enum}" message="{string}"/>
    ...
  </errors>
  <result>
    <hidden-offers>
      <hidden-offer comment="{string}" feed-id="{int64}" offer-id="{string}" ttl-in-hours="{int32}"/>
      ...
    </hidden-offers>
    <total>{int32}</total>
    <paging prev-page-token="{string}" next-page-token="{string}"/>
  </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

Код ошибки.

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

  • INVALID_FEED_ID — в параметре feed_id передан идентификатор прайс-листа, который не существует или не относится к магазину campaignId.

  • INVALID_OFFER_ID — в параметре offer_id передан пустой идентификатор скрытого предложения или его значение превышает 50 символов.

  • REQUEST_LIMIT_EXCEEDED — в параметре limit или page_size указано значение больше 500.

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

message message String

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

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

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

hidden-offers hiddenOffers

Список скрытых предложений.

total total Int32

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

paging paging

Информация о страницах результатов.

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

hidden-offer

Скрытое предложение.

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

Параметры, вложенные в hidden-offer / hiddenOffers

comment comment String

Комментарий магазина.

Максимальная длина комментария — 100 символов.

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

feed-id feedId Int64

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

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

offer-id offerId

String

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

Ограничение: 50 символов.

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

ttl-in-hours ttlInHours Int32

Количество часов до возобновления показа предложения.

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

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

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

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

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

prev-page-token prevPageToken String

Идентификатор предыдущей страницы результатов.

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

next-page-token nextPageToken String

Идентификатор следующей страницы результатов.

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

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

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

Ограничения

В одном запросе можно получить информацию не более чем о 500 предложениях.

Примеры

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

curl -i -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/12345/hidden-offers.xml?feed_id=67891&limit=1'

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

HTTP/1.1 200 OK
Date: Sat, 12 Aug 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <result>
    <hidden-offers>
      <hidden-offer comment="До поставки новой партии товара" feed-id="67891" offer-id="101Ab12313C" ttl-in-hours="1"/>
    </hidden-offers>
    <total>3</total>
    <paging next-page-token="Hj0gP0AQUIID01IE"/>
  </result>
  <status>OK</status>
</response>